Get notification recipient group list

Prev Next

Available in Classic and VPC

Get the list of notification groups.

Request

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

Method URI
GET /api/v1/notification-recipients/groups

Request headers

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

Request example

The request example is as follows:

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/notification-recipients/groups' \
--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
managerGroupNo Integer - Manager group's unique identifier
managerGroupName String - Manager group name
managerCount Integer - Number of managers that belong to the group

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:

[{
    "managerGroupNo": 1,
    "managerGroupName": "Admin group",
    "managerCount": 20
}]