Auth0 API

Self Service Profiles

self_service_profiles

Methods

Create A Self Service Profile ->
SelfServiceProfile
post/self-service-profiles

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

Delete A Self Service Profile By ID -> unknown
delete/self-service-profiles/{id}

Deletes a self-service profile by Id.

Get Self Service Profiles -> SelfServiceProfilesPageNumberPage<
SelfServiceProfile
>
get/self-service-profiles

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

Get A Self Service Profile By ID ->
SelfServiceProfile
get/self-service-profiles/{id}

Retrieves a self-service profile by Id.

Update A Self Service Profile ->
SelfServiceProfile
patch/self-service-profiles/{id}

Updates a self-service profile.

Domain types

SelfServiceProfile = { id, allowed_strategies, branding, 5 more... }
Self Service Profiles

Custom Text

self_service_profiles.custom_text

Methods

Get Custom Text For A Self Service Profile -> Record<string, unknown>
get/self-service-profiles/{id}/custom-text/{language}/{page}

Retrieves text customizations for a given self-service profile, language and Self Service SSO Flow page.

Set Custom Text For A Self Service Profile -> Record<string, unknown>
put/self-service-profiles/{id}/custom-text/{language}/{page}

Updates text customizations for a given self-service profile, language and Self Service SSO Flow page.

Self Service Profiles

SSO Ticket

self_service_profiles.sso_ticket

Methods

Create An SSO Access Ticket To Initiate The Self Service SSO Flow ->
SSOAccessTicketResponse
post/self-service-profiles/{id}/sso-ticket

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

Revoke An SSO Access Ticket -> unknown
post/self-service-profiles/{profileId}/sso-ticket/{id}/revoke

Revokes an SSO access ticket and invalidates associated sessions. The ticket will no longer be accepted to initiate a Self-Service SSO 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 time of response. If the specified ticket does not exist, a 202 Accepted response is also returned, signaling that no further action is required. Clients should treat these 202 responses as an acknowledgment that the request has been accepted and is in progress, even if the ticket was not found.

Domain types

SSOAccessTicketResponse = { ticket }