組織一覧の照会

現在の開発者キーが属するアカウントがアクセスできる組織一覧を照会できます。

本インターフェースを使用して、現在の開発者キーが属するアカウントがアクセスできる組織一覧を照会できます。

リクエストメソッド

GET

リクエストURL

https://api.${endpoint}/v1/org/list

リクエスト認証

アカウントレベルの DevKey / DevSecret による Basic 認証を使用します。

リクエスト

リクエスト例

curl -X GET 'https://api.${endpoint}/v1/org/list' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/org/list' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Basic ${BASIC_TOKEN}	`DevKey:DevSecret` を Base64 エンコードした Basic Token を使用します。

リクエストパラメータ

なし。

レスポンス

レスポンス例

{ "code": 0, "message": "OK", "data": [ { "org_id": "p-xxxx", "org_name": "Demo Org", "is_owner": true } ] }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": [
    {
      "org_id": "p-xxxx",
      "org_name": "Demo Org",
      "is_owner": true
    }
  ]
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
org_id	String	組織 ID。以降の組織リソースインターフェースで、このフィールドを渡す必要があります。
org_name	String	組織名称。
is_owner	Boolean	現在のアカウントが組織の所有者かどうか。

エラー時のレスポンス

フィールド	タイプ	説明
code	Integer	エラーコード。
message	String	エラー詳細。

ステータスコード

ステータスコード	説明
200	成功
400	パラメータエラー
401	未認証
403	権限不足
429	リクエストが頻繁すぎます
500	サーバーエラー