View Source Auth0.Management.Jobs (Auth0Api v2.2.0)

Summary

Functions

Export all users to a file via a long-running job.

Import users from a formatted file into a connection via a long-running job.

Retrieves a job. Useful to check its status.

Retrieve error details of a failed job.

Send an email to the specified user that asks them to click a link to verify their email address.

Types

@type config() :: Auth0.Config.t()
@type error() :: {:error, integer(), term()} | {:error, term()}
@type id() :: String.t()

Functions

Link to this function

create_users_exports(params, config)

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

Export all users to a file via a long-running job.

see

https://auth0.com/docs/api/management/v2/jobs/post-users-exports

Link to this function

create_users_imports(params, config)

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

Import users from a formatted file into a connection via a long-running job.

see

https://auth0.com/docs/api/management/v2/jobs/post-users-imports

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

Retrieves a job. Useful to check its status.

see

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

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

Retrieve error details of a failed job.

see

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

Link to this function

send_verification_email(params, config)

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

Send an email to the specified user that asks them to click a link to verify their email address.

see

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