Edit assignment

Prev Next

Available in Classic and VPC

Edit assignment information.

Request

This section describes the request format. The method and URI are as follows:

Method URI
PUT /api/v1/assignments/{assignmentId}

Request headers

For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
assignmentId String Required Assignment ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
description String Optional Assignment description
  • 0-300 characters
consoleAccessAllowed Boolean Required Whether to allow console access
  • true | false
    • true: allow
    • false: not allow
apiAccessAllowed Boolean Required Whether to allow API Gateway access
  • true | false
    • true: allow
    • false: not allow

Request example

The request example is as follows:

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
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - Assignment ID
success Boolean - API processing result
  • true | false
    • true: succeeded
    • false: failed
message String - Result message
  • Displayed if success is false

Response status codes

For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.

Response example

The response example is as follows:

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