Retrieve details for a specified connection along with options that can be used for identity provider configuration.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The id of the connection to retrieve
A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields
^((name)|(display_name)|(strategy)|(options)|(id)|(provisioning_ticket_url)|(metadata)|(show_as_button)|(clients)|(authentication)|(connected_accounts)|(cross_app_access_requesting_app)|(cross_app_access_resource_app)|(enabled_clients))(,((name)|(display_name)|(strategy)|(options)|(id)|(provisioning_ticket_url)|(metadata)|(show_as_button)|(clients)|(authentication)|(connected_accounts)|(cross_app_access_requesting_app)|(cross_app_access_resource_app)|(enabled_clients)))*$true if the fields specified are to be included in the result, false otherwise (defaults to true)
The connection was retrieved.
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.