Passer au contenu principal
POST
/
organizations
/
{id}
/
enabled_connections
TypeScript
import { ManagementClient } from "auth0";

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

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

id
string
requis

Organization identifier.

Maximum string length: 50

Corps

connection_id
string<connection-id>
requis

Single connection ID to add to the organization.

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.

Réponse

Organization connection successfully added.

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