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

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.enabledConnections.update("id", "connectionId", {});
}
main();
{
  "connection_id": "<string>",
  "assign_membership_on_login": true,
  "show_as_button": true,
  "is_signup_enabled": true,
  "connection": {
    "name": "<string>",
    "strategy": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Organization identifier.

Maximum string length: 50
connectionId
string
required

Connection identifier.

Required string length: 1 - 50

Body

assign_membership_on_login
boolean

When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection.

is_signup_enabled
boolean

Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false.

show_as_button
boolean

Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true.

Response

Organization connection successfully updated.

connection_id
string

ID of the connection.

assign_membership_on_login
boolean

When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection.

show_as_button
boolean

Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true.

is_signup_enabled
boolean

Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false.

connection
object