組織の接続を有効にする

Auth0 Dashboard と Management API を使用して、組織の接続を有効にする方法を説明します。

新しいエンドポイントと属性を使用した組織の接続の管理は、My Organization API and Embeddable UI Components の一部として Early Access で提供されています。この機能を使用することで、Okta’s Master Subscription Agreement に定められた該当する Free Trial 条項に同意したものとみなされます。Auth0 の製品リリースサイクルの詳細については、Product Release Stages を参照してください。

各組織で特定の接続を有効にすると、ユーザーに異なるログインオプションを提供できます。接続を有効にすると、その接続が組織のログインプロンプトに追加され、ユーザーはその接続を通じて認証し、アプリケーションにアクセスできるようになります。

組織で接続を有効にするには、その接続がテナント内にすでに存在している必要があります。サポートされる接続には、データベース接続、ソーシャル接続、Enterprise 接続 があります。

​

組織のプロパティ

組織を使用する場合、一部の接続では追加のプロパティを設定できます。

プロパティ	接続タイプ	説明
組織接続名	すべての接続タイプ	この名前は、組織管理者が My Organization API を使用して指定します。設定されていない場合は、組織管理者がこの接続を表示したときに表示される名前を指定してください。
組織管理者のアクセスレベル	すべての接続タイプ	このプロパティは、この接続に対して組織管理者が持つアクセスレベルを決定します。指定できる値は次のとおりです。 なし: テナント管理者が管理し、My Organization API では表示も編集もできません。 読み取り専用: テナント管理者が管理し、My Organization API で表示できます。 制限付き: 組織管理者は、My Organization API を使用して、選択した非機密設定を編集できます。 フル: 組織管理者は、この接続で許可されているすべての設定を編集できます。ただし、Connection Profile で定義された制限が適用されます。
認証時のメンバーシップ	すべての接続タイプ	有効にすると、このプロパティにより、エンドユーザーがその接続で初めて認証した際に、自動的に組織のメンバーシップが割り当てられます。認証時のメンバーシップは、特定の接続で認証できるすべてのユーザーを、その組織のメンバーとみなせるシナリオで役立ちます。
組織サインアップ	データベース接続のみ	このプロパティは、エンドユーザーがログインプロンプト上のサインアップリンクにアクセスして、組織のメンバーシップを取得できるかどうかを決定します。組織サインアップを使用するには、認証時のメンバーシップも有効にする必要があります。組織サインアップは、ユーザーがセルフサービスで組織に参加できる必要がある次のようなシナリオで役立ちます。 組織を、ワークスペースのようなオープンメンバーシップのユーザー集団をモデル化するために使用している場合。 ユーザーが自由にアカウント登録できる business-to-business-to-consumer (B2B2C) のユースケース。
接続をボタンとして表示	Enterprise 接続のみ	任意。このプロパティは、特定の接続を組織のログインプロンプトに選択肢として表示するかどうかを決定します。エンドユーザーは、Identifier First with Home Realm Discovery 認証プロファイルを Prompt for Credentials 組織ログインフローと組み合わせて使用して認証することもできます。これは、認可リクエストに org_id を指定しない場合にのみ機能します。 このオプションが無効になっていても、エンドユーザーは認可リクエストで connection パラメーターを直接送信することで、この接続を介して認証できます。

​

組織の接続を設定する

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

Auth0 Dashboard

​

Auth0 Dashboard

Auth0 Dashboard で接続を有効にするには、次の手順に従います。

1. Auth0 Dashboard > Organizations に移動し、設定する組織を選択します。
2. Connections タブを選択し、続いて Add Connections を選択します。
3. 有効にする接続を選択し、Add Connection を選択します。
4. Organization Connection セクションで、My Organization API 経由で接続を利用するために必要な 2 つのプロパティを設定します。

• Organization Connection Name を確認します。値が設定されていない場合は、この接続を表示したときに組織管理者に表示する名前を指定します。
• Organization Admin Access Level を確認し、値が設定されていない場合は、My Organization API 経由でこの接続に対して組織管理者に付与するアクセスレベルを選択します。

5. Authentication セクションで、Membership On Authentication を確認し、自動メンバーシップを有効にするか無効にするかを選択します。有効にすると、その接続でログインするすべてのユーザーが自動的に組織のメンバーとして追加されます。

6. データベース接続のみ: Organization Signup セクションで、セルフサービスのサインアップを有効にするか無効にするかを選択します。有効にすると、ユーザーはログインプロンプトのサインアップリンクからアカウントを作成し、自動的に組織のメンバーになります。

   • このプロパティを有効にするには、まず Membership on Authentication を有効にする必要があります。
   • 注: Organization Signup は、データベース接続のサインアップ設定より優先されます。Organization Signup が有効な場合、データベース接続レベルでサインアップが無効になっていても、ユーザーは引き続き組織にサインアップしたり、組織からの招待を承諾したりできます。

7. Enterprise 接続のみ: Connection button セクションで、必要に応じて Display connection as a button プロパティを有効にすると、その接続が組織のログインプロンプトの選択肢として表示されます。

   組織内で有効になっている接続がすべて Enterprise 接続で、かつすべての接続が非表示になっている場合、ユーザーがアプリケーションにアクセスすると、Auth0 は Message: no connections enabled for the organization are visible というエラーを返します。

8. Save を選択します。

Management API

​

Management API

Management API を使用して接続を有効にするには:

Create Organization Connections エンドポイントに POST リクエストを送信します。以下のプレースホルダー値を適切な情報に置き換えてください。

• {orgId} をご自身の組織 ID に置き換えます。
• {mgmtApiAccessToken} をご利用の Management API アクセストークンに置き換えます。
• {connectionId} を実際の接続IDに置き換えます。
• Membership on Authentication の選択内容に応じて、{assignMembershipOption} を true または false に置き換えます。
• 接続を有効にするかどうかに応じて、{isEnabled} を true または false に置き換えてください。
• データベース接続のみ: サインアップ設定に応じて、{isSignupEnabled} を true または false に置き換えます。
• Enterprise 接続の場合のみ: Connection Button の選択に応じて、{showAsButtonOption} を true または false に置き換えます。
• My Organization API を使用する場合: {organizationAccessLevel} と {organizationConnectionName} を適切な値に置き換えてください。

Auth0 ドメインを確認する

Auth0 のドメインは、テナント名、リージョンのサブドメイン (テナントが US リージョンにあり、2020 年 6 月以前に作成されている場合を除く) 、および .auth0.com を組み合わせたものです。たとえば、テナント名が travel0 の場合、Auth0 のドメイン名は travel0.us.auth0.com になります。 (テナントが US にあり、2020 年 6 月以前に作成されている場合、ドメイン名は https://travel0.auth0.com になります。)

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

値	説明
{orgId}	接続を有効にする対象の組織のID。
{mgmtApiAccessToken}	Management API のアクセストークン (スコープ create:organization_connections が必要) 。
{connectionId}	指定した組織に対して有効にする接続のID。
{assignMembershipOption}	この接続でログインするユーザーに、組織のメンバーシップを自動的に付与するかどうかを示します。true に設定すると、ユーザーには自動的にメンバーシップが付与されます。false に設定すると、自動的には付与されません。
{isEnabled}	組織の接続を有効または無効にします。接続を無効にすると、show_as_button、assign_membership_on_login などの値を保持したまま、接続を無効のままにできます。
{isSignupEnabled}	ユーザーがログインプロンプトでセルフサービスのサインアップリンクを利用できるかどうかを指定します。true に設定すると、サインアップリンクがプロンプトに表示されます。false に設定すると、リンクは表示されません。注: このオプションを有効にするには、{assignMembershipOption} も true に設定する必要があります。
{showAsButtonOption}	特定のEnterprise 接続を組織のログインプロンプトでオプションとして表示するかどうかを示します。true に設定すると、その接続はプロンプトにボタンとして表示されます。false に設定すると、その接続はプロンプトに表示されません。
{organizationAccessLevel}	My Organization API の使用時に、組織管理者にどのレベルのアクセス権を付与するかを指定します。none に設定すると、この接続はテナント管理者が管理し、My Organization API からは表示も編集もできません。read-only に設定すると、この接続はテナント管理者が管理し、My Organization API から表示はできますが、編集はできません。limited に設定すると、組織管理者は My Organization API を通じて、選択された非機密の設定を編集できます。full に設定すると、組織管理者は 接続プロファイル で定義された制限に従い、この接続で許可されているすべての設定を編集できます。
{organizationConnectionName}	この名前は、My Organization API を介して組織管理者によって指定されます。設定されていない場合は、この接続の表示時に組織管理者に表示する名前を指定します。

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

レスポンスのステータスコードは以下のとおりです：

ステータスコード	エラーコード	メッセージ	原因
201		接続が組織に正常に追加されました。
401		無効なトークンです。
401		JSON Web Token の検証で受信した署名が無効です。
401		クライアントはグローバルではありません。
403	insufficient_scope	スコープが不足しています。必要なスコープのいずれか: create:organizations_connections.	指定された Bearer Token のスコープでは許可されていないフィールドの読み取りまたは書き込みを試行しました。
429		リクエストが多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset ヘッダーを確認してください。