Get notification recipient list

Prev Next

Available in Classic and VPC

Get the list of notification recipients.

Request

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

Method URI
GET /api/v1/notification-recipients

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
managerGroupNo Integer Conditional Manager group's unique identifier

Request example

The request example is as follows:

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/notification-recipients' \
--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
managerNo Integer - Manager's unique identifier
managerName String - Manager name
managerDescription String - Manager description
managerGroupNo Integer - Manager group's unique identifier
  • This field is not included if the request is made without managerGroupNo.
managerGroupName String - Manager group name
emailAddress String - Email

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:

[{
    "managerNo": 1,
    "managerName": "Admin",
    "managerDescription": "Admin",
    "managerGroupNo": 1,
    "managerGroupName": "Admin group",
    "emailAddress": "******@ncloud.com"
}]