Assignmentの作成

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

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

Assignmentを作成します。Assignmentは、外部アカウントが使用するポリシーを定義した Permission Setと SSO Userを連携したもので、SSO Userが NAVERクラウドプラットフォームで実行できる権限の範囲を意味します。

リクエスト

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

メソッド	URI
POST	/api/v1/assignments

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`assignmentName`	String	Required	Assignment名英数字、記号の「-」、「_」を組み合わせて2~30文字以内で入力先頭文字は英字または数字のみ使用作成後は変更不可
`accountMbrNo`	Number	Required	アカウントの会員番号(MemberNo)
`permissionSetId`	String	Required	Permission Set ID
`description`	String	Optional	Assignmentの説明 0~300文字
`consoleAccessAllowed`	Boolean	Required	コンソールアクセスを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない
`apiAccessAllowed`	Boolean	Required	API Gatewayアクセスを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない

リクエスト例

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

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/assignments' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "assignmentName": "assignment000",
    "accountMbrNo": *******,
    "permissionSetId": "3fcd3c17-****-****-****-2a594248bf28",
    "description": "assignment description",
    "consoleAccessAllowed": true,
    "apiAccessAllowed": true
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`id`	String	-	Assignment ID
`success`	Boolean	-	API処理結果 `true` \| `false` `true`: 成功 `false`: 失敗
`message`	String	-	結果メッセージ `success`が`false`の場合、表示

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

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

レスポンス例

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

{
    "id": "e1653f17-****-****-****-deb664fb8a2f",
    "success": true
}