アカウントグループリストの照会

Prev Next

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

全アカウントグループと所属アカウントを照会します。

リクエスト

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

メソッド URI
GET /open-api/v1/group/tree

リクエストヘッダ

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

リクエスト例

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

curl --location --request GET 'https://organization.apigw.ntruss.com/open-api/v1/policy/tree' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
displayName String - アカウントグループ/アカウント名
organizationGroupNo Integer - アカウントグループ番号
organizationGroupName String - アカウントグループ名
upperOrganizationGroupNo Integer - 上位アカウントグループ番号
memberNo Integer - アカウントの会員番号
memberName String - アカウントのユーザー名
memberAlias String - アカウントの Alias(エイリアス)
  • マスターアカウント: Masterと表示
  • メンバーアカウント: コンソールで Alias設定時に表示
loginId String - アカウントログイン ID
memberStatusCode String - アカウントの状態コード
memberStatusName String - アカウントの状態
wholePath String - アカウントグループの階層構造
policyNo Integer - ポリシー番号
policyName String - ポリシー名
groupYn String - アカウントグループかどうか
  • Y | N
    • Y: アカウントグループ
    • N: アカウントグループではない
masterMemberYn String - マスターアカウントかどうか
  • Y | N
    • Y: マスターアカウント
    • N: マスターアカウントではない
modYmdt String - 作成/登録日時(ミリ秒)
  • Unix Timestamp形式
orgNoForLev Integer - アカウントグループ番号
leaveReqYmdt String - 退会申し込み日時
  • 退会を申し込んだ場合に表示

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

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

レスポンス例

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

[
    {
        "displayName": "NAVERクラウド株式会社",
        "organizationGroupNo": 1444,
        "organizationGroupName": "NAVERクラウド株式会社",
        "memberNo": 260****,
        "memberName": "田中太郎",
        "memberAlias": "Master",
        "loginId": "j*********@navercorp.com",
        "memberStatusCode": "JOIN",
        "memberStatusName": "登録完了",
        "wholePath": "1444",
        "policyNo": 4925,
        "policyName": "Organization_Default_Policy",
        "groupYn": "N",
        "masterMemberYn": "Y",
        "modYmdt": 1738539893024,
        "orgNoForLev": 2706
    },
    {
        "displayName": "NewAccountGroup",
        "organizationGroupNo": 1445,
        "organizationGroupName": "NewAccountGroup",
        "upperOrganizationGroupNo": 1444,
        "wholePath": "1444/1445",
        "policyNo": 4925,
        "policyName": "Organization_Default_Policy",
        "groupYn": "Y",
        "masterMemberYn": "N",
        "modYmdt": 1738543759212,
        "orgNoForLev": 2706
    }
]