View Source Auth0.Management.ConnectionProfiles (Auth0Api v2.5.1)

Facade for the Auth0 Management API Connection Profiles endpoints.

Most applications should call Auth0.Api.Management instead of this module.

Summary

Types

config()
error()
id()

Functions

create(params, config)

Create a connection profile.

delete(id, config)

Delete Connection Profile.

get(id, config)

Retrieve a connection profile by its ID.

get_template(id, config)

Get Connection Profile Template.

list(params, config)

Retrieve a list of connection profiles.

list_templates(config)

Get Connection Profile Templates.

update(id, params, config)

Update a connection profile.

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()

Functions

Link to this function

create(params, config)

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

Create a connection profile.

Create a Connection Profile.

see

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

Link to this function

delete(id, config)

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

Delete Connection Profile.

Delete a single Connection Profile specified by ID.

see

https://auth0.com/docs/api/management/v2/connection-profiles/delete-connection-profiles-by-id

Link to this function

get(id, config)

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

Retrieve a connection profile by its ID.

see

https://auth0.com/docs/api/management/v2/connection-profiles/get-connection-profiles-by-id

Link to this function

get_template(id, config)

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

Get Connection Profile Template.

Retrieve a Connection Profile Template.

see

https://auth0.com/docs/api/management/v2/connection-profiles/get-connection-profile-template

Link to this function

list(params, config)

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

Retrieve a list of connection profiles.

see

https://auth0.com/docs/api/management/v2/connection-profiles/get-connection-profiles

Link to this function

list_templates(config)

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

Get Connection Profile Templates.

Retrieve a list of Connection Profile Templates.

see

https://auth0.com/docs/api/management/v2/connection-profiles/get-connection-profile-templates

Link to this function

update(id, params, config)

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

Update a connection profile.

see

https://auth0.com/docs/api/management/v2/connection-profiles/patch-connection-profiles-by-id