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

Lists a collection of registered users in the specified 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 | | 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 | | state | filter | eq | | | registrationDate | filter | ge, le, eq, ne, gt, lt | | | note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | groups | expand | | |
• $top (query, limit) — Number of records to return.
• $skip (query, offset) — Number of records to skip.
• expandGroups (query) — Detailed Group in response.
• 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.

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

Deletes specific user.

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• userId (path, required) — User identifier. Must be unique in the current API Management service instance.
• deleteSubscriptions (query) — Whether to delete user's subscription or not.
• notify (query) — Send an Account Closed Email notification to the User.
• 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.

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

Gets the details of the user specified by its identifier.

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• 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.

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

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

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• 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.

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

Updates the details of the user specified by its identifier.

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• userId (path, required) — User 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.

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

Creates or Updates a user.

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• userId (path, required) — User 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.

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/confirmations/password/send

Sends confirmation

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• 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.

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

Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• 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.

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

Lists all user groups.

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• userId (path, required) — User 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 | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | 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.

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

List of all user identities.

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• 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.

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

Lists the collection of subscriptions of the specified user.

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• userId (path, required) — User 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 | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | 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.

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

Gets the Shared Access Authorization Token for the User.

• resourceGroupName (path, required) — The name of the resource group.
• serviceName (path, required) — The name of the API Management service.
• 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.