Microsoft Azure API Management User API

The User API from Microsoft Azure API Management — 3 operation(s) for user.

Operations 7

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 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users List registered users · Microsoft Azure API Management User_ListByService #
Ask an LLM
“Which developers are registered on my API Management service?”
“Can I pull the full list of users signed up to my service instance?”
Tell an agent
List all registered users on my {serviceName} API Management service.
Show me every developer account on the service.
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId} Get a user's ETag version · Microsoft Azure API Management User_GetEntityTag #
Ask an LLM
“Can I read a user's ETag before updating their account?”
“Does a user with a given ID exist on my service?”
Tell an agent
Check the ETag of user {userId} on service {serviceName}.
Confirm this user account exists from its entity state header.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId} Get a user's details · Microsoft Azure API Management User_Get #
Ask an LLM
“How do I look up one registered developer's account details?”
“What email, name and state does a specific user have?”
Tell an agent
Get the account details of user {userId} in {serviceName}.
Look up this developer's account on the service.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId} Create or replace a user · Microsoft Azure API Management User_CreateOrUpdate #
Ask an LLM
“How do I register a new developer account on my service?”
“Can I create a user with a specific ID, or overwrite an existing one?”
Tell an agent
Create or fully replace developer user {userId} on my {serviceName} service.
Create or fully replace this user account.
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId} Update a user's details · Microsoft Azure API Management User_Update #
Ask an LLM
“Can I change a user's name or email without recreating the account?”
“Is it possible to block a developer by updating their account state?”
Tell an agent
Patch user {userId} in {serviceName} with new profile details.
Block this developer by updating their account state.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId} Delete a user · Microsoft Azure API Management User_Delete #
Ask an LLM
“How can I remove a developer account from API Management?”
“Is deleting a registered user permanent?”
Tell an agent destructive · confirm first
Delete user {userId} from service {serviceName} permanently.
Remove this developer account permanently.
GET /profile Open my developer portal profile · User profile and subscriptions #
Ask an LLM
“Where in the developer portal do I manage my own subscriptions and API keys?”
“Can I see my profile page with my keys in the Azure API Management developer portal?”
Tell an agent
Open my developer portal profile page.
Show me my portal profile with my subscriptions and API keys.

Documentation

Specifications

SDKs

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-chat-completion-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-chat-completion-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-completion-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-completion-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-embedding-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-embedding-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-mcp-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-mcp-response-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-chat-completion-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-chat-completion-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-completion-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-completion-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-embedding-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-embedding-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-mcp-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-mcp-response-structure.json

Other Resources

🔗
SDKs
https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resourcemanager/apimanagement
🔗
Tutorials
https://learn.microsoft.com/en-us/azure/api-management/transform-api
🔗
PolicySnippets
https://github.com/Azure/api-management-policy-snippets
🔗
Tools
https://github.com/Azure/azure-api-management-policy-toolkit
🔗
HelmChart
https://github.com/Azure/api-management-self-hosted-gateway/tree/main/helm-charts/azure-api-management-gateway
🔗
MCPServerOverview
https://learn.microsoft.com/en-us/azure/api-management/mcp-server-overview
🔗
ExportRESTToMCP
https://learn.microsoft.com/en-us/azure/api-management/export-rest-mcp-server
🔗
ProxyExistingMCP
https://learn.microsoft.com/en-us/azure/api-management/expose-existing-mcp-server
🔗
A2AAgentAPI
https://learn.microsoft.com/en-us/azure/api-management/agent-to-agent-api
🔗
TokenLimitPolicy
https://learn.microsoft.com/en-us/azure/api-management/llm-token-limit-policy
🔗
SemanticCaching
https://learn.microsoft.com/en-us/azure/api-management/azure-openai-enable-semantic-caching
🔗
ContentSafetyPolicy
https://learn.microsoft.com/en-us/azure/api-management/llm-content-safety-policy
🔗
ReferenceArchitecture
https://github.com/Azure-Samples/ai-hub-gateway-solution-accelerator
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-ld/microsoft-azure-api-management-ai-gateway-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-chat-completion-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-chat-completion-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-completion-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-completion-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-embedding-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-embedding-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-mcp-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-mcp-response-example.json
🔗
Tutorials
https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal-customize

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/microsoft-azure-api-management:microsoft-azure-api-management-user-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.

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

OpenAPI Specification

microsoft-azure-api-management-user-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Microsoft Azure Api Management User API
  version: '2024-05-01'
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  description: 'Operations tagged User across 2 of this provider''s published API definitions: microsoft-azure-api-management-rest-api-openapi.yaml, microsoft-azure-api-management-developer-portal-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
- url: https://{service-name}.developer.azure-api.net
tags:
- name: User
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users
  : get:
      summary: Microsoft Azure API Management User_ListByService
      operationId: User_ListByService
      description: Lists a collection of registered users in the specified service instance.
      responses:
        '200':
          description: Success
      tags:
      - User
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}
  : head:
      summary: Microsoft Azure API Management User_GetEntityTag
      operationId: User_GetEntityTag
      description: Gets the entity state (Etag) version of the user specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - User
      security:
      - azure_auth:
        - user_impersonation
    get:
      summary: Microsoft Azure API Management User_Get
      operationId: User_Get
      description: Gets the details of the user specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - User
      security:
      - azure_auth:
        - user_impersonation
    put:
      summary: Microsoft Azure API Management User_CreateOrUpdate
      operationId: User_CreateOrUpdate
      description: Creates or Updates a user.
      responses:
        '200':
          description: Success
      tags:
      - User
      security:
      - azure_auth:
        - user_impersonation
    patch:
      summary: Microsoft Azure API Management User_Update
      operationId: User_Update
      description: Updates the details of the user specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - User
      security:
      - azure_auth:
        - user_impersonation
    delete:
      summary: Microsoft Azure API Management User_Delete
      operationId: User_Delete
      description: Deletes specific user.
      responses:
        '200':
          description: Success
      tags:
      - User
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
  /profile:
    get:
      summary: User profile and subscriptions
      operationId: DevPortal_Profile
      tags:
      - User
      description: Returns the user profile page with subscription and API key management.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: User profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfile'
              examples:
                UserProfileExample:
                  summary: User profile
                  value:
                    id: user-001
                    firstName: Jane
                    lastName: Developer
                    email: jane.developer@contoso.com
                    registrationDate: '2024-01-15T10:30:00Z'
                    subscriptions:
                    - id: sub-abc123
                      productName: Starter
                      state: active
                      primaryKey: '********************************'
              x-microcks-default:
                id: user-001
                firstName: Jane
                lastName: Developer
    servers:
    - url: https://{service-name}.developer.azure-api.net
components:
  schemas:
    UserProfile:
      type: object
      properties:
        id:
          type: string
          example: user-001
        firstName:
          type: string
          example: Jane
        lastName:
          type: string
          example: Developer
        email:
          type: string
          example: jane.developer@contoso.com
        registrationDate:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00Z'
        subscriptions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: sub-abc123
              productName:
                type: string
                example: Starter
              state:
                type: string
                example: active
              primaryKey:
                type: string
                example: '********************************'
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account
x-refined-from:
- microsoft-azure-api-management-rest-api-openapi.yaml
- microsoft-azure-api-management-developer-portal-openapi.yaml