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

Facade for the Auth0 Management API Self Service Profiles endpoints.

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

Summary

Functions

Creates a self-service profile. Currently only one profile can be created per tenant.

Creates an sso-access ticket to initiate the Self Service SSO Flow using a self-service profile.

Deletes a self-service profile by Id.

Retrieves a self-service profile by Id.

Get custom text for a self-service profile.

Retrieves self-service profiles. Currently only one profile can be created per tenant.

Revoke a Self-Service Enterprise Configuration access ticket.

Set custom text for a self-service profile.

Updates a self-service profile.

Types

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

Functions

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

Creates a self-service profile. Currently only one profile can be created per tenant.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/post-self-service-profiles

Link to this function

create_sso_ticket(id, params, config, opts \\ [])

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

Creates an sso-access ticket to initiate the Self Service SSO Flow using a self-service profile.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/post-sso-ticket

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

Deletes a self-service profile by Id.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/delete-self-service-profiles-by-id

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

Retrieves a self-service profile by Id.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/get-self-service-profiles-by-id

Link to this function

get_custom_text(id, language, page, config)

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

Get custom text for a self-service profile.

Retrieves text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/get-self-service-profile-custom-text

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

Retrieves self-service profiles. Currently only one profile can be created per tenant.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/get-self-service-profiles

Link to this function

revoke_sso_ticket(profile_id, id, config)

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

Revoke a Self-Service Enterprise Configuration access ticket.

Revokes a Self-Service Enterprise Configuration access ticket and invalidates associated sessions. The ticket will no longer be accepted to initiate a Self-Service Enterprise Configuration session. If any users have already started a session through this ticket, their session will be terminated. Clients should expect a 202 Accepted response upon successful processing, indicating that the request has been acknowledged and that the revocation is underway but may not be fully completed at the ...

see

https://auth0.com/docs/api/management/v2/self-service-profiles/post-revoke

Link to this function

set_custom_text(id, language, page, params, config)

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

Set custom text for a self-service profile.

Updates text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/put-self-service-profile-custom-text

Link to this function

update(id, params, config)

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

Updates a self-service profile.

see

https://auth0.com/docs/api/management/v2/self-service-profiles/patch-self-service-profiles-by-id