# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Applications.federated Identity Credential API
  version: 1.0.0
extends: openapi/azure-ad-applications-federatedidentitycredential-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['/applications/{application-id}/federatedIdentityCredentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's federated identity credentials
      effect: read
      questions:
      - Which external identity providers does my app registration trust for workload identity federation?
      - Can I filter an app's federated credentials by issuer or subject?
      instructions:
      - text: List federated identity credentials on application {app_id}.
        slots:
          app_id: path.application-id
      - text: Show federated credentials on app {app_id} matching {filter}.
        slots:
          app_id: path.application-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application-id}/federatedIdentityCredentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a federated identity credential to an app
      effect: write
      questions:
      - How do I let an external CI pipeline get tokens for my app without storing a secret?
      - What issuer, subject and audience does a new federated credential need?
      instructions:
      - text: Create federated credential {name} on app {app_id} for issuer {issuer} and subject {subject}.
        slots:
          app_id: path.application-id
          name: requestBody.name
          issuer: requestBody.issuer
          subject: requestBody.subject
      - text: Trust tokens from {issuer} with audience {audiences} on application {app_id}.
        slots:
          app_id: path.application-id
          issuer: requestBody.issuer
          audiences: requestBody.audiences
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a federated identity credential by ID
      effect: read
      questions:
      - What issuer and subject are set on one federated credential of my app?
      - Can I read a federated identity credential using its object ID?
      instructions:
      - text: Show federated credential {credential_id} on application {app_id}.
        slots:
          app_id: path.application-id
          credential_id: path.federatedIdentityCredential-id
      - text: Get the trust settings of credential ID {credential_id} for app {app_id}.
        slots:
          app_id: path.application-id
          credential_id: path.federatedIdentityCredential-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a federated identity credential by ID
      effect: destructive
      questions:
      - How do I stop an external workload from getting tokens for my app?
      - Can I delete a federated credential by its ID with an etag check?
      instructions:
      - text: Delete federated credential {credential_id} from application {app_id}.
        slots:
          app_id: path.application-id
          credential_id: path.federatedIdentityCredential-id
      - text: Remove credential ID {credential_id} on app {app_id} if its etag is {etag}.
        slots:
          app_id: path.application-id
          credential_id: path.federatedIdentityCredential-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Upsert a federated identity credential by ID
      effect: write
      questions:
      - How do I change the subject on an existing federated credential identified by its ID?
      - Will patching a federated credential ID that doesn't exist create it?
      instructions:
      - text: Set the subject of credential ID {credential_id} on app {app_id} to {subject}.
        slots:
          app_id: path.application-id
          credential_id: path.federatedIdentityCredential-id
          subject: requestBody.subject
      - text: Create or update federated credential {credential_id} for application {app_id} with issuer {issuer}.
        slots:
          app_id: path.application-id
          credential_id: path.federatedIdentityCredential-id
          issuer: requestBody.issuer
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application-id}/federatedIdentityCredentials(name=\'{name}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a federated identity credential by name
      effect: read
      questions:
      - Can I read a federated credential using the name I gave it instead of its ID?
      - What's configured on the federated credential called by a given name?
      instructions:
      - text: Show the federated credential named {name} on application {app_id}.
        slots:
          app_id: path.application-id
          name: path.name
      - text: Look up credential {name} by name for app {app_id}.
        slots:
          app_id: path.application-id
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application-id}/federatedIdentityCredentials(name=\'{name}\')'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a federated identity credential by name
      effect: destructive
      questions:
      - How do I delete a federated credential when I only know its name?
      - Can I remove a named federated credential without first looking up its ID?
      instructions:
      - text: Delete the federated credential named {name} from application {app_id}.
        slots:
          app_id: path.application-id
          name: path.name
      - text: Remove credential {name} by name on app {app_id}.
        slots:
          app_id: path.application-id
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application-id}/federatedIdentityCredentials(name=\'{name}\')'].patch
  update:
    x-apievangelist-phrasing:
      intent: Upsert a federated identity credential by name
      effect: write
      questions:
      - How do I create or update a federated credential addressed by its name?
      - Can I idempotently set a named federated credential in a deployment script?
      instructions:
      - text: Upsert the federated credential named {name} on app {app_id} with subject {subject}.
        slots:
          app_id: path.application-id
          name: path.name
          subject: requestBody.subject
      - text: Create or update credential {name} by name for application {app_id} trusting {issuer}.
        slots:
          app_id: path.application-id
          name: path.name
          issuer: requestBody.issuer
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application-id}/federatedIdentityCredentials/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count an app's federated identity credentials
      effect: read
      questions:
      - How many federated credentials does an app registration have?
      - What number of an app's federated credentials match a given issuer?
      instructions:
      - text: Count federated identity credentials on application {app_id}.
        slots:
          app_id: path.application-id
      - text: Count federated credentials on app {app_id} matching {filter}.
        slots:
          app_id: path.application-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'