Assignmentの照会

Prev Next

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

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

リクエスト

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

メソッド URI
GET /api/v1/assignments/{assignmentId}

リクエストヘッダ

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

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
assignmentId String - Assignment ID
assignmentName String - Assignment名
description String - Assignmentの説明
nrn String - Assignmentに対する NAVERクラウドプラットフォームリソースの識別値
status String - Assignmentの状態
  • active | suspended
    • active: 使用中(有効化)
    • suspended: 停止(無効化)
iamRoleNrn String - Sub Accountサービスに作成された SSOロールの NRN
  • IAM roleに対する NAVERクラウドプラットフォームリソースの識別値
consoleAccessAllowed Boolean - コンソールアクセスを許可するかどうか
  • true | false
    • true: 許可
    • false: 許可しない
consoleAccessRestricted Boolean - コンソールアクセスを制限するかどうか
  • true | false
    • true: 制限
    • false: 制限しない
apiAccessAllowed Boolean - API Gatewayアクセスを許可するかどうか
  • true | false
    • true: 許可
    • false: 許可しない
apiAccessRestricted Boolean - API Gatewayアクセスを制限するかどうか
  • true | false
    • true: 制限
    • false: 制限しない
createdAt String - Assignmentの作成日時
  • ISO 8601形式
updatedAt String - Assignmentの最終更新日時
  • ISO 8601形式
accountMbrNo Number - アカウントの会員番号(MemberNo)
accountName String - アカウントのユーザー名
accountAlias String - アカウントのエイリアス
accountGroup String - アカウントグループ
accountType String - アカウントのタイプ
  • Master | Member
    • Master: マスターアカウント
    • Member: メンバーアカウント
accountLoginId String - アカウントログイン ID
permissionSetId String - Permission Set ID
permissionSetName String - Permission Set名
permissionSetNrn String - Permission Setに対する NAVERクラウドプラットフォームリソースの識別値
permissionSetDescription String - Permission Setの説明
permissionCreatedAt String - Permission Setの作成日時
  • ISO 8601形式

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

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

レスポンス例

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

{
  "assignmentId" : "e1653f17-****-****-****-deb664fb8a2f",
  "assignmentName" : "assignment000",
  "description" : "assignment description",
  "nrn" : "nrn:PUB:SSO::*******:Assignment/e1653f17-****-****-****-deb664fb8a2f",
  "status" : "active",
  "iamRoleNrn" : "nrn:PUB:IAM::*******:Role/385550d0-****-****-****-005056a79baa",
  "consoleAccessAllowed" : true,
  "consoleAccessRestricted" : false,
  "apiAccessAllowed" : true,
  "apiAccessRestricted" : false,
  "createdAt" : "2025-01-13T02:36:40Z",
  "updatedAt" : "2025-01-13T02:36:40Z",
  "accountMbrNo" : *******,
  "accountName" : "田中太郎",
  "accountAlias" : "-",
  "accountGroup" : "-",
  "accountType" : "-",
  "accountLoginId" : "******@ncloud.com",
  "permissionSetId" : "3fcd3c17-****-****-****-2a594248bf28",
  "permissionSetName" : "permissionset000",
  "permissionSetNrn" : "nrn:PUB:SSO::*******:PermissionSet/3fcd3c17-****-****-****-2a594248bf28",
  "permissionSetDescription" : "permissionset000 description",
  "permissionCreatedAt" : "2025-01-03T02:26:47Z"
}