ロール(Account)適用対象の照会

Prev Next

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

Accountロールに割り当てられた適用対象を照会します。

リクエスト

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

メソッド URI
GET /api/v1/roles​/{roleNo}​/entities​/account

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
roleNo String Required ロール ID

リクエスト例

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

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/roles/5befa3a0-****-****-****-246e96591a38/entities​/account' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
isMyAccount Boolean - 本人のアカウントかどうか
  • true | false
    • true: 本人のアカウント
    • false: 別のメインアカウント
accountName String - サブアカウントのユーザー名
loginId String - サブアカウントログイン ID

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

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

レスポンス例

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

{
  "isMyAccount": true,
  "accountName": "***",
  "loginId": "ls*****@*********.com"
}