# 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 User Flow Attribute API
  version: 1.0.0
extends: openapi/azure-ad-identity-identityuserflowattribute-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: 6
- target: $.paths['/identity/userFlowAttributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List user flow attributes
      effect: read
      questions:
      - Which built-in and custom attributes can I collect in my sign-up user flows?
      - Can I list only the custom user flow attributes I've defined?
      instructions:
      - text: List all user flow attributes in my tenant.
      - text: Show user flow attributes matching filter {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/userFlowAttributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom user flow attribute
      effect: write
      questions:
      - How do I add a custom attribute to collect during user sign-up?
      - What data types can a new custom user flow attribute have?
      instructions:
      - text: Create a custom user flow attribute {name} of data type {data_type}.
        slots:
          name: requestBody.displayName
          data_type: requestBody.dataType
      - text: Add user flow attribute {name} described as {description}.
        slots:
          name: requestBody.displayName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/userFlowAttributes/{identityUserFlowAttribute-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user flow attribute
      effect: read
      questions:
      - What data type and description does a specific user flow attribute have?
      - Is a given user flow attribute built-in or custom?
      instructions:
      - text: Get user flow attribute {attribute}.
        slots:
          attribute: path.identityUserFlowAttribute-id
      - text: Show the data type of user flow attribute {attribute}.
        slots:
          attribute: path.identityUserFlowAttribute-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/userFlowAttributes/{identityUserFlowAttribute-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom user flow attribute
      effect: destructive
      questions:
      - Can I delete a custom attribute I no longer collect in user flows?
      - Is it possible to remove built-in user flow attributes, or only custom ones?
      instructions:
      - text: Delete custom user flow attribute {attribute}.
        slots:
          attribute: path.identityUserFlowAttribute-id
      - text: Remove user flow attribute {attribute} from my tenant.
        slots:
          attribute: path.identityUserFlowAttribute-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/userFlowAttributes/{identityUserFlowAttribute-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom user flow attribute
      effect: write
      questions:
      - Can I change the description of a custom user flow attribute?
      - Which properties of an existing custom attribute are editable?
      instructions:
      - text: Update the description of user flow attribute {attribute} to {description}.
        slots:
          attribute: path.identityUserFlowAttribute-id
          description: requestBody.description
      - text: Rename custom attribute {attribute} to {name}.
        slots:
          attribute: path.identityUserFlowAttribute-id
          name: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/userFlowAttributes/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count user flow attributes
      effect: read
      questions:
      - How many user flow attributes are defined in my tenant?
      - Can I get a count of custom user flow attributes only?
      instructions:
      - text: Count the user flow attributes in my tenant.
      - text: Tell me how many user flow attributes match filter {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'