View Source Auth0.Management.RateLimitPolicies (Auth0Api v2.5.1)

Facade for the Auth0 Management API Rate limit policies (Early Access).

Summary

Types

config()
error()

Functions

create(params, config)

Create a rate limit policy.

delete(id, config)

Delete a rate limit policy.

get(id, config)

Get a rate limit policy.

list(params, config)

Get rate limit policies.

update(id, params, config)

Update a rate limit policy.

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()}

Functions

Link to this function

create(params, config)

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

Create a rate limit policy.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/rate-limit-policies/post-rate-limit-policies

Link to this function

delete(id, config)

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

Delete a rate limit policy.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/rate-limit-policies/delete-rate-limit-policies-by-id

Link to this function

get(id, config)

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

Get a rate limit policy.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/rate-limit-policies/get-rate-limit-policies-by-id

Link to this function

list(params, config)

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

Get rate limit policies.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/rate-limit-policies/get-rate-limit-policies

Link to this function

update(id, params, config)

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

Update a rate limit policy.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/rate-limit-policies/patch-rate-limit-policies-by-id