Skip to main content
PATCH
Go

承認

Authorization
string
header
必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id
string
必須

更新する接続の id

ボディ

authentication
object
GA

ログイン時の認証で使用する接続の用途を設定します。

connected_accounts
object
GA

接続済みアカウントおよび Token Vault で使用する接続の用途を設定します。

display_name
string

新しい Universal Login エクスペリエンスで使用される接続名です。リクエストに display_name が含まれていない場合、このフィールドは name の値で上書きされます。

Maximum string length: 128
enabled_clients
string<client-id>[] | null
deprecated

非推奨のプロパティです。任意のクライアントに対して接続を有効または無効にするには、PATCH /v2/connections/{id}/clients エンドポイントを使用してください。

接続を有効にする対象クライアントの client_id です

is_domain_connection
boolean

true の場合、サードパーティアプリケーションが使用できるようにドメインレベルの接続に昇格されます。false の場合、接続は昇格されないため、その接続が有効になっているファーストパーティアプリケーションのみが使用できます。(既定値は false です。)

metadata
object

文字列値(最大 255 文字)を持つオブジェクト形式の、接続に関連付けられたメタデータ。メタデータのプロパティは最大 10 個まで指定できます。

options
object | null

接続のオプションです(接続戦略によって異なります)。これらのオプションを更新するには、update:connections_options スコープが必要です。変更内容を確認するには、read:connections_options スコープも含めてください。このスコープを指定しない場合、更新後のオブジェクトを確認できません。

realms
string<connection-realm>[]

この接続に使用されるレルム(例: メールドメイン)を定義します。配列が空、またはこのプロパティが指定されていない場合は、接続名がレルムとして追加されます。

この接続が属するレルムです

show_as_button
boolean

ログインページにこの接続のボタンを表示できるようにします(新しいエクスペリエンスのみ)。false の場合は、HRD でのみ使用できます。(既定値は false です。)

レスポンス

接続を更新しました。

authentication
object
GA

ログイン時の認証で使用する接続の用途を設定します。

connected_accounts
object
GA

接続済みアカウントおよび Token Vault で使用する接続の用途を設定します。

display_name
string

ログイン画面で使用される接続名

enabled_clients
string[]
deprecated

非推奨のプロパティです。接続が有効になっているクライアントの id を取得するには、GET /connections/:id/clients エンドポイントを使用してください

クライアントID

id
string
デフォルト:con_0000000000000001

接続の識別子

is_domain_connection
boolean

この接続がドメインレベルの場合は true

metadata
object

文字列値(最大 255 文字)を持つオブジェクト形式の、接続に関連付けられたメタデータ。メタデータのプロパティは最大 10 個まで指定できます。

name
string
デフォルト:My connection

接続名

options
object

レスポンスで options を返すには、read:connections_options スコープが含まれている必要があります

realms
string<connection-realm>[]

接続で使用するレルム(例: メールドメイン)を定義します。配列が空の場合、またはこのプロパティが指定されていない場合は、接続名がレルムとして追加されます。

この接続が属するレルム

show_as_button
boolean

ログインページにこの接続のボタンを表示できるようにします(新しいエクスペリエンスのみ)。false の場合は、HRD でのみ使用できます。

strategy
string
デフォルト:auth0

IDプロバイダーに関連付けられた接続の種類