Create a connection
Creates a new connection according to the JSON object received in body.
Note: If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The name of the connection. Must start and end with an alphanumeric character and can only contain alphanumeric characters and '-'. Max length 128
128^[a-zA-Z0-9](-[a-zA-Z0-9]|[a-zA-Z0-9])*$The identity provider identifier for the connection
ad, adfs, amazon, apple, dropbox, bitbucket, aol, auth0-oidc, auth0, baidu, bitly, box, custom, daccount, dwolla, email, evernote-sandbox, evernote, exact, facebook, fitbit, flickr, github, google-apps, google-oauth2, instagram, ip, line, linkedin, miicard, oauth1, oauth2, office365, oidc, okta, paypal, paypal-sandbox, pingfederate, planningcenter, renren, salesforce-community, salesforce-sandbox, salesforce, samlp, sharepoint, shopify, shop, sms, soundcloud, thecity-sandbox, thecity, thirtysevensignals, twitter, untappd, vkontakte, waad, weibo, windowslive, wordpress, yahoo, yammer, yandex Connection name used in the new universal login experience
128The connection's options (depend on the connection strategy)
DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients.
The 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.
Response
The connection was created.
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.