Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Self Service Profiles API

10 actions 10 updates phrasing extends openapi/auth0-self-service-profiles-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Auth0's API. It is a proposal applied on top of the contract, not a document Auth0 publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/self-service-profiles'].get
$.paths['/self-service-profiles'].post
$.paths['/self-service-profiles/{id}'].get
$.paths['/self-service-profiles/{id}'].delete
$.paths['/self-service-profiles/{id}'].patch
$.paths['/self-service-profiles/{id}/custom-text/{language}/{page}'].get
$.paths['/self-service-profiles/{id}/custom-text/{language}/{page}'].put
$.paths['/self-service-profiles/{id}/sso-ticket'].post
$.paths['/self-service-profiles/{profileId}/sso-ticket/{id}/revoke'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Self Service Profiles API
  version: 1.0.0
extends: openapi/auth0-self-service-profiles-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/self-service-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List self-service SSO profiles
      effect: read
      questions:
      - Which self-service SSO profiles have I set up?
      - Can I get a total count of self-service profiles?
      instructions:
      - text: List my self-service profiles.
      - text: Show page {page} of self-service profiles.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/self-service-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a self-service SSO profile
      effect: write
      questions:
      - How do I let my business customers configure their own enterprise SSO?
      - Can I restrict which identity provider strategies a self-service profile allows?
      instructions:
      - text: Create a self-service profile named {name}.
        slots:
          name: requestBody.name
      - text: Create self-service profile {name} allowing strategies {allowed_strategies}.
        slots:
          name: requestBody.name
          allowed_strategies: requestBody.allowed_strategies
      method: generated
      generated: '2026-10-01'
- target: $.paths['/self-service-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a self-service profile
      effect: read
      questions:
      - What branding and user attributes does a given self-service profile have?
      - Can I look up a self-service SSO profile by its ID?
      instructions:
      - text: Show me self-service profile {id}.
        slots:
          id: path.id
      - text: Get the allowed strategies of self-service profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/self-service-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a self-service profile
      effect: destructive
      questions:
      - How do I remove a self-service SSO profile I no longer use?
      - Can I delete a self-service profile by its ID?
      instructions:
      - text: Delete self-service profile {id}.
        slots:
          id: path.id
      - text: Remove the unused self-service SSO profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/self-service-profiles/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a self-service profile
      effect: write
      questions:
      - Can I change the branding shown in the self-service SSO setup flow?
      - How do I add more user attributes to an existing self-service profile?
      instructions:
      - text: Update the branding of self-service profile {id} to {branding}.
        slots:
          id: path.id
          branding: requestBody.branding
      - text: Set the user attributes on profile {id} to {user_attributes}.
        slots:
          id: path.id
          user_attributes: requestBody.user_attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/self-service-profiles/{id}/custom-text/{language}/{page}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom text for a self-service setup page
      effect: read
      questions:
      - What custom wording appears on a page of the self-service SSO setup flow?
      - Can I read the Spanish text customizations for a self-service profile?
      instructions:
      - text: Show the {language} custom text for page {page} of self-service profile {id}.
        slots:
          language: path.language
          page: path.page
          id: path.id
      - text: Fetch text overrides on profile {id} for language {language} and page {page}.
        slots:
          id: path.id
          language: path.language
          page: path.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/self-service-profiles/{id}/custom-text/{language}/{page}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set custom text for a self-service setup page
      effect: write
      questions:
      - How do I change the instructions customers see in the self-service SSO flow?
      - Can I localize the setup flow text per language?
      instructions:
      - text: Set the {language} text for page {page} of self-service profile {id}.
        slots:
          language: path.language
          page: path.page
          id: path.id
      - text: Replace the custom wording on profile {id} for {language} on the {page} page.
        slots:
          id: path.id
          language: path.language
          page: path.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/self-service-profiles/{id}/sso-ticket'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a self-service SSO setup ticket
      effect: write
      questions:
      - How do I send a customer's IT admin a link to configure their own SSO connection?
      - Can I set how long a self-service SSO access ticket stays valid?
      - Is it possible to enable the resulting connection for specific organizations automatically?
      instructions:
      - text: Create an SSO access ticket from self-service profile {id}.
        slots:
          id: path.id
      - text: Create a ticket from profile {id} that expires in {ttl_sec} seconds.
        slots:
          id: path.id
          ttl_sec: requestBody.ttl_sec
      - text: Issue a ticket on profile {id} to reconfigure existing connection {connection_id}.
        slots:
          id: path.id
          connection_id: requestBody.connection_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/self-service-profiles/{profileId}/sso-ticket/{id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a self-service SSO access ticket
      effect: destructive
      questions:
      - How do I cancel a self-service SSO setup link I already sent out?
      - Does revoking an access ticket end the sessions it started?
      instructions:
      - text: Revoke SSO ticket {id} on self-service profile {profileId}.
        slots:
          id: path.id
          profileId: path.profileId
      - text: Invalidate access ticket {id} from profile {profileId} and its sessions.
        slots:
          id: path.id
          profileId: path.profileId
      method: generated
      generated: '2026-10-01'