View Source Auth0.Management.Flows (Auth0Api v2.5.0)

Facade for the Auth0 Management API Flows endpoints.

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

Summary

Types

config()
error()
id()

Functions

create(params, config)

Create a flow.

create_vault_connection(params, config)

Create a Flows Vault connection.

delete(id, config)

Delete a flow.

delete_execution(flow_id, execution_id, config)

Delete a flow execution.

delete_vault_connection(id, config)

Delete a Flows Vault connection.

get(id, params, config)

Get a flow.

get_execution(flow_id, execution_id, params, config)

Get a flow execution.

get_vault_connection(id, config)

Get a Flows Vault connection.

list(params, config)

Get flows.

list_executions(flow_id, params, config)

Get flow executions.

list_vault_connections(params, config)

Get Flows Vault connection list.

update(id, params, config)

Update a flow.

update_vault_connection(id, params, config)

Update a Flows Vault connection.

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 flow.

see

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

Link to this function

create_vault_connection(params, config)

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

Create a Flows Vault connection.

see

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

Link to this function

delete(id, config)

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

Delete a flow.

see

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

Link to this function

delete_execution(flow_id, execution_id, config)

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

Delete a flow execution.

see

https://auth0.com/docs/api/management/v2/flows/delete-flows-executions-by-execution-id

Link to this function

delete_vault_connection(id, config)

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

Delete a Flows Vault connection.

see

https://auth0.com/docs/api/management/v2/flows/delete-flows-vault-connections-by-id

Link to this function

get(id, params, config)

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

Get a flow.

see

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

Link to this function

get_execution(flow_id, execution_id, params, config)

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

Get a flow execution.

see

https://auth0.com/docs/api/management/v2/flows/get-flows-executions-by-execution-id

Link to this function

get_vault_connection(id, config)

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

Get a Flows Vault connection.

see

https://auth0.com/docs/api/management/v2/flows/get-flows-vault-connections-by-id

Link to this function

list(params, config)

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

Get flows.

see

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

Link to this function

list_executions(flow_id, params, config)

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

Get flow executions.

see

https://auth0.com/docs/api/management/v2/flows/get-flows-executions

Link to this function

list_vault_connections(params, config)

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

Get Flows Vault connection list.

see

https://auth0.com/docs/api/management/v2/flows/get-flows-vault-connections

Link to this function

update(id, params, config)

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

Update a flow.

see

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

Link to this function

update_vault_connection(id, params, config)

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

Update a Flows Vault connection.

see

https://auth0.com/docs/api/management/v2/flows/patch-flows-vault-connections-by-id