How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Auth0 self-service-profiles API

The self-service-profiles API from Auth0 — 5 operation(s) for self-service-profiles.

Auth0 self-service-profiles API is one of 76 APIs that Auth0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include self-service-profiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 9 operations across 5 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{tenantDomain}/api/v2.

9 operations 5 paths 34 schemas 1 DELETE3 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://your-tenant.auth0.com/api/v2
Authentication
HTTP Bearer, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Auth0 self-service-profiles API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (jwt) (bearerAuth). It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 221 scopes. By default, every request must be authenticated.

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

self-service-profiles 9
GET
/self-service-profiles
Get Self-service Profiles
get_self-service-profiles 3 params → 200401403429500
POST
/self-service-profiles
Create a Self-service Profile
post_self-service-profiles body → 201400401403409429500
GET
/self-service-profiles/{id}
Get a Self-service Profile by Id
get_self-service-profiles_by_id 1 param → 200400401403404429500
DELETE
/self-service-profiles/{id}
Delete a Self-service Profile by Id
delete_self-service-profiles_by_id 1 param → 204400401403429500
PATCH
/self-service-profiles/{id}
Update a Self-service Profile
patch_self-service-profiles_by_id 1 param body → 200400401403404429500
GET
/self-service-profiles/{id}/custom-text/{language}/{page}
Get Custom Text for a Self-service Profile
get_self_service_profile_custom_text 3 params → 200401403404429
PUT
/self-service-profiles/{id}/custom-text/{language}/{page}
Set Custom Text for a Self-service Profile
put_self_service_profile_custom_text 3 params body → 200401403404429
POST
/self-service-profiles/{id}/sso-ticket
Create an Access Ticket to Initiate the Self-Service Enterprise Configuration Flow
post_sso-ticket 1 param body → 201400401403429
POST
/self-service-profiles/{profileId}/sso-ticket/{id}/revoke
Revoke a Self-Service Enterprise Configuration Access Ticket
post_revoke 2 params → 202401403429

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are CreateSelfServiceProfileResponseContent (9 properties), GetSelfServiceProfileResponseContent (9 properties), UpdateSelfServiceProfileResponseContent (9 properties), SelfServiceProfile (9 properties). Each schema is shown below with its type and property counts.

SelfServiceProfileBranding
CreateSelfServiceProfileSsoTicketResponseContent
object
1 property
SelfServiceProfileSsoTicketDomainVerificationEnum
string
Whether the end user should complete the domain verification step. Possible values are 'none' (the step is not shown to the user), 'optional' (the user may add…
SelfServiceProfileSsoTicketGoogleWorkspaceConfig
object
Configuration for Google Workspace Directory Sync during the self-service flow.
1 property 1 required
SelfServiceProfileSsoTicketDomainAliasesConfig
object
Configuration for the setup of the connection’s domainaliases in the Self-Service Enterprise Configuration flow.
2 properties 1 required
UpdateSelfServiceProfileRequestContent
object
6 properties
ConnectionsMetadata
object
Metadata associated with the connection in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed.
SetSelfServiceProfileCustomTextRequestContent
object
The list of text keys and values to customize the Self-Service Enterprise Configuration flow page. Values can be plain text or rich HTML content limited to bas…
SelfServiceProfileAllowedStrategyEnum
string
SelfServiceProfileSsoTicketEnabledFeatures
object
Specifies which features are enabled for an "edit connection" ticket. Only applicable when connection ID is provided.
3 properties
SelfServiceProfileDescription
stringnull
The description of the self-service Profile.
CreateSelfServiceProfileSsoTicketRequestContent
object
9 properties
SelfServiceProfile
object
9 properties
SelfServiceProfileUserAttribute
object
3 properties 3 required
SelfServiceProfileSsoTicketProvisioningScopeEnum
string
SelfServiceProfileCustomTextPageEnum
string
The page where the custom text is shown.
SelfServiceProfileSsoTicketEnabledOrganization
object
3 properties 1 required
SelfServiceProfileBrandingColors
object
1 property 1 required
SetSelfServiceProfileCustomTextResponseContent
object
The resulting list of custom text keys and values.
SelfServiceProfileSsoTicketIdpInitiatedOptions
objectnull
Allows IdP-initiated login
4 properties
ListSelfServiceProfileCustomTextResponseContent
object
The list of custom text keys and values.
SelfServiceProfileSsoTicketConnectionOptions
objectnull
The connection's options (depend on the connection strategy)
3 properties
CreateSelfServiceProfileRequestContent
object
6 properties 1 required
SelfServiceProfileSsoTicketProvisioningConfig
object
Configuration for the setup of Provisioning in the self-service flow.
3 properties
SelfServiceProfileUserAttributes
arraynull
List of attributes to be mapped that will be shown to the user during the Self-Service Enterprise Configuration flow.
SelfServiceProfileSsoTicketIdpInitiatedClientProtocolEnum
string
The protocol used to connect to the the default application
GetSelfServiceProfileResponseContent
object
9 properties
ListSelfServiceProfilesResponseContent
CreateSelfServiceProfileResponseContent
object
9 properties
SelfServiceProfileSsoTicketConnectionConfig
object
If provided, this will create a new connection for the Self-Service Enterprise Configuration flow with the given configuration
6 properties 1 required
SelfServiceProfileCustomTextLanguageEnum
string
The language of the custom text.
UpdateSelfServiceProfileResponseContent
object
9 properties
SelfServiceProfileBrandingProperties
object
2 properties
ListSelfServiceProfilesPaginatedResponseContent
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

auth0-self-service-profiles-api-openapi.yml Raw ↑

Other APIs Auth0 publishes across the network.

Auth0 My Account API
Auth0 My Organization API
Auth0 for AI Agents
Auth0 actions API
Auth0 anomaly API
Auth0 Assertions API
Auth0 attack-protection API
Auth0 Authorization Models API
Auth0 Authorize User API
Auth0 AuthZenService API
Auth0 branding API
Auth0 client-grants API
Where this information came from

This is an independent, third-party profile of Auth0 self-service-profiles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.