Skip to main content
PATCH
/
connections
/
{id}
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.connections.update("id", {});
}
main();
{
  "name": "My connection",
  "display_name": "<string>",
  "options": {},
  "id": "con_0000000000000001",
  "strategy": "auth0",
  "realms": [
    "<string>"
  ],
  "enabled_clients": [
    "<string>"
  ],
  "is_domain_connection": true,
  "show_as_button": true,
  "metadata": {},
  "authentication": {
    "active": true
  },
  "connected_accounts": {
    "active": true,
    "cross_app_access": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The id of the connection to update

Body

​
display_name
string

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.

Maximum string length: 128
​
options
object

The 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.

​
enabled_clients
string<client-id>[] | null

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

​
is_domain_connection
boolean

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.)

​
show_as_button
boolean

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.)

​
realms
string<connection-realm>[]

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
object

Metadata associated with the connection in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed.

​
authentication
object

Configure the purpose of a connection to be used for authentication during login.

​
connected_accounts
object

Configure the purpose of a connection to be used for connected accounts and Token Vault.

Response

The connection was updated.

​
name
string
default:My connection

The name of the connection

​
display_name
string

Connection name used in login screen

​
options
object

In order to return options in the response, the read:connections_options scope must be present

​
id
string
default:con_0000000000000001

The connection's identifier

​
strategy
string
default:auth0

The type of the connection, related to the identity provider

​
realms
string<connection-realm>[]

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

​
enabled_clients
string[]

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

​
is_domain_connection
boolean

True if the connection is domain level

​
show_as_button
boolean

Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD.

​
metadata
object

Metadata associated with the connection in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed.

​
authentication
object

Configure the purpose of a connection to be used for authentication during login.

​
connected_accounts
object

Configure the purpose of a connection to be used for connected accounts and Token Vault.