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

Facade for the Auth0 Management API Tickets endpoints.

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

Summary

Types

config()
error()

Functions

create_email_verification(params, config, opts \\ [])

Create an email verification ticket for a given user. An email verification ticket is a generated URL that the user can consume to verify their email address.

create_password_change(params, config, opts \\ [])

Create a password change ticket for a given user. A password change ticket is a generated URL that the user can consume to start a reset password flow.

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_email_verification(params, config, opts \\ [])

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

Create an email verification ticket for a given user. An email verification ticket is a generated URL that the user can consume to verify their email address.

see

https://auth0.com/docs/api/management/v2/tickets/post-email-verification

Link to this function

create_password_change(params, config, opts \\ [])

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

Create a password change ticket for a given user. A password change ticket is a generated URL that the user can consume to start a reset password flow.

see

https://auth0.com/docs/api/management/v2/tickets/post-password-change