組織を取得する

Auth0 DashboardやManagement APIを使用して組織を取得する方法を説明します。

プログラムで組織を操作する場合は、すべての組織のリストを取得するか、名前またはIDで組織を個別に取得する必要がある場合があります。

Management APIには、機密のクライアントを使ってアクセスすることしかできません。Management APIの使用には、Auth0 Management APIレート制限が適用されます。

​

テナント組織を取得する

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

1000件を超える結果を取得するには、チェックポイントページネーションメソッドを使用しなければなりません。詳細については、当社のAPI Explorerで「Organizations取得エンドポイント」を参照してください。

Get Organizationsエンドポイントに対してGET呼び出しを行います。MGMT_API_ACCESS_TOKENプレースホルダーの値をManagement APIのアクセストークンで置き換えてください。

Auth0ドメインを見つける

テナント名がAuth0ドメインである場合は、地域のサブドメイン（テナントが米国地域にあり、2020年6月より前に作成された場合を除く）の後に「.auth0.com」が続きます。たとえば、テナント名が「travel0」の場合、Auth0のドメイン名は「travel0.us.auth0.com」になります。（テナントが米国内にあって、2020年6月よりも前に作成された場合、ドメイン名は「https://travel0.auth0.com」になります。）

カスタムドメインを使用している場合には、これがカスタムドメイン名になります。

値	説明
MGMT_API_ACCESS_TOKEN	read:organizationsスコープのあるManagement APIのアクセストークン。

​

応答ステータスコード

可能性のある応答ステータスコードは以下のとおりです。

ステータスコード	エラーコード	メッセージ	原因
200		Organization successfully retrieved（メンバーを取得しました）
400	invalid_paging	Requesting page exceeds the allowed maximum of 1000 records（要求しているページは許可される最大の1000件のレコードを超えました）	APIは、最大1000件のレコードのみを返すように制限されています。
400	invalid_query_string	Invalid request query string（無効な要求クエリ文字列です）メッセージは、原因によって異なります。	クエリ文字列が有効ではありません。
401		Invalid token（無効なトークンです）
401		Invalid signature received for JSON Web Token validation（JSON Webトークン検証に無効な署名を受け取りました）
401		Client is not global（クライアントがグローバルでありません）
403	insufficient_scope	Insufficient scope; expected any of（スコープ不足。次のいずれかを想定します）： read:organizations.	提供されたベアラートークンスコープで許可されていないフィールドのread/writeを試みました。
429		Too many requests（要求が多すぎます）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ドメインである場合は、地域のサブドメイン（テナントが米国地域にあり、2020年6月より前に作成された場合を除く）の後に「.auth0.com」が続きます。たとえば、テナント名が「travel0」の場合、Auth0のドメイン名は「travel0.us.auth0.com」になります。（テナントが米国内にあって、2020年6月よりも前に作成された場合、ドメイン名は「https://travel0.auth0.com」になります。）

カスタムドメインを使用している場合には、これがカスタムドメイン名になります。

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

​

応答ステータスコード

可能性のある応答ステータスコードは以下のとおりです。

ステータスコード	エラーコード	メッセージ	原因
200		Organizationが正常に取得されました。
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のプレースホルダーの値を、それぞれ組織IDとManagement APIのアクセストークンに置き換えてください。

Auth0ドメインを見つける

テナント名がAuth0ドメインである場合は、地域のサブドメイン（テナントが米国地域にあり、2020年6月より前に作成された場合を除く）の後に「.auth0.com」が続きます。たとえば、テナント名が「travel0」の場合、Auth0のドメイン名は「travel0.us.auth0.com」になります。（テナントが米国内にあって、2020年6月よりも前に作成された場合、ドメイン名は「https://travel0.auth0.com」になります。）

カスタムドメインを使用している場合には、これがカスタムドメイン名になります。

値	説明
ORG_ NAME	取得したい組織の名前。最大の長さは50文字。
MGMT_API_ACCESS_TOKEN	スコープread:organizationsを持つManagement APIのアクセストークン。

​

応答ステータスコード

可能性のある応答ステータスコードは以下のとおりです。

ステータスコード	エラーコード	メッセージ	原因
200		Organizationが正常に取得されました。
400	invalid_query_string	要求クエリ文字列が無効です。メッセージは原因に応じて異なります。	クエリ文字列が有効ではありません。
401		トークンが無効です。
401		JSON Webトークンの検証に受け取った署名が無効です。
401		クライアントがグローバルでありません。
403	insufficient_scope	スコープが不十分です。予想された値：read:organizations	指定されたベアラートークンのスコープで許可されていないフィールドの読み取り/書き込みを試行しました。
429		要求が多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Resetヘッダーを確認してください。