リクエスト

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

メソッド	URI
GET	/api/v1/permission-sets/{permissionSetId}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`permissionSetId`	String	Required	Permission Set ID Permission Setリストの照会を参照

リクエスト例

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/permission-sets/3fcd3c17-****-****-****-2a594248bf28' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`permissionSetId`	String	-	Permission Set ID
`permissionSetName`	String	-	Permission Set名
`description`	String	-	Permission Setの説明
`nrn`	String	-	Permission Setに対する NAVERクラウドプラットフォームリソースの識別値
`createdAt`	String	-	Permission Setの作成日時 ISO 8601形式
`systemManagedPolicyList`	Array	-	マネージドポリシー(System Managed)リスト
`userCreatedPolicyList`	Array	-	ユーザー定義ポリシー(User Created)リスト
`accountList`	Array	-	アカウントリスト

`systemManagedPolicyList`

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

フィールド	タイプ	必須の有無	説明
`policyId`	String	-	マネージドポリシー(System Managed)の ID
`policyName`	String	-	マネージドポリシー(System Managed)名
`policyDescription`	String	-	マネージドポリシー(System Managed)の説明
`policyCreatedAt`	String	-	マネージドポリシー(System Managed)の作成日時 ISO 8601形式

`userCreatedPolicyList`

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

フィールド	タイプ	必須の有無	説明
`userCreatedPolicyName`	String	-	ユーザー定義ポリシー(User Created)名

`accountList`

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

フィールド	タイプ	必須の有無	説明
`accountName`	String	-	アカウントのユーザー名
`accountAlias`	String	-	アカウントのエイリアス
`accountLoginId`	String	-	アカウントログイン ID
`accountType`	String	-	アカウントのタイプ `Master` \| `Member` `Master`: マスターアカウント `Member`: メンバーアカウント
`accountGroup`	String	-	アカウントグループ
`accountMbrNo`	Number	-	アカウントの会員番号(MemberNo)

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

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

レスポンス例

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

{
    "permissionSetId": "3fcd3c17-****-****-****-2a594248bf28",
    "permissionSetName": "permission",
    "description": "",
    "nrn": "nrn:PUB:SSO::*******:PermissionSet/3fcd3c17-****-****-****-2a594248bf28",
    "createdAt": "2025-01-03T02:26:47Z",
    "systemManagedPolicyList": [
        {
            "policyId": "3b773a30-****-****-****-246e96592200",
            "policyName": "NCP_COST_EXPLORER_VIEWER",
            "policyDescription": "Permission to only view items and their details in Cost Explorer",
            "policyCreatedAt": "2024-11-21T09:23:13Z"
        }
    ],
    "userCreatedPolicyList": [
        {
            "userCreatedPolicyName": "policy010"
        }
    ],
    "accountList": [
        {
            "accountName": "田中太郎",
            "accountAlias": "-",
            "accountLoginId": "******@ncloud.com",
            "accountType": "-",
            "accountGroup": "-",
            "accountMbrNo": *******
        }
    ]
}

この記事は役に立ちましたか?

リクエスト
レスポンス