メインコンテンツへスキップ
組織 をプログラムから操作する場合は、すべての組織の一覧、または名前や ID を指定した個別の組織を取得する必要があることがあります。
Management API へのアクセスには、機密クライアントのみを使用してください。その利用には、Auth0 Management API のレート制限 が適用されます。

​
テナントの組織を取得する

を使用して、テナントのすべての組織を取得できます。
1000 件を超える結果を取得するには、チェックポイントページネーション方式を使用する必要があります。詳細については、API Explorer の Get Organizations endpoint を参照してください。
Get Organizations エンドポイントに対して GET リクエストを送信します。MGMT_API_ACCESS_TOKEN プレースホルダーは、お使いの Management API に置き換えてください。
Auth0 ドメインを確認するAuth0 ドメインは、テナント名、リージョンのサブドメイン (テナントが US リージョンにあり、2020 年 6 月より前に作成された場合を除く) 、および .auth0.com を組み合わせたものです。たとえば、テナント名が travel0 の場合、Auth0 ドメイン名は travel0.us.auth0.com になります。 (テナントが US にあり、2020 年 6 月より前に作成された場合、ドメイン名は https://travel0.auth0.com になります。)カスタムドメインを使用している場合は、そのカスタムドメイン名を使用してください。
値説明
MGMT_API_ACCESS_TOKENスコープ read:organizations を持つ、Management API のアクセストークン。

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

返される可能性があるレスポンスステータスコードは、次のとおりです。
Status codeError codeMessageCause
200組織の取得に成功しました。
400invalid_pagingリクエストしたページが、許可されている最大 1000 レコードを超えています。API は最大 1000 レコードまでしか返さないように制限されています。
400invalid_query_stringリクエストのクエリ文字列が無効です。メッセージは原因によって異なります。クエリ文字列が無効です。
401無効なトークンです。
401JSON Web Token の検証時に無効な署名を受信しました。
401クライアントはグローバルではありません。
403insufficient_scopeスコープが不足しています。次のいずれかが必要です: read:organizations。指定されたベアラートークンのスコープでは許可されていないフィールドの読み取りまたは書き込みを試行しました。
429リクエストが多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset ヘッダーを確認してください。

​
ID による組織の取得

Management API を使用すると、ID で組織を取得できます。 Get Organization エンドポイントに対して GET リクエストを実行します。ORG_ID と MGMT_API_ACCESS_TOKEN のプレースホルダー値は、それぞれ組織 ID と Management API アクセストークンに置き換えてください。
Auth0 ドメインを確認するAuth0 ドメインは、テナント名、リージョンのサブドメイン (テナントが US リージョンにあり、2020 年 6 月以前に作成された場合を除く) 、および .auth0.com を組み合わせたものです。たとえば、テナント名が travel0 の場合、Auth0 ドメイン名は travel0.us.auth0.com になります。 (テナントが US にあり、2020 年 6 月以前に作成された場合、ドメイン名は https://travel0.auth0.com になります。)カスタムドメインを使用している場合は、そのカスタムドメイン名を指定してください。
値説明
ORG_ID取得する組織の ID。
MGMT_API_ACCESS_TOKENスコープ read:organizations を持つ Management API のアクセストークン。

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

返される可能性があるレスポンスステータスコードは次のとおりです。
ステータスコードエラーコードメッセージ原因
200組織を正常に取得しました。
400invalid_query_stringリクエストのクエリ文字列が無効です。メッセージは原因によって異なります。クエリ文字列が無効です。
401トークンが無効です。
401JSON Web Token の検証時に無効な署名を受信しました。
401クライアントはグローバルではありません。
403insufficient_scope必要なスコープが不足しています。次のいずれかが必要です: read:organizations。指定された Bearer Token のスコープでは許可されていないフィールドの読み取りまたは書き込みを試みました。
429リクエストが多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset ヘッダーを確認してください。

​
名前で組織を取得する

Management API を使用して、名前で組織を取得できます。 Get Organization by Name エンドポイントに GET リクエストを送信します。ORG_NAME と MGMT_API_ACCESS_TOKEN のプレースホルダー値は、それぞれ組織名と Management API アクセストークンに置き換えてください。
Auth0 ドメインを確認するAuth0 ドメインは、テナント名、リージョンのサブドメイン (テナントが US リージョンにあり、2020 年 6 月より前に作成されている場合を除く) 、および .auth0.com を組み合わせたものです。たとえば、テナント名が travel0 の場合、Auth0 ドメイン名は travel0.us.auth0.com になります。 (テナントが US にあり、2020 年 6 月より前に作成されている場合、ドメイン名は https://travel0.auth0.com になります。)カスタムドメインを使用している場合は、カスタムドメイン名を指定してください。
値説明
ORG_ NAME取得する組織の名前。最大 50 文字です。
MGMT_API_ACCESS_TOKENスコープ read:organizations を持つ Management API のアクセストークン。

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

想定されるレスポンスステータスコードは次のとおりです。
Status codeError codeMessageCause
200組織の取得に成功しました。
400invalid_query_stringリクエストのクエリ文字列が無効です。メッセージは原因によって異なります。クエリ文字列が無効です。
401トークンが無効です。
401JSON Web Token の検証で無効な署名が検出されました。
401クライアントはグローバルではありません。
403insufficient_scopeスコープが不足しています。必要なスコープ: read:organizations。提供された Bearer Token のスコープでは許可されていないフィールドの読み取りまたは書き込みを試行しました。
429リクエストが多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset ヘッダーを確認してください。