Group User - List

Reference

Service:: API Management

API Version:: 2024-05-01

Lists a collection of user entities associated with the group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users?api-version=2024-05-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
groupId	path	True	string	Group identifier. Must be unique in the current API Management service instance.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.
$filter	query		string	\| 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 \|
$skip	query		integer int32	Number of records to skip.
$top	query		integer int32	Number of records to return.

Responses

Name	Type	Description
200 OK	UserCollection	Lists a collection of user entities associated with the group.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementListGroupUsers

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/57d2ef278aa04f0888cba3f3/users?api-version=2024-05-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/kjoshiarmTemplateUser1",
      "type": "Microsoft.ApiManagement/service/groups/users",
      "name": "armTemplateUser1",
      "properties": {
        "firstName": "user1",
        "lastName": "lastname1",
        "email": "user1@live.com",
        "state": "active",
        "registrationDate": "2017-05-31T18:54:41.447Z",
        "note": "note for user 1",
        "identities": [
          {
            "provider": "Basic",
            "id": "user1@live.com"
          }
        ]
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GroupContractProperties	Group contract Properties.
GroupType	Group type.
UserCollection	Paged Users list representation.
UserContract	User details.
UserIdentityContract	User identity details.
UserState	Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

GroupContractProperties

Group contract Properties.

Name	Type	Description
builtIn	boolean	true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
description	string	Group description. Can contain HTML formatting tags.
displayName	string	Group name.
externalId	string	For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.
type	GroupType	Group type.

GroupType

Group type.

Name	Type	Description
custom	string
external	string
system	string

UserCollection

Paged Users list representation.

Name	Type	Description
count	integer	Total record count number across all pages.
nextLink	string	Next page link if any.
value	UserContract[]	Page values.

UserContract

User details.

Name	Type	Default value	Description
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		The name of the resource
properties.email	string		Email address.
properties.firstName	string		First name.
properties.groups	GroupContractProperties[]		Collection of groups user is part of.
properties.identities	UserIdentityContract[]		Collection of user identities.
properties.lastName	string		Last name.
properties.note	string		Optional note about a user set by the administrator.
properties.registrationDate	string		Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
properties.state	UserState	active	Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

UserIdentityContract

User identity details.

Name	Type	Description
id	string	Identifier value within provider.
provider	string	Identity provider name.

UserState

Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.

Name	Type	Description
active	string	User state is active.
blocked	string	User is blocked. Blocked users cannot authenticate at developer portal or call API.
deleted	string	User account is closed. All identities and related entities are removed.
pending	string	User account is pending. Requires identity confirmation before it can be made active.

Share via