Get SSO user group

Prev Next

Available in Classic and VPC

Get details of a group that an SSO user belongs to.

Request

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

Method URI
GET /api/v1/users/{userId}/groups/{groupId}

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
userId String Required SSO user ID
groupId String Required Group ID

Request example

The request example is as follows:

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/users/ba0def04-****-****-****-ff0b962016f7/groups/12cfbd94-****-****-****-2ff725201395' \
--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
groupId String - Group ID
groupName String - Group name
nrn String - NAVER Cloud Platform resource identification value for group
description String - Group description
createdAt String - Group creation date and time
  • ISO 8601 format
updatedAt String - Group modification date and time
  • ISO 8601 format
relationCreatedAt String - Group addition 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:

{
    "groupId": "12cfbd94-****-****-****-2ff725201395",
    "groupName": "group000",
    "nrn": "nrn:PUB:SSO::*******:Group/12cfbd94-****-****-****-2ff725201395",
    "description": "group000 description",
    "createdAt": "2025-01-13T02:04:15Z",
    "updatedAt": "2025-01-13T02:07:21Z",
    "relationCreatedAt": "2025-01-13T02:07:21Z"
}