Auth0.Management.Connections (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of Connections.

endpoint

/api/v2/connections
/api/v2/connections/{id}
/api/v2/connections/{id}/status
/api/v2/connections/{id}/users

Link to this section Summary

Types

config()

error()

id()

response_body()

Functions

create(params, config)

Create a connection.

delete(id, config)

Delete a connection.

delete_users(id, params, config)

Delete a connection user.

get(id, params, config)

Get a connection.

get_status(id, config)

Check connection status.

list(params, config)

Get all connections.

update(id, params, config)

Update a connection.

Link to this section Types

config()

Specs

config() :: Auth0.Config.t()

error()

Specs

error() :: {:error, integer(), term()} | {:error, term()}

id()

Specs

id() :: String.t()

response_body()

Specs

response_body() :: String.t()

Link to this section Functions

create(params, config)

Specs

create(Auth0.Management.Connections.Create.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Connection.t(), response_body()} | error()

Create a connection.

see

https://auth0.com/docs/api/management/v2/#!/Connections/post_connections

delete(id, config)

Specs

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

Delete a connection.

see

https://auth0.com/docs/api/management/v2/#!/Connections/delete_connections_by_id

delete_users(id, params, config)

Specs

delete_users(
  id(),
  Auth0.Management.Connections.Users.Delete.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Delete a connection user.

see

https://auth0.com/docs/api/management/v2/#!/Connections/delete_users_by_email

get(id, params, config)

Specs

get(id(), Auth0.Management.Connections.Get.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Connection.t(), response_body()} | error()

Get a connection.

see

https://auth0.com/docs/api/management/v2/#!/Connections/get_connections_by_id

get_status(id, config)

Specs

get_status(id(), config()) :: {:ok, boolean(), response_body()} | error()

Check connection status.

see

https://auth0.com/docs/api/management/v2/#!/Connections/get_status

list(params, config)

Specs

list(Auth0.Management.Connections.List.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Connections.t(), response_body()} | error()

Get all connections.

see

https://auth0.com/docs/api/management/v2/#!/Connections/get_connections

update(id, params, config)

Specs

update(id(), Auth0.Management.Connections.Patch.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Connection.t(), response_body()} | error()

Update a connection.

see

https://auth0.com/docs/api/management/v2/#!/Connections/patch_connections_by_id