APIHub
Back to Explore

ApiManagementClient

Use these REST APIs for performing operations on Group entity in your Azure API Management deployment. Groups are used to manage the visibility of products to developers. Each API Management service instance comes with the following immutable system groups whose membership is automatically managed by API Management. - **Administrators** - Azure subscription administrators are members of this group

Cloud
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users

Lists a collection of user entities associated with the group.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • groupId (path, required) — Group identifier. Must be unique in the current API Management service instance.
  • $filter (query) — | Field | Usage | Supported operators | Supported functions | |-------------|-------------|-------------|-------------| | name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | registrationDate | filter | ge, le, eq, ne, gt, lt | | | note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
  • $top (query, limit) — Number of records to return.
  • $skip (query, offset) — Number of records to skip.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}

Remove existing user from existing group.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • groupId (path, required) — Group identifier. Must be unique in the current API Management service instance.
  • userId (path, required) — User identifier. Must be unique in the current API Management service instance.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups

Lists a collection of groups defined within a service instance.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • $filter (query) — | Field | Usage | Supported operators | Supported functions | |-------------|-------------|-------------|-------------| | name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | aadObjectId | filter | eq | |
  • $top (query, limit) — Number of records to return.
  • $skip (query, offset) — Number of records to skip.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}

Deletes specific group of the API Management service instance.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • groupId (path, required) — Group identifier. Must be unique in the current API Management service instance.
  • If-Match (header, required) — ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}

Gets the details of the group specified by its identifier.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • groupId (path, required) — Group identifier. Must be unique in the current API Management service instance.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}

Gets the entity state (Etag) version of the group specified by its identifier.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • groupId (path, required) — Group identifier. Must be unique in the current API Management service instance.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}

Updates the details of the group specified by its identifier.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • groupId (path, required) — Group identifier. Must be unique in the current API Management service instance.
  • If-Match (header, required) — ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}

Creates or Updates a group.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • groupId (path, required) — Group identifier. Must be unique in the current API Management service instance.
  • If-Match (header) — ETag of the Entity. Not required when creating an entity, but required when updating an entity.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}

Checks that user entity specified by identifier is associated with the group entity.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • groupId (path, required) — Group identifier. Must be unique in the current API Management service instance.
  • userId (path, required) — User identifier. Must be unique in the current API Management service instance.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}

Add existing user to existing group

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • groupId (path, required) — Group identifier. Must be unique in the current API Management service instance.
  • userId (path, required) — User identifier. Must be unique in the current API Management service instance.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

10 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users"

management.azure.com · HTTPS only