API Evangelist conversational phrasing for Identity.SignIns Identity.identity API Connector API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity.SignIns Identity.identity API Connector API
  version: 1.0.0
extends: openapi/azure-ad-identity-identityapiconnector-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: 7
- target: $.paths['/identity/apiConnectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List API connectors for sign-up flows
      effect: read
      questions:
      - Which API connectors are configured for my external identities sign-up flows?
      - Can I see all the webhook endpoints my user flows call out to?
      instructions:
      - text: List all identity API connectors.
      - text: Show the API connectors my sign-up user flows use.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/apiConnectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API connector
      effect: write
      questions:
      - How do I register an external REST endpoint to call during user sign-up?
      - What authentication options can I set when creating an API connector?
      instructions:
      - text: Create an API connector named {display_name} that calls {target_url}.
        slots:
          display_name: requestBody.displayName
          target_url: requestBody.targetUrl
      - text: Create an API connector to {target_url} using authentication {auth_config}.
        slots:
          target_url: requestBody.targetUrl
          auth_config: requestBody.authenticationConfiguration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/apiConnectors/{identityApiConnector-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API connector
      effect: read
      questions:
      - What URL and authentication does a specific API connector use?
      - Can I read the configuration of one API connector?
      instructions:
      - text: Get API connector {connector}.
        slots:
          connector: path.identityApiConnector-id
      - text: Show the target URL and auth settings of API connector {connector}.
        slots:
          connector: path.identityApiConnector-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/apiConnectors/{identityApiConnector-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API connector
      effect: destructive
      questions:
      - Can I remove an API connector my sign-up flow no longer calls?
      - Is deleting an identity API connector permanent?
      instructions:
      - text: Delete API connector {connector}.
        slots:
          connector: path.identityApiConnector-id
      - text: Remove the {connector} connector from external identities.
        slots:
          connector: path.identityApiConnector-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/apiConnectors/{identityApiConnector-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API connector
      effect: write
      questions:
      - Can I point an existing API connector at a new endpoint URL?
      - Is it possible to rename or change the credentials of an API connector?
      instructions:
      - text: Change the target URL of API connector {connector} to {target_url}.
        slots:
          connector: path.identityApiConnector-id
          target_url: requestBody.targetUrl
      - text: Rename API connector {connector} to {display_name}.
        slots:
          connector: path.identityApiConnector-id
          display_name: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/apiConnectors/{identityApiConnector-id}/microsoft.graph.uploadClientCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a client certificate to an API connector
      effect: write
      questions:
      - How do I set up certificate authentication on an API connector with a .pfx file?
      - Does a PKCS 12 certificate for an API connector need a password?
      instructions:
      - text: Upload the base64 PKCS 12 certificate {pkcs12} with password {password} to API connector {connector}.
        slots:
          pkcs12: requestBody.pkcs12Value
          password: requestBody.password
          connector: path.identityApiConnector-id
      - text: Add a client certificate to API connector {connector}.
        slots:
          connector: path.identityApiConnector-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/apiConnectors/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count API connectors
      effect: read
      questions:
      - How many API connectors are set up in my tenant?
      - Can I get just the total of identity API connectors?
      instructions:
      - text: Count the identity API connectors.
      - text: Tell me how many API connectors exist.
      method: generated
      generated: '2026-10-01'