Microsoft Entra ID (formerly Azure AD)

Microsoft Entra ID (formerly Azure AD) Identity.identity User Flow Attribute API

The identity.identityUserFlowAttribute API from Microsoft Entra ID (formerly Azure AD) — 3 operation(s) for identity.identityuserflowattribute.

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /identity/userFlowAttributes List user flow attributes · List identityUserFlowAttributes #

Ask an LLM

“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?”

Tell an agent

List all user flow attributes in my tenant.

Show user flow attributes matching filter {filter}.

POST /identity/userFlowAttributes Create a custom user flow attribute · Create identityUserFlowAttribute #

Ask an LLM

“How do I add a custom attribute to collect during user sign-up?”

“What data types can a new custom user flow attribute have?”

Tell an agent

Create a custom user flow attribute {name} of data type {data_type}.

Add user flow attribute {name} described as {description}.

GET /identity/userFlowAttributes/{identityUserFlowAttribute-id} Get one user flow attribute · Get identityUserFlowAttribute #

Ask an LLM

“What data type and description does a specific user flow attribute have?”

“Is a given user flow attribute built-in or custom?”

Tell an agent

Get user flow attribute {attribute}.

Show the data type of user flow attribute {attribute}.

PATCH /identity/userFlowAttributes/{identityUserFlowAttribute-id} Update a custom user flow attribute · Update identityUserFlowAttribute #

Ask an LLM

“Can I change the description of a custom user flow attribute?”

“Which properties of an existing custom attribute are editable?”

Tell an agent

Update the description of user flow attribute {attribute} to {description}.

Rename custom attribute {attribute} to {name}.

DELETE /identity/userFlowAttributes/{identityUserFlowAttribute-id} Delete a custom user flow attribute · Delete identityUserFlowAttribute #

Ask an LLM

“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?”

Tell an agent destructive · confirm first

Delete custom user flow attribute {attribute}.

Remove user flow attribute {attribute} from my tenant.

GET /identity/userFlowAttributes/$count Count user flow attributes · Get the number of the resource #

Ask an LLM

“How many user flow attributes are defined in my tenant?”

“Can I get a count of custom user flow attributes only?”

Tell an agent

Count the user flow attributes in my tenant.

Tell me how many user flow attributes match filter {filter}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/azure-ad:azure-ad-identity-identityuserflowattribute-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Identity.SignIns Identity.identity User Flow Attribute API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: identity.identityUserFlowAttribute
paths:
  /identity/userFlowAttributes:
    get:
      tags:
      - identity.identityUserFlowAttribute
      summary: List identityUserFlowAttributes
      description: Retrieve a list of identityUserFlowAttribute objects.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/identityuserflowattribute-list?view=graph-rest-1.0
      operationId: identity_ListUserFlowAttribute
      parameters:
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          $ref: '#/components/responses/microsoft.graph.identityUserFlowAttributeCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - identity.identityUserFlowAttribute
      summary: Create identityUserFlowAttribute
      description: Create a new custom identityUserFlowAttribute object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/identityuserflowattribute-post?view=graph-rest-1.0
      operationId: identity_CreateUserFlowAttribute
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /identity/userFlowAttributes/{identityUserFlowAttribute-id}:
    get:
      tags:
      - identity.identityUserFlowAttribute
      summary: Get identityUserFlowAttribute
      description: Retrieve the properties and relationships of a identityUserFlowAttribute object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/identityuserflowattribute-get?view=graph-rest-1.0
      operationId: identity_GetUserFlowAttribute
      parameters:
      - name: identityUserFlowAttribute-id
        in: path
        description: The unique identifier of identityUserFlowAttribute
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: identityUserFlowAttribute
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - identity.identityUserFlowAttribute
      summary: Update identityUserFlowAttribute
      description: Update the properties of a custom identityUserFlowAttribute object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/identityuserflowattribute-update?view=graph-rest-1.0
      operationId: identity_UpdateUserFlowAttribute
      parameters:
      - name: identityUserFlowAttribute-id
        in: path
        description: The unique identifier of identityUserFlowAttribute
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: identityUserFlowAttribute
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - identity.identityUserFlowAttribute
      summary: Delete identityUserFlowAttribute
      description: Delete a custom identityUserFlowAttribute.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/identityuserflowattribute-delete?view=graph-rest-1.0
      operationId: identity_DeleteUserFlowAttribute
      parameters:
      - name: identityUserFlowAttribute-id
        in: path
        description: The unique identifier of identityUserFlowAttribute
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: identityUserFlowAttribute
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /identity/userFlowAttributes/$count:
    get:
      tags:
      - identity.identityUserFlowAttribute
      summary: Get the number of the resource
      operationId: identity.userFlowAttribute_GetCount
      parameters:
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
components:
  responses:
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
    ODataCountResponse:
      description: The count of the resource
      content:
        text/plain:
          schema:
            $ref: '#/components/schemas/ODataCountResponse'
    microsoft.graph.identityUserFlowAttributeCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeCollectionResponse'
  schemas:
    microsoft.graph.identityUserFlowAttributeCollectionResponse:
      title: Collection of identityUserFlowAttribute
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.identityUserFlowAttributeDataType:
      title: identityUserFlowAttributeDataType
      enum:
      - string
      - boolean
      - int64
      - stringCollection
      - dateTime
      - unknownFutureValue
      type: string
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.identityUserFlowAttribute:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: identityUserFlowAttribute
        type: object
        properties:
          dataType:
            $ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeDataType'
          description:
            type:
            - string
            - 'null'
            description: The description of the user flow attribute that's shown to the user at the time of sign up.
          displayName:
            type:
            - string
            - 'null'
            description: The display name of the user flow attribute.  Supports $filter (eq, ne).
          userFlowAttributeType:
            $ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeType'
        additionalProperties:
          type: object
    microsoft.graph.identityUserFlowAttributeType:
      title: identityUserFlowAttributeType
      enum:
      - builtIn
      - custom
      - required
      - unknownFutureValue
      type: string
    ODataCountResponse:
      type: integer
      format: int32
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
  parameters:
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}

Microsoft Entra ID (formerly Azure AD) Identity.identity User Flow Attribute API

Operations 6

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification