通知対象者リストの照会

Prev Next

Classic/VPC環境で利用できます。

通知対象者リストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/notification-recipients

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
managerGroupNo Integer Conditional マネージャグループの固有 ID

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
managerNo Integer - マネージャの固有 ID
managerName String - マネージャ名
managerDescription String - マネージャの説明
managerGroupNo Integer - マネージャグループの固有 ID
  • managerGroupNoなしでリクエストした場合、このフィールドは含まれない。
managerGroupName String - マネージャグループ名
emailAddress String - メールアドレス

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

[{
    "managerNo": 1,
    "managerName": "管理者",
    "managerDescription": "管理者",
    "managerGroupNo": 1,
    "managerGroupName": "管理者グループ",
    "emailAddress": "******@ncloud.com"
}]