Connection Profile

Connection Profile を使用して、サードパーティが Auth0 接続を作成する際に、その非公開設定をどのように構成するかを指定します。

Auth0 では、Okta、Microsoft Entra ID、Google Workspace などの外部フェデレーテッド ID プロバイダー (IdP) でユーザーを認証するためのエンタープライズ接続を提供しています。構成済みの接続には、外部 IdP とのシングルサインオン (SSO) 、ユーザープロビジョニング、logout 連携のためのプロトコル固有の設定に加え、その接続が Auth0 の Universal Login や Organizations 機能とどのように連携するかを制御する非公開設定が含まれます。

Connection Profile (CP) を使用すると、サードパーティが Auth0 接続を作成する際に、その非公開設定をどのように構成すべきかを Auth0 開発者が指定できます。

​

仕組み

• プロファイル定義: 管理者は Connection Profile を作成し、Auth0 の delegated administration 機能のいずれかを使って接続が作成されるたびに、その接続に書き込むプロパティ値を定義します。

• 柔軟な適用範囲: 現在、プロファイルは Self-Service Enterprise Configuration と Okta Express Configuration のフローにリンクされていますが、より幅広く再利用できるように設計されており、プロビジョニング、オンボーディング、権限管理、さらに今後の Auth0 の機能にも対応します。

​

Connection Profile のプロパティ

Connection Profile は JSON オブジェクトで、設定可能な以下のプロパティをサポートしており、新しく作成されるすべての接続に適用されます。

プロパティ	説明
connection_name_prefix_template	接続名に使用する必要がある接頭辞を表します。接続の name パラメーターに対応します。この値では、組織ID と organization名 の変数置換をサポートします。最終的な接頭辞を生成するには、OIN ワークフローでこれらの値を置換する必要があります。変数は中かっこ () で囲みます。 サポート対象の変数: org_id: 組織ID org_name: organization名 例: con-{org_id}-
enabled_features	このリストでは、設定された接続でサポートされる機能を指定します。リストに含まれていない機能は使用できません。 サポート対象の値: scim: これが含まれている場合、接続で SCIM を設定できます。 universal_logout: これが含まれている場合、この接続で Universal Logout 機能を使用できます。
organization.assign_membership_on_login	ログイン時に、ユーザーに organization のメンバーシップを自動的に割り当てるかどうかを指定します。これは、organization の enabled_connections サブリソースの assign_membership_on_login プロパティに対応します。 Okta 向けの Express Configuration 連携では、optional は required として扱われます

Connection Profile の値	Enable Connectionsassign_membership_on_loginValue
none	false
optional	false
required	true
organization	接続の作成先となる organization に適用される設定を含むオブジェクト。
organization.show_as_button	organization の選択後に、その接続をログイン画面上でボタンとして表示するかどうかを指定します。これは、有効になっている接続の show_as_button 値に対応します。

Connection Profile の値	接続 show_as_button の値
none	false
optional	true
required	true

​

Connection Profile の例

{
  "organization": {
    "show_as_button": "none",
    "assign_membership_on_login": "none"
  },
  "connection_name_prefix_template": "ec-{org_id}-",
  "enabled_features": [
    "scim",
    "universal_logout"
  ]
}

​

Connection Profile の作成と管理

Okta で Express Configuration 機能を使用すると、Connection Profile が自動的に自動生成されます。また、Auth0 Management API を使用して Connection Profile を作成および管理することもできます。

​

Management API で設定する

Management API を使用するには、Management API アクセストークンを取得する必要があります。Connection Profile を管理するには、次の Management API エンドポイントを使用できます。

• POST /api/v2/connection-profiles
• GET /api/v2/connection-profiles
• PATCH /api/v2/connection-profiles/{id}
• GET /api/v2/connection-profiles/{id}
• GET /api/v2/connection-profiles/templates

​

詳しく見る

• Express Configuration
• Management API を使用したユーザー管理