docs/classes/management.SDK.EnabledConnectionsClient.html
new EnabledConnectionsClient(
options: BaseClientOptions,
): EnabledConnectionsClient
list(
id: string,
request?: ListOrganizationConnectionsRequestParameters,
requestOptions?: EnabledConnectionsClient.RequestOptions,
): Promise<
Page<
OrganizationConnection,
ListOrganizationConnectionsOffsetPaginatedResponseContent,
>,
>
Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.
Organization identifier.
OptionalrequestOptions: EnabledConnectionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.enabledConnections.list("id", { page: 1, per_page: 1, include_totals: true })Copy
add(
id: string,
request: AddOrganizationConnectionRequestContent,
requestOptions?: EnabledConnectionsClient.RequestOptions,
): HttpResponsePromise<AddOrganizationConnectionResponseContent>
Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.
Connections represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.
Organization identifier.
OptionalrequestOptions: EnabledConnectionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.enabledConnections.add("id", { connection_id: "connection_id" })Copy
get(
id: string,
connectionId: string,
requestOptions?: EnabledConnectionsClient.RequestOptions,
): HttpResponsePromise<GetOrganizationConnectionResponseContent>
Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.
Organization identifier.
Connection identifier.
OptionalrequestOptions: EnabledConnectionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.enabledConnections.get("id", "connectionId")Copy
delete(
id: string,
connectionId: string,
requestOptions?: EnabledConnectionsClient.RequestOptions,
): HttpResponsePromise<void>
Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate.
Note : This action does not remove the connection from your tenant.
Organization identifier.
Connection identifier.
OptionalrequestOptions: EnabledConnectionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.enabledConnections.delete("id", "connectionId")Copy
update(
id: string,
connectionId: string,
request?: UpdateOrganizationConnectionRequestContent,
requestOptions?: EnabledConnectionsClient.RequestOptions,
): HttpResponsePromise<UpdateOrganizationConnectionResponseContent>
Modify the details of a specific connection currently enabled for an Organization.
Organization identifier.
Connection identifier.
OptionalrequestOptions: EnabledConnectionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.enabledConnections.update("id", "connectionId")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listaddgetdeleteupdate Properties _options