Microsoft Azure

Azure API Management: Apimusers

Use these REST APIs for performing operations on User entity in Azure API Management deployment. The User entity in API Management represents the developers…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Use these REST APIs for performing operations on User entity in Azure API Management deployment. The User entity in API Management represents the developers that call the APIs of the products to which they are subscribed.

Endpoints 13

User

  • GETUser_ListByService/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users?$filter=string&expandGroups=trueLists a collection of registered users in the specified service instance.
  • GETUser_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userIdGets the details of the user specified by its identifier.
  • PUTUser_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userId?notify=trueCreates or Updates a user.
  • DELETEUser_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userId?deleteSubscriptions=true&notify=trueDeletes specific user.
  • HEADUser_GetEntityTag/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userIdGets the entity state (Etag) version of the user specified by its identifier.
  • PATCHUser_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userIdUpdates the details of the user specified by its identifier.

Users

  • POSTUser_GenerateSsoUrl/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userId/generateSsoUrlRetrieves a redirection URL containing an authentication token for signing a given user into the developer portal.

UserGroup

  • GETUserGroup_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userId/groups?$filter=stringLists all user groups.

UserSubscription

  • GETUserSubscription_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userId/subscriptions?$filter=stringLists the collection of subscriptions of the specified user.

Subscription

  • GETUserSubscription_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userId/subscriptions/:sidGets the specified Subscription entity associated with a particular user.

UserIdentity

  • GETUserIdentities_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userId/identitiesList of all user identities.

UserToken

  • POSTUser_GetSharedAccessToken/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userId/tokenGets the Shared Access Authorization Token for the User.

UserConfirmationPasswordSend

  • POSTUserConfirmationPassword_Send/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users/:userId/confirmations/password/sendSends confirmation

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
13 operations on 9 pathsGET 6POST 3PUT 1HEAD 1PATCH 1DELETE 1
Main resources
User 6Subscription 1UserConfirmationPasswordSend 1UserGroup 1UserIdentity 1UserSubscription 1UserToken 1Users 1
Response formats
application/json
Description format
Swagger 2.0, API version 2024-05-01

How to test the Azure API Management: Apimusers in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure API Management: Apimusers collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “User_ListByService” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/users?$filter=string&expandGroups=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure API Management: Apimusers?

Use these REST APIs for performing operations on User entity in Azure API Management deployment. The User entity in API Management represents the developers… It is listed under Developer tools and has 13 endpoints.

Who publishes the Azure API Management: Apimusers?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure API Management: Apimusers?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure API Management: Apimusers?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure API Management: Apimusers have?

13 operations on 9 paths (6 GET, 3 POST, 1 PUT, 1 HEAD, 1 PATCH, 1 DELETE). The largest groups are User, Subscription, UserConfirmationPasswordSend, UserGroup.

Is forking the Azure API Management: Apimusers free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.