接続プロファイル

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

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

接続プロファイル (CP) を使用すると、サードパーティが作成する際の Auth0 接続の非公開設定をどのように構成するかを Auth0 開発者が指定できます

​

仕組み

• プロファイル定義: 管理者は接続プロファイルを作成し、Auth0 の委任管理機能のいずれかを使用して接続が作成される際に、その接続に書き込まれるプロパティ値を定義します。

• 柔軟なスコープ: 現在、プロファイルは Self-Service Enterprise Configuration フローおよび Okta Express Configuration フローに関連付けられていますが、プロビジョニング、オンボーディング、エンタイトルメント管理、さらに将来の Auth0 の機能にも対応できるよう、より幅広く再利用できる設計になっています。

​

接続プロファイルのプロパティ

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

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

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

接続プロファイルの値	接続の show_as_button 値
none	false
optional	true
required	true

​

接続プロファイルの例

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

​

接続プロファイルの作成と管理

接続プロファイルは、Okta で Express Configuration 機能を使用すると、自動的に生成されます。また、Auth0 Management API を使用して接続プロファイルを作成および管理できます。

​

Management API で設定する

Management API を使用するには、Management API のアクセストークンを取得する必要があります。接続プロファイルを管理するために、次の 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 を使用したユーザー管理