SSO User Profileの照会

Prev Next

Classic/VPC環境で利用できます。

SSO User Profileを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/users/{userId}/profiles

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
userId String Required SSO User IDリスト

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/users/ba0def04-****-****-****-ff0b962016f7/profiles' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
firstName String - SSO Userの名(下の名前)
lastName String - SSO Userの姓(苗字)
email String - SSO Userのメールアドレス
emailVerified Boolean - メールアドレスは認証済みかどうか
  • true | false
    • true: 認証完了
    • false: 認証が必要
empNo String - SSO Userの社員番号
phoneCountryCode String - SSO Userの国番号
phoneNo String - SSO Userの携帯電話番号
phoneNoVerified Boolean - 携帯電話番号は認証済みかどうか
  • true | false
    • true: 認証完了
    • false: 認証が必要
deptName String - SSO Userの部署名

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "firstName": "太郎",
    "lastName": "田中",
    "email": "******@ncloud.com",
    "emailVerified": true,
    "empNo": "00110011",
    "phoneCountryCode": "82",
    "phoneNo": "010-1100-0000",
    "phoneNoVerified": true,
    "deptName": "部署2"
}