View Source Auth0.Management.Connections (Auth0Api v2.2.0)

Summary

Types

config()
error()
id()
token_id()

Functions

create(params, config)

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

create_scim_configuration(id, params, config)

Create a scim configuration for a connection.

create_scim_configuration_tokens(id, params, config)

Create a scim token for a scim client.

delete(id, config)

Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.

delete_scim_configuration(id, config)

Deletes a scim configuration by its connectionId.

delete_scim_configuration_tokens(id, token_id, config)

Deletes a scim token by its connection id and tokenId.

delete_users(id, params, config)

Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.

get(id, params, config)

Retrieve details for a specified connection along with options that can be used for identity provider configuration.

get_scim_configuration(id, config)

Retrieves a scim configuration by its connectionId.

get_scim_configuration_default_mapping(id, config)

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

get_scim_configuration_tokens(id, config)

Retrieves all scim tokens by its connection id.

get_status(id, config)

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

list(params, config)

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.

update(id, params, config)

Update details for a specific connection, including option properties for identity provider configuration.

update_scim_configuration(id, params, config)

Update a scim configuration by its connectionId.

Types

Link to this type

config()

View Source 
@type config() :: Auth0.Config.t()
Link to this type

error()

View Source 
@type error() :: {:error, integer(), term()} | {:error, term()}
Link to this type

id()

View Source 
@type id() :: String.t()
Link to this type

token_id()

View Source 
@type token_id() :: String.t()

Functions

Link to this function

create(params, config)

View Source 
@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_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

Link to this function

delete(id, config)

View Source 
@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_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

Link to this function

get(id, params, config)

View Source 
@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_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

Link to this function

get_status(id, config)

View Source 
@spec get_status(id(), config()) :: {:ok, boolean()} | 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

Link to this function

list(params, config)

View Source 
@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

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_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