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

Facade for the Auth0 Management API Rules endpoints.

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

Deprecated: Auth0 Rules are deprecated (end of life announced by Auth0). Migrate to Actions (Auth0.Management.Actions). The corresponding Auth0.Api.Management functions are marked with @deprecated.

Summary

Types

config()

error()

id()

Functions

create(params, config)

Create a new rule.

delete(id, config)

Delete a rule.

get(id, params, config)

Retrieve rule details. Accepts a list of fields to include or exclude in the result.

list(params, config)

Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.

update(id, params, config)

Update an existing rule.

Types

config()

@type config() :: Auth0.Config.t()

error()

@type error() :: {:error, integer(), term()} | {:error, term()}

id()

@type id() :: String.t()

Functions

create(params, config)

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

Create a new rule.

see

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

delete(id, config)

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

Delete a rule.

see

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

get(id, params, config)

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

Retrieve rule details. Accepts a list of fields to include or exclude in the result.

see

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

list(params, config)

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

Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.

see

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

update(id, params, config)

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

Update an existing rule.

see

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