Get IP ACL assignment list

Prev Next

Available in Classic and VPC

Get the list of assignments added to an IP ACL.

Request

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

Method URI
GET /api/v1/ip-acls/{ipAclId}/assignments

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
ipAclId String Required IP ACL ID

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
targetType String Required Target type
  • console | api
    • console: console access
    • api: API Gateway access
page Integer Optional Page number
  • 0-N (default: 0)
size Integer Optional Page output count
  • 1-N (default: 20)

Request example

The request example is as follows:

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/ip-acls/5bf4cad0-****-****-****-cd51bba3fe23/assignments?targetType=console&page=0&size=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
page Number - Page number
totalPages Number - Total number of pages
totalItems Number - Number of response results
isFirst Boolean - Whether it is the first page
  • true | false
    • true: first page
    • false: not a first page
isLast Boolean - Whether it is the last page
  • true | false
    • true: last page
    • false: not a last page
hasPrevious Boolean - Whether previous page exists
  • true | false
    • true: It exists
    • false: It doesn't exist
hasNext Boolean - Whether next page exists
  • true | false
    • true: It exists
    • false: It doesn't exist
items Array - Assignment list

items

The following describes items.

Field Type Required Description
assignmentId String - Assignment ID
assignmentName String - Assignment name
description String - Assignment description
nrn String - NAVER Cloud Platform resource identification value for assignment
status String - Assignment status
  • active | suspended
    • active: enabled
    • suspended: disabled
iamRoleNrn String - NRN of the SSO role created in the Sub Account service
  • NAVER Cloud Platform resource identification value list for IAM role
consoleAccessAllowed Boolean - Whether to allow console access
  • true | false
    • true: allow
    • false: not allow
consoleAccessRestricted Boolean - Whether to restrict console access
  • true | false
    • true: restrict
    • false: not restrict
apiAccessAllowed Boolean - Whether to allow API Gateway access
  • true | false
    • true: allow
    • false: not allow
apiAccessRestricted Boolean - Whether to restrict API Gateway access
  • true | false
    • true: restrict
    • false: not restrict
createdAt String - Assignment creation date and time
  • ISO 8601 format
updatedAt String - Last assignment modification date and time
  • ISO 8601 format
accountMbrNo Integer - Account member ID (MemberNo)
accountName String - Account username
permissionCreatedAt String - Permission set creation date and time
  • ISO 8601 format

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:

{
    "page" : 0,
    "totalPages" : 1,
    "totalItems" : 1,
    "isFirst" : true,
    "isLast" : true,
    "hasPrevious" : false,
    "hasNext" : false,
    "items" : [
        {
            "assignmentId" : "e1653f17-****-****-****-deb664fb8a2f",
            "assignmentName" : "assignment000",
            "description" : "assignment000",
            "nrn" : "nrn:PUB:SSO::*******:Assignment/e1653f17-****-****-****-deb664fb8a2f",
            "status" : "active",
            "iamRoleNrn" : "nrn:PUB:IAM::*******:Role/385550d0-****-****-****-005056a79baa",
            "consoleAccessAllowed" : true,
            "consoleAccessRestricted" : true,
            "apiAccessAllowed" : true,
            "apiAccessRestricted" : true,
            "createdAt" : "2025-01-13T02:36:40Z",
            "updatedAt" : "2025-01-13T06:46:34Z",
            "accountMbrNo" : *******,
            "accountName" : "Gildong Hong",
            "permissionSetId" : "3fcd3c17-****-****-****-2a594248bf28"
        }
    ]
}