Update a connection
Update details for a specific connection, including option properties for identity provider configuration.
Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
パスパラメータ
The id of the connection to update
ボディ
The connection name used in the new universal login experience. If display_name is not included in the request, the field will be overwritten with the name value.
128The connection's options (depend on the connection strategy). To update these options, the update:connections_options scope must be present. To verify your changes, also include the read:connections_options scope. If this scope is not specified, you will not be able to review the updated object.
DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable or disable the connection for any clients.
The client_id of the client to for which the connection is to be enabled
true promotes to a domain-level connection so that third-party applications can use it. false does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to false.)
Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to false.)
Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm.
The realm where this connection belongs
Metadata associated with the connection in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed.
Configure the purpose of a connection to be used for authentication during login.
Configure the purpose of a connection to be used for connected accounts and Token Vault.
レスポンス
The connection was updated.
The name of the connection
Connection name used in login screen
In order to return options in the response, the read:connections_options scope must be present
The connection's identifier
The type of the connection, related to the identity provider
Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm.
The realm where this connection belongs
DEPRECATED property. Use the GET /connections/:id/clients endpoint to get the ids of the clients for which the connection is enabled
The client id
True if the connection is domain level
Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD.
Metadata associated with the connection in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed.
Configure the purpose of a connection to be used for authentication during login.
Configure the purpose of a connection to be used for connected accounts and Token Vault.