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

Documentation for Auth0 Management API of Rules.

endpoint

/api/v2/rules
/api/v2/rules/{id}

Link to this section Summary

Types

config()

error()

id()

response_body()

Functions

create(params, config)

Create a rule.

delete(id, config)

Delete a rule.

get(id, params, config)

Get a rule.

list(params, config)

Get rules.

update(id, params, config)

Update a rule.

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.Rules.Create.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Rule.t(), response_body()} | error()

Create a rule.

see

https://auth0.com/docs/api/management/v2/#!/Rules/post_rules

delete(id, config)

Specs

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

Delete a rule.

see

https://auth0.com/docs/api/management/v2/#!/Rules/delete_rules_by_id

get(id, params, config)

Specs

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

Get a rule.

see

https://auth0.com/docs/api/management/v2/#!/Rules/get_rules_by_id

list(params, config)

Specs

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

Get rules.

see

https://auth0.com/docs/api/management/v2/#!/Rules/get_rules

update(id, params, config)

Specs

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

Update a rule.

see

https://auth0.com/docs/api/management/v2/#!/Rules/patch_rules_by_id