組織の動作を定義する

Auth0 の組織機能で、アプリケーション内での組織の動作を定義する方法を学びます。

Auth0 でアプリケーションを表す際に、そのアプリケーションでサポートするユーザーの種類を指定できます。個人アカウントでログインする個人向けのアプリケーションもあれば、組織のメンバーによる利用を想定したアプリケーションもあります。両方をサポートするものもあります。これは組織の動作と呼ばれ、Auth0 に接続する各アプリケーションに対して設定できます。

たとえば、アプリケーションには次のようなものがあります。

• Log in ボタンがある汎用的なマーケティング用ランディングページがあり、そのボタンからユーザーは 組織 なしで Auth0 のLogin フローに移動します。
• B2B 顧客ごとに個別の URL があり (例: Acme のユーザーは acme.yourcompany.com にアクセス) 、その URL からユーザーは 組織 付きで Auth0 にリダイレクトされるため、Acme の SSO Login ボタンが表示されます。

組織の動作を定義することで、これらのどちらのシナリオにも対応できます。さらに、アプリケーションで 組織 の指定を必須にしているにもかかわらず、ユーザーが誤って 組織 なしで Auth0 に送られた場合に、組織名を入力できるプロンプトが表示されるように組織の動作を設定することもできます。

組織の動作は、Auth0 Dashboard または Management API のいずれかを使用して定義できます。

​

Auth0 Dashboard

Auth0 Dashboard で組織の動作を定義するには、次の手順を実行します。

1. Auth0 Dashboard > Applications に移動し、組織を設定するアプリケーションを選択します。
2. Login Experience ビューに切り替え、適切な設定を行います。

Field	Description	API Mapping
Type of Users	アプリケーションにログインできるユーザーの種類を決定します。 オプションは次のとおりです。 Individuals: ユーザーは個人アカウントでサインアップし、アプリケーションに直接ログインできます。個人ユーザーは組織を使用してログインすることはできません。 Business Users: ユーザーがログインするには、組織のメンバーである必要があります。これを選択した場合は、ユーザーを /authorize エンドポイントにリダイレクトする際に組織を指定するか、Login フロー を Prompt for Organization に設定する必要があります。 Both: ユーザーは組織メンバーとしてログインすることも、個人アカウントでサインアップすることもできます。	Type of Users は organization_usage にマッピングされます オプション: Individuals は deny にマッピングされます Business Users は require にマッピングされます Both は allow にマッピングされます
Login Flow	ユーザーがアプリケーションにアクセスしたときに最初に表示されるログイン プロンプトを決定します。このフィールドを設定できるのは、Type of Users が Business Users または Both に設定されている場合のみです。 オプションは次のとおりです。 Prompt for Credentials: ユーザーは最初にログイン認証情報の入力を求められます。ログイン後、ユーザーは自分の組織を選択できます。 Prompt for Organization: ユーザーは最初に自分の組織を選択するよう求められます。その後、認証情報を入力してログインできます。 No Prompt: Auth0 は、ユーザーにどのログイン プロンプトを表示するかを指定しません。代わりに、適切なプロンプトを表示するために必要なパラメーターを Auth0 に送信するのはアプリケーションの役割です。	Login Flow は organization_require_behavior にマッピングされます オプション: Prompt for Credentials は post_login_prompt にマッピングされます Prompt for Organization は pre_login_prompt にマッピングされます No Prompt は no_prompt にマッピングされます
Organization Discovery	認証前にユーザーの組織を識別するための方法を定義します。Prompt for Organization Login フロー でのみ使用できます。 オプションは次のとおりです。 Prompt for Organization Email: ユーザーは最初に、組織に関連付けられたメールアドレスの入力を求められます。 Prompt for Organization Name: ユーザーは最初に、自分の組織名の入力を求められます。 Prompt for Organization Email and Name: ユーザーは最初に、自分の組織名または組織に関連付けられたメールアドレスの入力を求められます。	Prompt for Emails: email にマッピングされます。 Prompt for Organization: organization_name にマッピングされます。 Prompt for Organization Email and Name: email と organization_name にマッピングされます。

3. Save changes を選択します。

​

Management API

Update a Client エンドポイントに対して PATCH 呼び出しを行います。client_id、mgmt_api_access_token、organization_usage、および organization_require_behavior のプレースホルダー値は、それぞれお使いのクライアントID、Management API のアクセストークン、組織の利用オプション、および組織の動作オプションに必ず置き換えてください。

値	説明
CLIENT_ID	組織の動作を追加する対象のアプリケーションの ID。
MGMT_API_ACCESS_TOKEN	スコープ update:clients を持つ Management API のアクセストークン。
ORGANIZATION_USAGE	アプリケーションで、ユーザーの組織を使用したログインをサポートするかどうかを指定します。オプションは次のとおりです。 deny: (デフォルト) ユーザーは組織を使用してログインできません。 allow: ユーザーは組織ありでもなしでもログインできます。このオプションを選択した場合、ユーザーを /authorize エンドポイントにリダイレクトする際に、組織を指定する必要があります。 require: ユーザーは組織を使用してログインする必要があります。このオプションを選択した場合、ユーザーを /authorize エンドポイントにリダイレクトする際に組織を指定するか、ログイン前にユーザーが組織を選択できるよう organization_require_behavior を pre_login_prompt に設定する必要があります。
ORGANIZATION_REQUIRE_BEHAVIOR	アプリケーションにアクセスするユーザーに表示する Login フローを指定します。organization_usage が require または allow に設定されている場合にのみ適用されます。 オプションは次のとおりです。 no_prompt: (デフォルト) プロンプトを表示しません。有効な organization パラメーターがないリクエストは拒否されます。 pre_login_prompt: ユーザーがログインする前に、組織を選択するよう求めます。このオプションは、organization_usage が require に設定されている場合にのみ使用できます。 post_login_prompt: ユーザーに認証情報を使用してログインするよう求めます。ログイン後に、組織を選択するよう求めます。
ORGANIZATION_DISCOVERY_METHODS	認証前にユーザーの組織を特定する方法を指定します。organization_require_behavior が pre_login_prompt で、organization_usage が require または allow に設定されている場合にのみ適用されます。 email: (デフォルト) ユーザーは、自身の組織に関連付けられたメールアドレスを入力するよう求められます。 organization_name: ユーザーは、自身の組織に関連付けられた組織名を入力するよう求められます。 Organization name and email: ユーザーは、自身の組織に関連付けられたメールアドレスまたは組織名を入力するよう求められます。

​

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

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

ステータスコード	エラーコード	メッセージ	原因
200		クライアントが正常に更新されました。
400	invalid_uri	無効なリクエスト URI です。メッセージは原因に応じて異なります。	パスが無効です。
400	invalid_body	無効なリクエストボディです。メッセージは原因に応じて異なります。	リクエストのペイロードが無効です。
401		無効なトークンです。
401		クライアントはグローバルではありません。
401		JSON Web Token の検証時に無効な署名が検出されました。
403	insufficient_scope	スコープが不足しています。必要なスコープ: update:clients。	指定されたベアラートークンのスコープでは許可されていないフィールドの読み取りまたは書き込みが試行されました。
403	insufficient_scope	ベアラートークンのスコープで付与された権限では、一部のフィールドを更新できません。メッセージはフィールドとスコープに応じて異なります。	指定されたベアラートークンのスコープでは許可されていないフィールドの読み取りまたは書き込みが試行されました。
403	operation_not_supported	このアカウントではこの操作を実行できません。	このアカウントではこの操作を実行できません。
404	inexistent_client	クライアントが見つかりません。	存在しないリソースです。指定されたアプリケーションは存在しません。
429		リクエストが多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset ヘッダーを確認してください。