Description: The name of the self-service profile.
description (string)
Length:1 <= length <= 140
Description: The description of the self-service profile.
allowed_strategies (string[])
Description: List of IdP strategies shown to users during the Self-Service SSO flow.
Possible values: [oidc, samlp, waad, google-apps, adfs, okta, keycloak-samlp, pingfederate]
New: PUT /api/v2/self-service-profiles/{id}/custom-text/{language}/{page}
Updates text customizations for a given self-service profile, language, and Self-Service SSO flow page.
Scope:update:self_service_profile_custom_texts
Path Parameters:
id (string) Required: The ID of the self-service profile.
language (string) Required: The language of the custom text.
page (string) Required: The page where the custom text is shown.
Body Parameters:
Returns an object containing key/value pairs.
Contains text keys and values for customizing the self-service SSO page. Values can be plain text or rich HTML (limited to basic styling tags and hyperlinks).
Each value can be up to 2000 characters.
Currently supported languages: en.
Supported pages: get-started.
Supported keys for get-started: introduction.
Note: Language, page, and key support can change at any time and should be treated as text fields from the SDK's perspective.
New: GET /api/v2/self-service-profiles/{id}/custom-text/{language}/{page}
Retrieves custom text for a self-service profile.
Scope:read:self_service_profile_custom_texts
Path Parameters:
id (string) Required: The ID of the self-service profile.
language (string) Required: The language of the custom text.
page (string) Required: The page where the custom text is shown.
Response: Returns a list of key/value pairs, or an empty object {} if none are set.
Modified: POST /api/v2/self-service-profiles/{id}/sso-ticket
New Query Parameters: When creating a new SSO ticket, the following optional parameters are supported:
Connections:
domain_aliases
display_name
is_domain_connection
show_as_button
metadata
icon_url
Organizations:
assign_membership_on_login
show_as_button
ttl_sec
Maximum: 5 days.
Default: 5 days (432,000 seconds) if not specified.
Changes
Updated SelfServiceProfilesManager method names
More details below:
Modified:
POST /api/v2/self-service-profiles
New Query Parameters:
name
(string) RequiredLength:
1 <= length <= 100
Description: The name of the self-service profile.
description
(string)Length:
1 <= length <= 140
Description: The description of the self-service profile.
allowed_strategies
(string[])Description: List of IdP strategies shown to users during the Self-Service SSO flow.
Possible values: [
oidc
,samlp
,waad
,google-apps
,adfs
,okta
,keycloak-samlp
,pingfederate
]New:
PUT /api/v2/self-service-profiles/{id}/custom-text/{language}/{page}
Updates text customizations for a given self-service profile, language, and Self-Service SSO flow page.
Scope:
update:self_service_profile_custom_texts
Path Parameters:
id
(string) Required: The ID of the self-service profile.language
(string) Required: The language of the custom text.page
(string) Required: The page where the custom text is shown.Body Parameters:
en
.get-started
.get-started
:introduction
.New:
GET /api/v2/self-service-profiles/{id}/custom-text/{language}/{page}
Retrieves custom text for a self-service profile.
Scope:
read:self_service_profile_custom_texts
Path Parameters:
id
(string) Required: The ID of the self-service profile.language
(string) Required: The language of the custom text.page
(string) Required: The page where the custom text is shown.Response: Returns a list of key/value pairs, or an empty object
{}
if none are set.Modified:
POST /api/v2/self-service-profiles/{id}/sso-ticket
New Query Parameters: When creating a new SSO ticket, the following optional parameters are supported:
Connections:
domain_aliases
display_name
is_domain_connection
show_as_button
metadata
icon_url
Organizations:
assign_membership_on_login
show_as_button
ttl_sec
Maximum: 5 days.
Default: 5 days (432,000 seconds) if not specified.
Sample Request Body:
New:
POST /api/v2/self-service-profiles/{id}/sso-ticket/{id}/revoke
Scope:
delete:sso_access_tickets
Description:
Revokes a ticket.
202 Accepted
with no body content.References
https://auth0.com/docs/api/management/v2/self-service-profiles/get-self-service-profiles
Testing
We will release guides to use this features separately that can help in manual testing.
Checklist