リクエスト

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

メソッド	URI
GET	/open-api/v1/org

リクエストヘッダ

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`organizationNo`	Integer	-	Organization番号
`organizationName`	String	-	Organization名
`organizationDesc`	String	-	Organizationの説明
`masterMemberNo`	Integer	-	マスターアカウントの会員番号
`masterMemberName`	String	-	マスターアカウントのユーザー名
`masterMemberEmailAddress`	String	-	マスターアカウントユーザーのメールアドレス
`masterMemberYn`	String	-	マスターアカウントかどうか `Y` \| `N` `Y`: マスターアカウント `N`: マスターアカウントではない
`memberNo`	Integer	-	マスターアカウントの会員番号
`joinYmdt`	Integer	-	登録日時(ミリ秒) Unix Timestamp形式
`memberStatusCode`	String	-	アカウントの状態コード
`regYmdt`	Integer	-	作成日時(ミリ秒) Unix Timestamp形式

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

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

レスポンス例

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

{
    "organizationNo": 2706,
    "organizationName": "NAVERクラウド株式会社",
    "organizationDesc": "NAVERクラウド Organization",
    "masterMemberNo": 260****,
    "masterMemberName": "田中太郎",
    "masterMemberEmailAddress": "j*********@navercorp.com",
    "masterMemberYn": "Y",
    "memberNo": 260****,
    "joinYmdt": 1738539893024,
    "memberStatusCode": "JOIN",
    "regYmdt": null
}

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

リクエスト
- リクエストヘッダ
- リクエスト例
レスポンス

タグ

Organization