OIDCフローのUserInfo詳細
get
/oauth2/rest/userinfo
リクエスト
サポートされているメディア・タイプ
- application/json
- application/x-www-form-urlencoded
問合せパラメータ
- identityDomain(optional): string
'x-oauth-identity-domain-name'ヘッダー・パラメータの代替問合せパラメータ名。これは、一部のシナリオでヘッダー・パラメータを渡せない場合に使用できます。
ヘッダー・パラメータ
- Authorization: string
クライアントがUserInfoクレームを取得するには有効なアクセス・トークン(タイプbearer)を指定する必要があります。トークンによってスコープ指定されるクレームのみが返されます。
- x-oauth-identity-domain-name: string
レスポンス
サポートされているメディア・タイプ
- application/json
- application/json,image/png
200 レスポンス
UserInfoクレームはリクエストされたスコープに従って返されます。
ルート・スキーマ: UserInfoDetails
型:
objectスコープ[openid email address profile phone]に基づいて返されるユーザーの詳細
ソースを表示
- country(optional): string
ユーザーのcountryを指定します
- email(optional): string
ユーザーの電子メール・アドレス(mail属性に対応)
- email_verified(optional): string
デフォルト値:
Nメールが確認されます - family_name(optional): string
ユーザーの姓
- formatted(optional): string
ユーザーのpostaladdressを指定します
- locale(optional): string
ユーザーの優先言語
- name(optional): string
対象のユーザー
- phone_number(optional): string
ユーザーの電話番号
- phone_number_verified(optional): string
デフォルト値:
N電話番号が確認されます - postal_code(optional): string
ユーザーのpostalcodeを指定します
- preferred_username(optional): integer
ユーザー名
- region(optional): integer
ユーザーのstateを指定します
- updated_at(optional): integer
最終更新時間
400 レスポンス
不正なリクエスト
ルート・スキーマ: ErrorCode
型:
ソースを表示
object- errorCode(optional): string
生成されたエラー・コード
- errorDesc(optional): string
翻訳されたエラーの説明
- secErrorDesc(optional): string
セカンダリ・エラー・メッセージ
例
次の例は、UserInfoエンドポイントからユーザー詳細をフェッチするサンプルのリクエストとレスポンスを示しています。
すべてのOpenIDスコープでアクセス・トークンをフェッチする
http://<OAM Managed Server Host>:<Port>/oauth2/rest/authorize?response_type=code&domain=DemoDomain&client_id=DemoClientID&scope=DemoResServer.scope1 openid address email phone profile&state=code1234&redirect_uri=http://localhost:8080/Sample.jsp
ユーザー詳細をフェッチするcURLコマンド
curl -X GET http://<OAM Managed Server Host>:<Port>/oauth2/rest/userinfo \ -H 'Authorization: Bearer <Access Token>' \ -H 'X-OAUTH-IDENTITY-DOMAIN-NAME: DemoDomain'
サンプル・レスポンス
{
"profile": {
"name": "John",
"family_name": "Doe",
"preferred_username": "admin",
"locale": "English",
"updated_at": "15283870899035"
},
"email": {
"email": "johndoe@company.com,
"email_verified": "N"
},
"address": {
"formatted": "Test content",
"region": "State",
"postal_code": "50000",
"country": "Country-India"
},
"phone": {
"phone_number": "3212421123",
"phone_number_verified": "N"
}
}
電子メールのOpenIDスコープでアクセス・トークンをフェッチする
http://<OAM Managed Server Host>:<Port>/oauth2/rest/authorize?response_type=code&domain=DemoDomain&client_id=DemoClientID&scope=DemoResServer.scope1 openid email&state=code1234&redirect_uri=http://localhost:8080/Sample.jsp
ユーザーの電子メール・アドレスをフェッチするcURLの例
curl -X GET http://<OAM Managed Server Host>:<Port>/oauth2/rest/userinfo \ -H 'Authorization: Bearer <Access Token>' \ -H 'X-OAUTH-IDENTITY-DOMAIN-NAME: DemoDomain'
サンプル・レスポンス
{
"email": {
"email": "johndoe@company.com,
"email_verified": "N"
}
}
住所のOpenIDスコープでアクセス・トークンをフェッチする
http://<OAM Managed Server Host>:<Port>/oauth2/rest/authorize?response_type=code&domain=DemoDomain&client_id=DemoClientID&scope=DemoResServer.scope1 openid address&state=code1234&redirect_uri=http://localhost:8080/Sample.jsp
ユーザーの住所をフェッチするcURLの例
curl -X GET http://<OAM Managed Server Host>:<Port>/oauth2/rest/userinfo \ -H 'Authorization: Bearer <Access Token>' \ -H 'X-OAUTH-IDENTITY-DOMAIN-NAME: DemoDomain'
サンプル・レスポンス
{
"address": {
"formatted": "Test content",
"region": "State",
"postal_code": "50000",
"country": "Country-India"
}
}