User Identities

Service:
API Management
API Version:
2017-03-01

Lists all user identities.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/identities&api-version={api-version}
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/identities?$skip={$skip}&$top={$top}&api-version={api-version}

URI Parameters

Name In Required Type Description
subscriptionId
 path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
resourceGroupName
 path True
  • string

The name of the resource group.
serviceName
 path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
uid
 path True
  • string

User identifier. Must be unique in the current API Management service instance.

Regex pattern: ^[^*#&+:<>?]+$
$skip
 query
  • integer
    int32
Number of records to skip.
$top
 query
  • integer
    int32
Number of records to return.
api-version
 query True
  • string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

Lists of User Identities.
Other Status Codes

Error response describing why the operation failed.

Examples

ApiManagementListUsersIdentities

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57f2af53bb17172280f44057/identities&api-version=2017-03-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "provider": "Microsoft",
      "id": "086cf9********55ab"
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definitions

ErrorFieldContract

Error Field contract.
ErrorResponse
UserIdentityCollection
UserIdentityContract

User identity details.

Error Field contract.

Name Type Description
code
  • string

Property level error code.
message
  • string

Human-readable representation of property-level error.
target
  • string

Property name.
Name Type Description
code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
details

The list of invalid fields send in request, in case of validation error.
message
  • string

Human-readable representation of the error.
Name Type Description
count
  • integer
    int64

Total record count number across all pages.
nextLink
  • string

Next page link if any.
value

User Identity values.

User identity details.

Name Type Description
id
  • string

Identifier value within provider.
provider
  • string

Identity provider name.