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

Summary

Functions

Create an action. Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.

Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.

Deploy an action. Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately. Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.

Retrieve an action by its ID.

Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow.

Retrieve information about a specific execution of a trigger. Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.

Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound.

Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.

Retrieve all actions.

Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created.

Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.

Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.

Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.

Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed.

Types

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

Functions

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

Create an action. Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.

see

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

Link to this function

delete(id, params, config)

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

Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.

see

https://auth0.com/docs/api/management/v2/actions/delete-action

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

Deploy an action. Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately. Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.

see

https://auth0.com/docs/api/management/v2/actions/post-deploy-action

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

Retrieve an action by its ID.

see

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

Link to this function

get_bindings(trigger_id, params, config)

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

Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow.

see

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

Link to this function

get_execution(id, config)

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

Retrieve information about a specific execution of a trigger. Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.

see

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

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

Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound.

see

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

Link to this function

get_version(action_id, id, config)

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

Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.

see

https://auth0.com/docs/api/management/v2/actions/get-action-version

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

Retrieve all actions.

see

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

Link to this function

list_versions(action_id, params, config)

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

Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created.

see

https://auth0.com/docs/api/management/v2/actions/get-action-versions

Link to this function

rollback_version(action_id, id, params, config)

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

Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.

see

https://auth0.com/docs/api/management/v2/actions/post-deploy-draft-version

Link to this function

test(id, params, config)

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

Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.

see

https://auth0.com/docs/api/management/v2/actions/post-test-action

Link to this function

update(id, params, config)

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

Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.

see

https://auth0.com/docs/api/management/v2/actions/patch-action

Link to this function

update_bindings(trigger_id, params, config)

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

Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed.

see

https://auth0.com/docs/api/management/v2/actions/patch-bindings