Add assignment IP ACL

Prev Next

Available in Classic and VPC

Add an IP ACL to an assignment.

Note

Up to 5 IP ACLs can be added for a single assignment.

Request

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

Method URI
POST /api/v1/assignments/{assignmentId}/ip-acls

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
consoleAccessAllowed Boolean Required Whether to allow console access
  • true | false
    • true: allow
    • false: not allow
consoleAccessRestricted Boolean Optional Whether to restrict console access
  • true | false
    • true: restrict
    • false: not restrict
  • Must be identical to the consoleAccessAllowed settings
consoleAccessIpAclIds Array Optional List of console-accessible IP ACL IDs
apiAccessAllowed Boolean Required Whether to allow API Gateway access
  • true | false
    • true: allow
    • false: not allow
apiAccessRestricted Boolean Optional Whether to restrict API Gateway access
  • true | false
    • true: restrict
    • false: not restrict
  • Must be identical to the apiAccessAllowed settings
apiAccessIpAclIds Array Optional List of API Gateway-accessible IP ACL IDs

Request example

The request example is as follows:

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/assignments/2c15b16c-****-****-****-3e7207ff2bf6/ip-acls' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "consoleAccessAllowed": true,
    "consoleAccessRestricted": true,
    "consoleAccessIpAclIds": [
        "5bf4cad0-****-****-****-cd51bba3fe23"
    ],
    "apiAccessAllowed": true,
    "apiAccessRestricted": true,
    "apiAccessIpAclIds": [
        "5bf4cad0-****-****-****-cd51bba3fe23"
    ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - Assignment ID
nrn String - NAVER Cloud Platform resource identification value for assignment
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": "2c15b16c-****-****-****-3e7207ff2bf6",
    "nrn": "nrn:PUB:SSO::*******:Assignment/2c15b16c-****-****-****-3e7207ff2bf6",
    "success": true
}