リクエスト

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

メソッド	URI
GET	/open-api/v1/account/group/{organizationGroupNo}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`organizationGroupNo`	Integer	Required	アカウントグループ番号アカウントグループリストの照会を参照

リクエスト例

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

curl --location --request GET 'https://organization.apigw.ntruss.com/open-api/v1/account/group/****' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`memberNo`	Integer	-	アカウントの会員番号
`organizationNo`	Integer	-	Organization番号
`organizationGroupNo`	Integer	-	アカウントグループ番号
`masterMemberNo`	Integer	-	マスターアカウントの会員番号
`masterMemberYn`	String	-	マスターアカウントかどうか `Y` \| `N` `Y`: マスターアカウント `N`: マスターアカウントではない
`loginId`	String	-	アカウントログイン ID
`memberName`	String	-	アカウントのユーザー名
`memberAlias`	String	-	メンバーアカウントの Alias(エイリアス) コンソールで Alias設定時に表示
`memberStatusCode`	String	-	アカウントの状態コード
`memberStatusName`	String	-	アカウントの状態

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

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

レスポンス例

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

[
    {
        "memberNo": 270****,
        "organizationNo": 2712,
        "organizationGroupNo": 1449,
        "masterMemberNo": 279****,
        "masterMemberYn": "N",
        "loginId": "l******@navercorp.com",
        "memberName": "佐藤一郎",
        "memberAlias": "-",
        "memberStatusCode": "INVT",
        "memberStatusName": "招待中"
    },
    {
        "memberNo": 279****,
        "organizationNo": 2712,
        "organizationGroupNo": 1449,
        "masterMemberNo": 279****,
        "masterMemberYn": "Y",
        "loginId": "n******@navercorp.com",
        "memberName": "田中太郎",
        "memberStatusCode": "JOIN",
        "memberStatusName": "登録完了"
    }
]

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Organization