Microsoft Entra ID (formerly Azure AD)

Microsoft Entra ID (formerly Azure AD) Identity.custom Authentication Extension API

The identity.customAuthenticationExtension API from Microsoft Entra ID (formerly Azure AD) — 5 operation(s) for identity.customauthenticationextension.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 8

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/customAuthenticationExtensions List custom authentication extensions · List customAuthenticationExtensions #
Ask an LLM
“Which custom authentication extensions are registered in my Entra tenant?”
“How do I see all the token issuance and sign-up extension endpoints I've configured?”
Tell an agent
List all custom authentication extensions.
Show every custom authentication extension and its properties.
POST /identity/customAuthenticationExtensions Create a custom authentication extension · Create customAuthenticationExtension #
Ask an LLM
“How do I register a new custom authentication extension that calls my API?”
“Can I choose what happens on error when creating a custom authentication extension?”
Tell an agent
Create a custom authentication extension with error behavior {behavior}.
Register a new custom authentication extension.
GET /identity/customAuthenticationExtensions/{customAuthenticationExtension-id} Get a custom authentication extension · Get customAuthenticationExtension #
Ask an LLM
“How do I read the configuration of one custom authentication extension?”
“What endpoint and error behavior does a specific extension use?”
Tell an agent
Get custom authentication extension {extension}.
Show the settings of authentication extension {extension}.
PATCH /identity/customAuthenticationExtensions/{customAuthenticationExtension-id} Update a custom authentication extension · Update customAuthenticationExtension #
Ask an LLM
“Can I change the on-error behavior of an existing custom authentication extension?”
“Which properties of an extension I already created can I edit?”
Tell an agent
Set the error behavior of existing extension {extension} to {behavior}.
Update custom authentication extension {extension}.
DELETE /identity/customAuthenticationExtensions/{customAuthenticationExtension-id} Delete a custom authentication extension · Delete customAuthenticationExtension #
Ask an LLM
“How do I delete a custom authentication extension I'm no longer using?”
“Can I remove one custom extension from the tenant?”
Tell an agent destructive · confirm first
Delete custom authentication extension {extension}.
Remove authentication extension {extension} from the tenant.
POST /identity/customAuthenticationExtensions/{customAuthenticationExtension-id}/microsoft.graph.validateAuthenticationConfiguration Validate a saved extension's endpoint and auth setup · Invoke action validateAuthenticationConfiguration #
Ask an LLM
“Is the endpoint and authentication configuration on my existing custom authentication extension valid?”
“How can I re-check a saved custom extension's settings after changing its endpoint?”
Tell an agent
Validate the endpoint and authentication configuration of custom extension {extension}.
Check that saved extension {extension} can still reach its endpoint with its configured auth.
GET /identity/customAuthenticationExtensions/$count Count custom authentication extensions · Get the number of the resource #
Ask an LLM
“How many custom authentication extensions does my tenant have?”
“What's the total count of custom extensions configured?”
Tell an agent
Count the custom authentication extensions.
Tell me how many custom authentication extensions exist.
POST /identity/customAuthenticationExtensions/microsoft.graph.validateAuthenticationConfiguration Validate an endpoint and auth setup before saving · Invoke action validateAuthenticationConfiguration #
Ask an LLM
“Can I test an endpoint URL and its authentication settings before creating a custom authentication extension?”
“Will a proposed endpoint configuration work for a new extension that I haven't saved yet?”
Tell an agent
Validate endpoint configuration {endpoint} before I create a custom authentication extension.
Check unsaved auth settings {auth} with endpoint {endpoint} ahead of creating an extension.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/graph/api/overview
📖
Authentication
https://learn.microsoft.com/en-us/graph/auth/
📖
Documentation
https://learn.microsoft.com/en-us/graph/change-notifications-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/openapi/azure-ad-identity-customauthenticationextension-api-openapi.yml

Other Resources

🔗
SDKs
https://learn.microsoft.com/en-us/graph/sdks/sdks-overview
🔗
ChangeLog
https://developer.microsoft.com/en-us/graph/changelog
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/asyncapi/azure-ad-change-notifications-webhooks.yml

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-customauthenticationextension-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

azure-ad-identity-customauthenticationextension-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Identity.SignIns Identity.custom Authentication Extension…
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: identity.customAuthenticationExtension
paths:
  /identity/customAuthenticationExtensions:
    get:
      tags:
      - identity.customAuthenticationExtension
      summary: List customAuthenticationExtensions
      description: Get a list of the customAuthenticationExtension objects and their properties. The following derived types are supported.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/identitycontainer-list-customauthenticationextensions?view=graph-rest-1.0
      operationId: identity_ListCustomAuthenticationExtension
      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.customAuthenticationExtensionCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - identity.customAuthenticationExtension
      summary: Create customAuthenticationExtension
      description: Create a new customAuthenticationExtension object. The following derived types are currently supported.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/identitycontainer-post-customauthenticationextensions?view=graph-rest-1.0
      operationId: identity_CreateCustomAuthenticationExtension
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /identity/customAuthenticationExtensions/{customAuthenticationExtension-id}:
    get:
      tags:
      - identity.customAuthenticationExtension
      summary: Get customAuthenticationExtension
      description: Read the properties and relationships of a customAuthenticationExtension object. The following derived types are currently supported.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/customauthenticationextension-get?view=graph-rest-1.0
      operationId: identity_GetCustomAuthenticationExtension
      parameters:
      - name: customAuthenticationExtension-id
        in: path
        description: The unique identifier of customAuthenticationExtension
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: customAuthenticationExtension
      - 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.customAuthenticationExtension'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - identity.customAuthenticationExtension
      summary: Update customAuthenticationExtension
      description: Update the properties of a customAuthenticationExtension object. The following derived types are currently supported.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/customauthenticationextension-update?view=graph-rest-1.0
      operationId: identity_UpdateCustomAuthenticationExtension
      parameters:
      - name: customAuthenticationExtension-id
        in: path
        description: The unique identifier of customAuthenticationExtension
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: customAuthenticationExtension
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - identity.customAuthenticationExtension
      summary: Delete customAuthenticationExtension
      description: Delete a customAuthenticationExtension object. The following derived types are currently supported.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/customauthenticationextension-delete?view=graph-rest-1.0
      operationId: identity_DeleteCustomAuthenticationExtension
      parameters:
      - name: customAuthenticationExtension-id
        in: path
        description: The unique identifier of customAuthenticationExtension
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: customAuthenticationExtension
      - 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/customAuthenticationExtensions/{customAuthenticationExtension-id}/microsoft.graph.validateAuthenticationConfiguration
  : post:
      tags:
      - identity.customAuthenticationExtension
      summary: Invoke action validateAuthenticationConfiguration
      description: 'An API to check validity of the endpoint and and authentication configuration for a customAuthenticationExtension object, which can represent one of the following derived types:'
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/customauthenticationextension-validateauthenticationconfiguration?view=graph-rest-1.0
      operationId: identity.customAuthenticationExtension_validateAuthenticationConfiguration
      parameters:
      - name: customAuthenticationExtension-id
        in: path
        description: The unique identifier of customAuthenticationExtension
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: customAuthenticationExtension
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.authenticationConfigurationValidation'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: action
  /identity/customAuthenticationExtensions/$count:
    get:
      tags:
      - identity.customAuthenticationExtension
      summary: Get the number of the resource
      operationId: identity.customAuthenticationExtension_GetCount
      parameters:
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
  /identity/customAuthenticationExtensions/microsoft.graph.validateAuthenticationConfiguration:
    post:
      tags:
      - identity.customAuthenticationExtension
      summary: Invoke action validateAuthenticationConfiguration
      operationId: postIdentityCustomAuthenticationExtensionsMicrosoftGraphValidateAuthenticationConfiguration
      requestBody:
        description: Action parameters
        content:
          application/json:
            schema:
              type: object
              properties:
                endpointConfiguration:
                  $ref: '#/components/schemas/microsoft.graph.customExtensionEndpointConfiguration'
                authenticationConfiguration:
                  $ref: '#/components/schemas/microsoft.graph.customExtensionAuthenticationConfiguration'
              additionalProperties:
                type: object
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.authenticationConfigurationValidation'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: action
      x-operation-id-source: normalized
      x-operation-id-original: identity.customAuthenticationExtension_validateAuthenticationConfiguration
components:
  schemas:
    microsoft.graph.authenticationConfigurationValidation:
      title: authenticationConfigurationValidation
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.genericError'
          description: Errors in the validation result of a customAuthenticationExtension.
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.genericError'
          description: Warnings in the validation result of a customAuthenticationExtension.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    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.customExtensionEndpointConfiguration:
      title: customExtensionEndpointConfiguration
      type: object
      additionalProperties:
        type: object
    microsoft.graph.customExtensionBehaviorOnError:
      title: customExtensionBehaviorOnError
      type: object
      additionalProperties:
        type: object
    microsoft.graph.customAuthenticationExtensionCollectionResponse:
      title: Collection of customAuthenticationExtension
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.customCalloutExtension:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: customCalloutExtension
        type: object
        properties:
          authenticationConfiguration:
            $ref: '#/components/schemas/microsoft.graph.customExtensionAuthenticationConfiguration'
          clientConfiguration:
            $ref: '#/components/schemas/microsoft.graph.customExtensionClientConfiguration'
          description:
            type:
            - string
            - 'null'
            description: Description for the customCalloutExtension object.
          displayName:
            type:
            - string
            - 'null'
            description: Display name for the customCalloutExtension object.
          endpointConfiguration:
            $ref: '#/components/schemas/microsoft.graph.customExtensionEndpointConfiguration'
        additionalProperties:
          type: object
    microsoft.graph.genericError:
      title: genericError
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
          description: The error code.
        message:
          type:
          - string
          - 'null'
          description: The error message.
      additionalProperties:
        type: object
    microsoft.graph.customExtensionClientConfiguration:
      title: customExtensionClientConfiguration
      type: object
      properties:
        maximumRetries:
          maximum: 2147483647
          minimum: -2147483648
          type:
          - number
          - 'null'
          description: The max number of retries that Microsoft Entra ID makes to the external API. Values of 0 or 1 are supported. If null, the default for the service applies.
          format: int32
        timeoutInMilliseconds:
          maximum: 2147483647
          minimum: -2147483648
          type:
          - number
          - 'null'
          description: The max duration in milliseconds that Microsoft Entra ID waits for a response from the external app before it shuts down the connection. The valid range is between 200 and 2000 milliseconds. Default duration is 1000.
          format: int32
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          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.customExtensionAuthenticationConfiguration:
      title: customExtensionAuthenticationConfiguration
      type: object
      additionalProperties:
        type: object
    microsoft.graph.customAuthenticationExtension:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
      - title: customAuthenticationExtension
        type: object
        properties:
          behaviorOnError:
            $ref: '#/components/schemas/microsoft.graph.customExtensionBehaviorOnError'
        additionalProperties:
          type: object
    ODataCountResponse:
      type: integer
      format: int32
  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.customAuthenticationExtensionCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.customAuthenticationExtensionCollectionResponse'
  parameters:
    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
    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
  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: {}