Get group assignment list

Prev Next

Available in Classic and VPC

Get the list of assignments a group belongs to.

Request

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

Method URI
GET /api/v1/groups/{groupId}/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
groupId String Required Group ID

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
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/groups/12cfbd94-****-****-****-2ff725201395/assignments?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: in use (enabled)
    • suspended: 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
createdAt String - Assignment creation date and time
  • ISO 8601 format
updatedAt String - Last assignment modification date and time
  • ISO 8601 format
accountMbrNo Number - Account member ID (MemberNo)
accountName String - Account username
permissionSetId String - Permission set ID

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": "14f396ae-****-****-****-388a3954e37e",
            "assignmentName": "assignment000",
            "description": "assignment000 description",
            "nrn": "nrn:PUB:SSO::*******:Assignment/14f396ae-****-****-****-388a3954e37e",
            "status": "active",
            "iamRoleNrn": "nrn:PUB:IAM::*******:Role/934786b0-****-****-****-005056a79baa",
            "consoleAccessAllowed": true,
            "consoleAccessRestricted": false,
            "apiAccessAllowed": true,
            "apiAccessRestricted": false,
            "createdAt": "2025-01-14T00:50:39Z",
            "updatedAt": "2025-01-14T00:51:35Z",
            "accountMbrNo": *******,
            "accountName": "Gildong Hong",
            "permissionSetId": "87512735-****-****-****-ab5b164127f5"
        }
    ]
}