Auth0Api v1.4.0

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

Documentation for Auth0 Management API of Actions.

endpoint

  • /api/v2/actions/actions
  • /api/v2/actions/status
  • /api/v2/actions/triggers
  • /api/v2/actions/actions/{id}
  • /api/v2/actions/executions/{id}
  • /api/v2/actions/actions/{actionId}/versions
  • /api/v2/actions/triggers/{triggerId}/bindings
  • /api/v2/actions/actions/{actionId}/versions/{id}
  • /api/v2/actions/actions/{id}/test
  • /api/v2/actions/actions/{id}/deploy
  • /api/v2/actions/actions/{actionId}/versions/{id}/deploy

Link to this section Summary

Types

action_id()
config()
error()
id()
response_body()
trigger_id()

Functions

create(params, config)

Create an action.

delete(id, params, config)

Delete an action.

deploy(id, config)

Deploy an action.

get(id, config)

Get an action.

get_bindings(trigger_id, params, config)

Get trigger bindings.

get_execution(id, config)

Get an execution.

get_status(config)

Get actions service status.

get_triggers(config)

Get triggers.

get_version(action_id, id, config)

Get a specific version of an action.

list(params, config)

Get actions.

list_versions(action_id, params, config)

Get an action's versions.

rollback_version(action_id, id, params, config)

Roll back to a previous action version.

test(id, params, config)

Test an Action.

update(id, params, config)

Update an action.

update_bindings(trigger_id, params, config)

Update trigger bindings.

Link to this section Types

Link to this type

action_id()

View Source

Specs

action_id() :: String.t()
Link to this type

config()

View Source

Specs

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

error()

View Source

Specs

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

id()

View Source

Specs

id() :: String.t()
Link to this type

response_body()

View Source

Specs

response_body() :: String.t()
Link to this type

trigger_id()

View Source

Specs

trigger_id() :: String.t()

Link to this section Functions

Link to this function

create(params, config)

View Source

Specs

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

Create an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/post_action

Link to this function

delete(id, params, config)

View Source

Specs

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

Delete an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/delete_action

Link to this function

deploy(id, config)

View Source

Specs

deploy(id(), config()) ::
  {:ok, Auth0.Entity.ActionVersion.t(), response_body()} | error()

Deploy an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/post_deploy_action

Link to this function

get(id, config)

View Source

Specs

get(id(), config()) :: {:ok, Auth0.Entity.Action.t(), response_body()} | error()

Get an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_action

Link to this function

get_bindings(trigger_id, params, config)

View Source

Specs

get_bindings(
  trigger_id(),
  Auth0.Management.Actions.Triggers.Bindings.List.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.ActionTriggerBindings.t(), response_body()} | error()

Get trigger bindings.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_bindings

Link to this function

get_execution(id, config)

View Source

Specs

get_execution(id(), config()) ::
  {:ok, Auth0.Entity.ActionExecution.t(), response_body()} | error()

Get an execution.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_execution

Link to this function

get_status(config)

View Source

Specs

get_status(config()) ::
  {:ok, Auth0.Entity.ActionStatus.t(), response_body()} | error()

Get actions service status.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_service_status

Link to this function

get_triggers(config)

View Source

Specs

get_triggers(config()) ::
  {:ok, Auth0.Entity.ActionTriggers.t(), response_body()} | error()

Get triggers.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_triggers

Link to this function

get_version(action_id, id, config)

View Source

Specs

get_version(action_id(), id(), config()) ::
  {:ok, Auth0.Entity.ActionVersion.t(), response_body()} | error()

Get a specific version of an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_action_version

Link to this function

list(params, config)

View Source

Specs

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

Get actions.

see

https://auth0.com/docs/api/management/v2/#!/Actions/get_actions

Link to this function

list_versions(action_id, params, config)

View Source

Specs

list_versions(
  action_id(),
  Auth0.Management.Actions.Versions.List.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.ActionVersions.t(), response_body()} | error()

Get an action's versions.

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

Specs

rollback_version(
  action_id(),
  id(),
  Auth0.Management.Actions.Versions.Rollback.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.ActionVersion.t(), response_body()} | error()

Roll back to a previous action version.

see

https://auth0.com/docs/api/management/v2/#!/Actions/post_deploy_draft_version

Link to this function

test(id, params, config)

View Source

Specs

test(id(), Auth0.Management.Actions.Test.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.ActionTest.t(), response_body()} | error()

Test an Action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/post_test_action

Link to this function

update(id, params, config)

View Source

Specs

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

Update an action.

see

https://auth0.com/docs/api/management/v2/#!/Actions/patch_action

Link to this function

update_bindings(trigger_id, params, config)

View Source

Specs

update_bindings(
  trigger_id(),
  Auth0.Management.Actions.Triggers.Bindings.Patch.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.ActionTriggerBindings.t(), response_body()} | error()

Update trigger bindings.

see

https://auth0.com/docs/api/management/v2/#!/Actions/patch_bindings