SSO Userの照会

Prev Next

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

SSO Userの詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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/80d9ba0d-****-****-****-76afe6ea5b33' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
userId String - SSO User ID
loginId String - SSO Userログイン ID
nrn String - SSO Userに対する NAVERクラウドプラットフォームリソースの識別値
userProfile Object - SSO User Profile情報
userProfile.firstName String - SSO Userの名(下の名前)
userProfile.lastName String - SSO Userの姓(苗字)
userProfile.email String - SSO Userのメールアドレス
userProfile.emailVerified Boolean - メールアドレスは認証済みかどうか
  • true | false
    • true: 認証完了
    • false: 認証が必要
userProfile.empNo String - SSO Userの社員番号
userProfile.phoneCountryCode String - SSO Userの国番号
userProfile.phoneNo String - SSO Userの携帯電話番号
userProfile.phoneNoVerified Boolean - 携帯電話番号は認証済みかどうか
  • true | false
    • true: 認証完了
    • false: 認証が必要
userProfile.deptName String - SSO Userの部署名
accessRules Object - アクセスルール情報
accessRules.consoleAccessAllowed Boolean - コンソールアクセスを許可するかどうか
  • true | false
    • true: 許可
    • false: 許可しない
accessRules.apiAccessAllowed Boolean - API Gatewayアクセスを許可するかどうか
  • true | false
    • true: 許可
    • false: 許可しない
status String - SSO Userの状態
  • active | suspended
    • active: 使用中(有効化)
    • suspended: 停止(無効化)
description String - SSO Userの説明
lastLoginAt String - SSO Userの最終アクセス日時
  • ISO 8601形式
createdAt String - SSO Userの作成日時
  • ISO 8601形式
updatedAt String - SSO Userの更新日時
  • ISO 8601形式

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

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

レスポンス例

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

{
    "page": 0,
    "totalPages": 1,
    "totalItems": 1,
    "isFirst": true,
    "isLast": true,
    "hasPrevious": false,
    "hasNext": false,
    "items": [
        {
            "userId": "80d9ba0d-****-****-****-76afe6ea5b33",
            "loginId": "******@ncloud.com",
            "nrn": "nrn:PUB:SSO::*******:User/80d9ba0d-****-****-****-76afe6ea5b33",
            "userProfile": {
                "firstName": "太郎",
                "lastName": "田中",
                "email": "******@ncloud.com",
                "emailVerified": true,
                "empNo": "00112233",
                "phoneCountryCode": "82",
                "phoneNo": "010-0000-0000",
                "phoneNoVerified": true,
                "deptName": "部署"
            },
            "accessRules": {
                "consoleAccessAllowed": true,
                "apiAccessAllowed": true
            },
            "status": "active",
            "createdAt": "2025-01-03T05:08:42Z",
            "updatedAt": "2025-01-03T05:08:42Z",
            "description": "SSO User"
        }
    ]
}