# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Applications Service Principals.federated Identity…
  version: 1.0.0
extends: openapi/azure-ad-serviceprincipals-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['/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List a service principal's federated credentials
      effect: read
      questions:
      - Which federated identity credentials are configured on a managed identity's service principal?
      - Can I filter a service principal's federated credentials by issuer or subject?
      instructions:
      - text: List the federated identity credentials on service principal {sp_id}.
        slots:
          sp_id: path.servicePrincipal-id
      - text: Show federated credentials for {sp_id} matching filter {filter}.
        slots:
          sp_id: path.servicePrincipal-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a federated credential to a service principal
      effect: write
      questions:
      - How do I let an external CI pipeline or workload sign in as a managed identity without a secret?
      - What issuer, subject and audience do I need to create a federated identity credential?
      instructions:
      - text: Create federated credential {name} on service principal {sp_id} trusting issuer {issuer} for subject {subject}.
        slots:
          name: requestBody.name
          sp_id: path.servicePrincipal-id
          issuer: requestBody.issuer
          subject: requestBody.subject
      - text: Add a federated identity credential to {sp_id} with audiences {audiences}.
        slots:
          sp_id: path.servicePrincipal-id
          audiences: requestBody.audiences
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a federated credential by ID
      effect: read
      questions:
      - What issuer and subject does a specific federated credential on a service principal trust?
      - Can I read one federated identity credential using its ID?
      instructions:
      - text: Get federated credential {credential_id} on service principal {sp_id}.
        slots:
          credential_id: path.federatedIdentityCredential-id
          sp_id: path.servicePrincipal-id
      - text: Show the trust settings of credential ID {credential_id} for {sp_id}.
        slots:
          credential_id: path.federatedIdentityCredential-id
          sp_id: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a federated credential by ID
      effect: destructive
      questions:
      - How do I revoke a workload's federated trust on a service principal using the credential ID?
      - Can I delete a federated identity credential when I only have its ID?
      instructions:
      - text: Delete federated credential {credential_id} from service principal {sp_id}.
        slots:
          credential_id: path.federatedIdentityCredential-id
          sp_id: path.servicePrincipal-id
      - text: Remove the federated trust with ID {credential_id} on {sp_id}.
        slots:
          credential_id: path.federatedIdentityCredential-id
          sp_id: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a federated credential by ID
      effect: write
      questions:
      - Can I change the subject on an existing federated credential using its ID?
      - Which fields of a service principal's federated credential can be patched?
      instructions:
      - text: Update federated credential {credential_id} on service principal {sp_id} to subject {subject}.
        slots:
          credential_id: path.federatedIdentityCredential-id
          sp_id: path.servicePrincipal-id
          subject: requestBody.subject
      - text: Change the audiences of credential ID {credential_id} on {sp_id} to {audiences}.
        slots:
          credential_id: path.federatedIdentityCredential-id
          sp_id: path.servicePrincipal-id
          audiences: requestBody.audiences
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials(name=\'{name}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a federated credential by name
      effect: read
      questions:
      - Can I look up a federated identity credential on a service principal by its name instead of its ID?
      - What does the federated credential named for my deploy pipeline trust?
      instructions:
      - text: Get the federated credential named {name} on service principal {sp_id}.
        slots:
          name: path.name
          sp_id: path.servicePrincipal-id
      - text: Show the trust settings of credential {name} for {sp_id}, looked up by name.
        slots:
          name: path.name
          sp_id: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials(name=\'{name}\')'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a federated credential by name
      effect: destructive
      questions:
      - Can I delete a federated identity credential by its name rather than its ID?
      - How do I remove the named federated trust for an old pipeline from a service principal?
      instructions:
      - text: Delete the federated credential named {name} from service principal {sp_id}.
        slots:
          name: path.name
          sp_id: path.servicePrincipal-id
      - text: Remove federated trust {name} on {sp_id}, addressing it by name.
        slots:
          name: path.name
          sp_id: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials(name=\'{name}\')'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a federated credential by name
      effect: write
      questions:
      - Can I update a federated identity credential by addressing it with its name?
      - Is it possible to change the issuer of a named federated credential?
      instructions:
      - text: Update the federated credential named {name} on service principal {sp_id} to issuer {issuer}.
        slots:
          name: path.name
          sp_id: path.servicePrincipal-id
          issuer: requestBody.issuer
      - text: Set the description of named credential {name} on {sp_id} to {description}.
        slots:
          name: path.name
          sp_id: path.servicePrincipal-id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a service principal's federated credentials
      effect: read
      questions:
      - How many federated identity credentials does a service principal have?
      - Is there a limit I'm approaching on federated credentials for this managed identity?
      instructions:
      - text: Count the federated identity credentials on service principal {sp_id}.
        slots:
          sp_id: path.servicePrincipal-id
      - text: Return the number of federated trusts configured for {sp_id}.
        slots:
          sp_id: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'