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

@type config() :: Auth0.Config.t()
@type error() :: {:error, integer(), term()} | {:error, term()}
@type id() :: String.t()
@type token_id() :: String.t()

Functions

Link to this function

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

@spec create(map(), config()) :: {:ok, map()} | error()

Creates a new connection according to the JSON object received in body.

see

https://auth0.com/docs/api/management/v2/connections/post-connections

Link to this function

create_directory_provisioning(id, params, config)

View Source
@spec create_directory_provisioning(String.t(), map(), config()) ::
  {:ok, map()} | error()

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

Link to this function

create_directory_provisioning_synchronization(id, config)

View Source
@spec create_directory_provisioning_synchronization(String.t(), config()) ::
  {:ok, map()} | error()

Request an on-demand synchronization of the directory.

see

https://auth0.com/docs/api/management/v2/connections/post-synchronizations

Link to this function

create_keys(id, params, config)

View Source
@spec create_keys(String.t(), map(), config()) :: {:ok, [map()]} | error()

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

Link to this function

create_scim_configuration(id, params, config)

View Source
@spec create_scim_configuration(id(), map(), config()) :: {:ok, map()} | error()

Create a scim configuration for a connection.

see

https://auth0.com/docs/api/management/v2/connections/post-scim-configuration

Link to this function

create_scim_configuration_tokens(id, params, config)

View Source
@spec create_scim_configuration_tokens(id(), map(), config()) ::
  {:ok, map()} | error()

Create a scim token for a scim client.

see

https://auth0.com/docs/api/management/v2/connections/post-scim-token

@spec delete(id(), config()) :: {:ok, String.t()} | error()

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

Link to this function

delete_directory_provisioning(id, config)

View Source
@spec delete_directory_provisioning(String.t(), config()) ::
  {:ok, String.t()} | error()

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

Link to this function

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

Link to this function

delete_scim_configuration(id, config)

View Source
@spec delete_scim_configuration(id(), config()) :: {:ok, String.t()} | error()

Deletes a scim configuration by its connectionId.

see

https://auth0.com/docs/api/management/v2/connections/delete-scim-configuration

Link to this function

delete_scim_configuration_tokens(id, token_id, config)

View Source
@spec delete_scim_configuration_tokens(id(), token_id(), config()) ::
  {:ok, String.t()} | error()

Deletes a scim token by its connection id and tokenId.

see

https://auth0.com/docs/api/management/v2/connections/delete-tokens-by-token-id

Link to this function

delete_users(id, params, config)

View Source
@spec delete_users(id(), map(), config()) :: {:ok, String.t()} | error()

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

@spec get(id(), map(), config()) :: {:ok, map()} | error()

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

Link to this function

get_clients(id, params, config)

View Source
@spec get_clients(String.t(), map(), config()) :: {:ok, map()} | error()

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

Link to this function

get_directory_provisioning(id, config)

View Source
@spec get_directory_provisioning(String.t(), config()) :: {:ok, map()} | error()

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

Link to this function

get_directory_provisioning_default_mapping(id, config)

View Source
@spec get_directory_provisioning_default_mapping(String.t(), config()) ::
  {:ok, map()} | error()

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

@spec get_keys(String.t(), config()) :: {:ok, [map()]} | error()

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

Link to this function

get_scim_configuration(id, config)

View Source
@spec get_scim_configuration(id(), config()) :: {:ok, map()} | error()

Retrieves a scim configuration by its connectionId.

see

https://auth0.com/docs/api/management/v2/connections/get-scim-configuration

Link to this function

get_scim_configuration_default_mapping(id, config)

View Source
@spec get_scim_configuration_default_mapping(id(), config()) :: {:ok, map()} | error()

Retrieves a scim configuration's default mapping by its connectionId.

see

https://auth0.com/docs/api/management/v2/connections/get-default-mapping

Link to this function

get_scim_configuration_tokens(id, config)

View Source
@spec get_scim_configuration_tokens(id(), config()) :: {:ok, [map()]} | error()

Retrieves all scim tokens by its connection id.

see

https://auth0.com/docs/api/management/v2/connections/get-scim-tokens

@spec get_status(id(), config()) :: {:ok, true} | error()

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

@spec list(map(), config()) :: {:ok, [map()] | map()} | error()

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

Link to this function

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

Link to this function

list_directory_provisionings(params, config)

View Source
@spec list_directory_provisionings(map(), config()) :: {:ok, map()} | error()

Get a list of directory provisioning configurations.

Retrieve a list of directory provisioning configurations of a tenant.

see

https://auth0.com/docs/api/management/v2/connections-directory-provisionings/get-connections-directory-provisionings

Link to this function

list_scim_configurations(params, config)

View Source
@spec list_scim_configurations(map(), config()) :: {:ok, map()} | error()

Get a list of SCIM configurations.

Retrieve a list of SCIM configurations of a tenant.

see

https://auth0.com/docs/api/management/v2/connections-scim-configurations/get-connections-scim-configurations

Link to this function

rotate_keys(id, params, config)

View Source
@spec rotate_keys(String.t(), map(), config()) :: {:ok, map()} | error()

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

Link to this function

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

Link to this function

update(id, params, config)

View Source
@spec update(id(), map(), config()) :: {:ok, map()} | error()

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

Link to this function

update_clients(id, params, config)

View Source
@spec update_clients(String.t(), [map()], config()) :: {:ok, String.t()} | error()

Update enabled clients for a connection.

see

https://auth0.com/docs/api/management/v2/connections/patch-clients

Link to this function

update_directory_provisioning(id, params, config)

View Source
@spec update_directory_provisioning(String.t(), map(), config()) ::
  {:ok, map()} | error()

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

Link to this function

update_scim_configuration(id, params, config)

View Source
@spec update_scim_configuration(id(), map(), config()) :: {:ok, map()} | error()

Update a scim configuration by its connectionId.

see

https://auth0.com/docs/api/management/v2/connections/patch-scim-configuration