リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`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 PUT '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}' \
--data '{
    "description": "assignment000",
    "consoleAccessAllowed": false,
    "apiAccessAllowed": false
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`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
}

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

リクエスト
レスポンス

タグ

Ncloud Single Sign-On