Permission Setの作成

Prev Next

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

Permission Setを作成します。Permission Setに Sub Accountサービスのマネージドポリシー(System Managed)とユーザー定義ポリシー(User Created)を追加して、管理者が必要な権限のセットを作成できます。

リクエスト

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

メソッド URI
POST /api/v1/permission-sets

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
permissionSetName String Required Permission Set名
  • 英数字、記号の「-」、「_」を組み合わせて2~30文字以内で入力
  • 先頭文字は英字または数字のみ使用
  • 作成後は変更不可
description String Optional Permission Setの説明
  • 0~300文字
systemManagedPolicyIds Array Conditional マネージドポリシー(System Managed) IDリスト
  • マネージドポリシーリストの照会を参照
  • マネージドポリシーを設定する場合、必ず入力
  • マネージドポリシーまたはユーザー定義ポリシーのうち1つ以上の入力が必要で、合計して最大10個まで追加可能
userCreatedPolicyNames Array Conditional ユーザー定義ポリシー(User Created)名リスト
  • ユーザー定義ポリシーを設定する場合、必ず入力
  • マネージドポリシーまたはユーザー定義ポリシーのうち1つ以上の入力が必要で、合計して最大10個まで追加可能
tags Object Optional ポリシーのタグ
  • リソースごとに最大20個
  • {tagKey}:{tagValue}形式で入力
    • tagKey: 英数字、記号の「、.、/、=、+、-、@」を組み合わせて128文字以内で入力
    • tagValue: 英数字、記号の「、.、/、=、+、-、@」を組み合わせて256文字以内で入力

リクエスト例

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

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/permission-sets' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "permissionSetName": "permissionset000",
    "description": "description",
    "systemManagedPolicyIds": [
        "3b773a30-****-****-****-246e96592200",
        "3b75b390-****-****-****-246e96592200"
    ],
    "userCreatedPolicyNames": [
        "policy000"
    ],
    "tags": {
        "tagKey1": "tagValue1",
        "team": "a"
    }
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
id String - Permission Set ID
nrn String - Permission Setに対する NAVERクラウドプラットフォームリソースの識別値
success Boolean - API処理結果
  • true | false
    • true: 成功
    • false: 失敗
message String - 結果メッセージ
  • successfalseの場合、表示

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

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

レスポンス例

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

{
    "id": "23ab7cb3-****-****-****-0b2222cb93e5",
    "nrn": "nrn:PUB:SSO::*******:PermissionSet/23ab7cb3-****-****-****-0b2222cb93e5",
    "success": true
}