Organizations を取得する

Auth0 Dashboard と Management API を使用して Organizations を取得する方法を説明します。

組織をプログラムから操作する場合、すべての組織の一覧を取得したり、名前または ID を指定して個別の組織を取得したりする必要があることがあります。

Management API へのアクセスには、confidential なクライアントのみを使用してください。この API の利用には、Auth0 Management API のレート制限が適用されます。

​

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

Management API を使用して、テナントのすべての組織を取得できます。

1000 件を超える結果を取得するには、checkpoint ページネーションを使用する必要があります。詳細については、API Explorer の Get Organizations エンドポイント を参照してください。

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 のアクセストークン。

​

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

想定されるレスポンスのステータスコードは次のとおりです。

ステータスコード	エラーコード	メッセージ	原因
200		組織の取得に成功しました。
400	invalid_paging	リクエストしたページが、許可されている最大 1000 レコードを超えています。	API は最大 1000 レコードまでしか返さないように制限されています。
400	invalid_query_string	リクエストのクエリ文字列が無効です。メッセージは原因によって異なります。	クエリ文字列が無効です。
401		無効なトークンです。
401		JSON Web トークンのバリデーションで無効な署名を受信しました。
401		クライアントはグローバルではありません。
403	insufficient_scope	スコープが不足しています。必要なスコープのいずれか: read:organizations。	提供された bearer token のスコープでは許可されていないフィールドの読み取りまたは書き込みを試みました。
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 月より前に作成されている場合、domain 名は https://travel0.auth0.com になります。)

カスタムドメインを使用している場合は、カスタムドメイン名を指定してください。

値	説明
ORG_ID	取得する組織 の ID。
MGMT_API_ACCESS_TOKEN	スコープ read:organizations を持つ Management API のアクセストークン。

​

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

考えられるレスポンスのステータスコードは次のとおりです。

Status code	Error code	Message	Cause
200		組織の取得に成功しました。
400	invalid_query_string	リクエストのクエリ文字列が無効です。メッセージは原因によって異なります。	クエリ文字列が無効です。
401		トークンが無効です。
401		JSON Web トークンのバリデーションで受信した署名が無効です。
401		クライアントはグローバルではありません。
403	insufficient_scope	スコープが不足しています。次のいずれかが必要です: read:organizations。	指定されたベアラー トークンのスコープでは許可されていないフィールドの読み取りまたは書き込みを試みました。
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 のアクセストークン。

​

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

返される可能性のあるレスポンスステータスコードは次のとおりです。

ステータスコード	エラーコード	メッセージ	原因
200		Organizations を正常に取得しました。
400	invalid_query_string	リクエストのクエリ文字列が無効です。メッセージは原因に応じて異なります。	クエリ文字列が無効です。
401		無効なトークンです。
401		JSON Web トークンのバリデーションで無効な署名が検出されました。
401		クライアントはグローバルではありません。
403	insufficient_scope	スコープが不足しています。次のいずれかが必要です: read:organizations。	指定された bearer token のスコープでは許可されていないフィールドの読み取りまたは書き込みを試みました。
429		リクエストが多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset ヘッダーを確認してください。