View Source Auth0.Management.Connections (Auth0Api v2.5.1)
Facade for the Auth0 Management API Connections endpoints.
Most applications should call Auth0.Api.Management instead of this module.
Summary
Functions
Add synchronized group selections to a directory provisioning configuration.
Creates a new connection according to the JSON object received in body.
Create a directory provisioning configuration.
Request an on-demand synchronization of the directory.
Create connection keys.
Create a scim configuration for a connection.
Create a scim token for a scim client.
Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.
Delete a directory provisioning configuration.
Delete synchronized group selections for a directory provisioning configuration.
Deletes a scim configuration by its connectionId.
Deletes a scim token by its connection id and tokenId.
Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.
Retrieve details for a specified connection along with options that can be used for identity provider configuration.
Get enabled clients for a connection.
Get a directory provisioning configuration.
Get a connection's default directory provisioning attribute mapping.
Get connection keys.
Retrieves a scim configuration by its connectionId.
Retrieves a scim configuration's default mapping by its connectionId.
Retrieves all scim tokens by its connection id.
Retrieves the status of an ad/ldap connection referenced by its ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message
Retrieves detailed list of all connections that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections.
Get synchronized groups for a directory provisioning configuration.
Get a list of directory provisioning configurations.
Get a list of SCIM configurations.
Rotate connection keys.
Create or replace synchronized group selections for a directory provisioning configuration.
Update details for a specific connection, including option properties for identity provider configuration.
Update enabled clients for a connection.
Patch a directory provisioning configuration.
Update a scim configuration by its connectionId.
Types
Functions
add_directory_provisioning_synchronized_groups(id, params, config)
View Source@spec add_directory_provisioning_synchronized_groups(String.t(), map(), config()) :: {:ok, String.t()} | error()
Add synchronized group selections to a directory provisioning configuration.
see
https://auth0.com/docs/api/management/v2/connections/post-synchronized-groups
Creates a new connection according to the JSON object received in body.
see
https://auth0.com/docs/api/management/v2/connections/post-connections
Create a directory provisioning configuration.
Create a directory provisioning configuration for a connection.
see
https://auth0.com/docs/api/management/v2/connections/post-directory-provisioning
Request an on-demand synchronization of the directory.
see
https://auth0.com/docs/api/management/v2/connections/post-synchronizations
Create connection keys.
Provision initial connection keys for Okta or OIDC connection strategies. This endpoint allows you to create keys before configuring the connection to use Private Key JWT authentication, enabling zero-downtime transitions.
see
https://auth0.com/docs/api/management/v2/connections/post-keys
Create a scim configuration for a connection.
see
https://auth0.com/docs/api/management/v2/connections/post-scim-configuration
Create a scim token for a scim client.
see
https://auth0.com/docs/api/management/v2/connections/post-scim-token
Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.
see
https://auth0.com/docs/api/management/v2/connections/delete-connections-by-id
Delete a directory provisioning configuration.
Delete the directory provisioning configuration of a connection.
see
https://auth0.com/docs/api/management/v2/connections/delete-directory-provisioning
delete_directory_provisioning_synchronized_groups(id, params, config)
View Source@spec delete_directory_provisioning_synchronized_groups(String.t(), map(), config()) :: {:ok, String.t()} | error()
Delete synchronized group selections for a directory provisioning configuration.
see
https://auth0.com/docs/api/management/v2/connections/delete-synchronized-groups
Deletes a scim configuration by its connectionId.
see
https://auth0.com/docs/api/management/v2/connections/delete-scim-configuration
Deletes a scim token by its connection id and tokenId.
see
https://auth0.com/docs/api/management/v2/connections/delete-tokens-by-token-id
Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.
see
https://auth0.com/docs/api/management/v2/connections/delete-users-by-email
Retrieve details for a specified connection along with options that can be used for identity provider configuration.
see
https://auth0.com/docs/api/management/v2/connections/get-connections-by-id
Get enabled clients for a connection.
Retrieve all clients that have the specified connection enabled.
see
https://auth0.com/docs/api/management/v2/connections/get-connection-clients
Get a directory provisioning configuration.
Retrieve the directory provisioning configuration of a connection.
see
https://auth0.com/docs/api/management/v2/connections/get-directory-provisioning
Get a connection's default directory provisioning attribute mapping.
Retrieve the directory provisioning default attribute mapping of a connection.
see
https://auth0.com/docs/api/management/v2/connections/get-directory-provisioning-default-mapping
Get connection keys.
Gets the connection keys for the Okta or OIDC connection strategy.
see
https://auth0.com/docs/api/management/v2/connections/get-keys
Retrieves a scim configuration by its connectionId.
see
https://auth0.com/docs/api/management/v2/connections/get-scim-configuration
Retrieves a scim configuration's default mapping by its connectionId.
see
https://auth0.com/docs/api/management/v2/connections/get-default-mapping
Retrieves all scim tokens by its connection id.
see
https://auth0.com/docs/api/management/v2/connections/get-scim-tokens
Retrieves the status of an ad/ldap connection referenced by its ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message
see
https://auth0.com/docs/api/management/v2/connections/get-status
Retrieves detailed list of all connections that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections.
see
https://auth0.com/docs/api/management/v2/connections/get-connections
list_directory_provisioning_synchronized_groups(id, params, config)
View Source@spec list_directory_provisioning_synchronized_groups(String.t(), map(), config()) :: {:ok, map()} | error()
Get synchronized groups for a directory provisioning configuration.
Retrieve the configured synchronized groups for a connection directory provisioning configuration.
see
https://auth0.com/docs/api/management/v2/connections/get-synchronized-groups
Get a list of directory provisioning configurations.
Retrieve a list of directory provisioning configurations of a tenant.
see
Get a list of SCIM configurations.
Retrieve a list of SCIM configurations of a tenant.
see
Rotate connection keys.
Rotates the connection keys for the Okta or OIDC connection strategies.
see
https://auth0.com/docs/api/management/v2/connections/post-rotate
set_directory_provisioning_synchronized_groups(id, params, config)
View Source@spec set_directory_provisioning_synchronized_groups(String.t(), map(), config()) :: {:ok, String.t()} | error()
Create or replace synchronized group selections for a directory provisioning configuration.
Create or replace the selected groups for a connection directory provisioning configuration.
see
https://auth0.com/docs/api/management/v2/connections/put-synchronized-groups
Update details for a specific connection, including option properties for identity provider configuration.
see
https://auth0.com/docs/api/management/v2/connections/patch-connections-by-id
Update enabled clients for a connection.
see
https://auth0.com/docs/api/management/v2/connections/patch-clients
Patch a directory provisioning configuration.
Update the directory provisioning configuration of a connection.
see
https://auth0.com/docs/api/management/v2/connections/patch-directory-provisioning
Update a scim configuration by its connectionId.
see
https://auth0.com/docs/api/management/v2/connections/patch-scim-configuration