# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Application Client API
  version: 1.0.0
extends: openapi/strivacity-application-client-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['/admin/api/v2/applications/{applicationId}/clients'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's clients
      effect: read
      questions:
      - What OAuth or SAML clients are configured under an application?
      - Can I sort the clients of an application?
      instructions:
      - text: List the clients of application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: List clients for application {applicationId} sorted by {sort}.
        slots:
          applicationId: path.applicationId
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application client
      effect: write
      questions:
      - How do I add a new client to an existing application?
      - Can one application have more than one client?
      instructions:
      - text: Create a new client under application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Add another client to application {applicationId}.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application client
      effect: read
      questions:
      - Can I view the configuration of one specific application client?
      - Where do I find a client's settings within an application?
      instructions:
      - text: Get client {clientId} of application {applicationId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      - text: Show configuration for client {clientId} in application {applicationId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an application client
      effect: write
      questions:
      - Can I change the name or login URL of a self-service portal client?
      - What settings of an application client can be updated?
      instructions:
      - text: Update client {clientId} in application {applicationId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      - text: Change the configuration of application {applicationId} client {clientId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application client
      effect: destructive
      questions:
      - How do I remove a client from an application?
      - Is deleting an application client permanent?
      instructions:
      - text: Delete client {clientId} from application {applicationId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      - text: Remove application {applicationId}'s client {clientId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List token exchange claim mapping logs
      effect: read
      questions:
      - Can I see logs from a client's token exchange claim mapping function?
      - Is it possible to filter token exchange function logs by account, log level or date range?
      instructions:
      - text: List token exchange claim mapping logs for client {clientId} in application {applicationId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      - text: Show {logLevels} token exchange logs for client {clientId} of application {applicationId} since {startDate}.
        slots:
          logLevels: query.logLevels
          clientId: path.clientId
          applicationId: path.applicationId
          startDate: query.startDate
      - text: List token exchange logs for account {accountIds} on client {clientId} of application {applicationId}.
        slots:
          accountIds: query.accountIds
          clientId: path.clientId
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/logs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a token exchange claim mapping log
      effect: read
      questions:
      - How do I open a single token exchange claim mapping log entry?
      - Can I read the details of one failed token exchange mapping run?
      instructions:
      - text: Get token exchange log {id} for client {clientId} in application {applicationId}.
        slots:
          id: path.id
          clientId: path.clientId
          applicationId: path.applicationId
      - text: Show the token exchange mapping log entry {id} of application {applicationId} client {clientId}.
        slots:
          id: path.id
          clientId: path.clientId
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/saml2/metadata/descriptor'].get
  update:
    x-apievangelist-phrasing:
      intent: Get SAML2 metadata for a client
      effect: read
      questions:
      - Where can I download the SAML2 metadata for an application client?
      - What SAML metadata should I give a service provider for this client?
      instructions:
      - text: Get the SAML2 metadata for client {clientId} of application {applicationId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      - text: Export SAML metadata descriptor for application {applicationId} client {clientId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{applicationId}/clients/{clientId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check token exchange function status
      effect: read
      questions:
      - Is the token exchange claim mapping function on a client deployed and ready?
      - What state is a client's token exchange function in?
      instructions:
      - text: Check the token exchange function status for client {clientId} in application {applicationId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      - text: Get token exchange claim mapping status of application {applicationId} client {clientId}.
        slots:
          clientId: path.clientId
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'