Auth0Api v1.4.0

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

Documentation for Auth0 Management API of Jobs.

endpoint

  • /api/v2/jobs/{id}
  • /api/v2/jobs/{id}/errors
  • /api/v2/jobs/users-exports
  • /api/v2/jobs/users-imports
  • /api/v2/jobs/verification-email

Link to this section Summary

Types

config()
error()
id()
response_body()

Functions

create_users_exports(params, config)

Create export users job.

create_users_imports(params, config)

Create import users job.

get(id, config)

Get a job.

get_error(id, config)

Get job error details.

send_verification_email(params, config)

Send an email address verification email.

Link to this section Types

Link to this type

config()

View Source

Specs

config() :: Auth0.Config.t()
Link to this type

error()

View Source

Specs

error() :: {:error, integer(), term()} | {:error, term()}
Link to this type

id()

View Source

Specs

id() :: String.t()
Link to this type

response_body()

View Source

Specs

response_body() :: String.t()

Link to this section Functions

Link to this function

create_users_exports(params, config)

View Source

Specs

create_users_exports(
  Auth0.Management.Jobs.UsersExport.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.JobsUsersExport.t(), response_body()} | error()

Create export users job.

see

https://auth0.com/docs/api/management/v2/#!/Jobs/post_users_exports

Link to this function

create_users_imports(params, config)

View Source

Specs

create_users_imports(
  Auth0.Management.Jobs.UsersImport.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.JobsUsersImport.t(), response_body()} | error()

Create import users job.

see

https://auth0.com/docs/api/management/v2/#!/Jobs/post_users_imports

Link to this function

get(id, config)

View Source

Specs

get(id(), config()) :: {:ok, Auth0.Entity.Jobs.t(), response_body()} | error()

Get a job.

see

https://auth0.com/docs/api/management/v2/#!/Jobs/get_jobs_by_id

Link to this function

get_error(id, config)

View Source

Specs

get_error(id(), config()) ::
  {:ok, Auth0.Entity.JobsErrors.t(), response_body()} | error()

Get job error details.

see

https://auth0.com/docs/api/management/v2/#!/Jobs/get_errors

Link to this function

send_verification_email(params, config)

View Source

Specs

send_verification_email(
  Auth0.Management.Jobs.VerificationEmail.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.JobsVerificationEmail.t(), response_body()} | error()

Send an email address verification email.

see

https://auth0.com/docs/api/management/v2/#!/Jobs/post_verification_email