ユーザー情報の照会

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

サブアカウント、削除されたサブアカウント、ロールユーザーなど、アカウントに権限が付与されたサブアカウントのユーザー情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`subAccountId`	String	Required	サブアカウント ID サブアカウントリストの照会を参照

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

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

フィールド	タイプ	必須の有無	説明
`includeDeleted`	Boolean	Optional	削除されたアカウントを含むかどうか `true` \| `false` (デフォルト) `true`: 含む `false`: 含まない

リクエスト例

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

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/users/dfafe250-****-****-****-246e96591594?includeDeleted=true' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`subAccountId`	String	-	サブアカウント ID
`loginId`	String	-	サブアカウントログイン ID
`name`	String	-	サブアカウントのユーザー名
`groups`	Array	-	サブアカウントの所属グループリスト
`active`	Boolean	-	サブアカウントの状態 `true` \| `false` `true`: 有効化 `false`: 無効化
`deleted`	Boolean	-	削除されたアカウントかどうか `true` \| `false` `true`: 削除されたアカウント `false`: 削除されていないアカウント
`createTime`	String	-	サブアカウントの作成日時 ISO 8601形式
`principalType`	String	-	サブアカウントのタイプ `IamUser` \| `IamRole` `IamUser`: サブアカウント `IamRole`: ロールユーザー
`sourceIdentity`	Object	-	ロールユーザー情報 `principalType`が`IamRole`の場合に表示
`sourceIdentity.type`	String	-	ロールユーザータイプ `IamUser` \| `Server` \| `FederatedUser` \| `NcloudService` `IamUser`: Accountロール `Server`: Serverロール `FederatedUser`: Single Sign-Onロール `NcloudService`: Serviceロール `principalType`が`IamRole`の場合に表示
`sourceIdentity.id`	String	-	ロールユーザー ID ロールタイプ別表示情報 Accountロール: サブアカウント ID Serverロール: 該当なし Single Sign-Onロール: SSO User ID Serviceロール: サービスリソース ID `principalType`が`IamRole`の場合に表示
`sourceIdentity.provider`	String	-	ロールユーザー所属区分ロールタイプ別表示情報 Accountロール: 会員番号 Serverロール: 該当なし Single Sign-Onロール: SSO Tenant ID Serviceロール: サービス ID `principalType`が`IamRole`の場合に表示
`roleNrn`	String	-	切り替えたロールに対する NAVERクラウドプラットフォームリソースの識別値 `principalType`が`IamRole`の場合に表示

`groups`

groupsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`groupId`	String	-	グループ ID
`groupName`	String	-	グループ名
`nrn`	String	-	グループに対する NAVERクラウドプラットフォームリソースの識別値

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

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

レスポンス例

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

{
    "subAccountId": "dfafe250-****-****-****-246e96591594",
    "loginId": "user000",
    "name": "user000",
    "groups": [
        {
            "groupId": "50b77400-****-****-****-246e96591a38",
            "groupName": "group002",
            "nrn": "nrn:PUB:IAM::*******:Group/50b77400-****-****-****-246e96591a38"
        }
    ],
    "active": true,
    "deleted": false,
    "createTime": "2024-12-10T00:15:34Z",
    "principalType": "IamUser"
}