Manage account profiles - Get user members by role
Gets a segment of a role's user members capped to a specific size.
GET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembersGET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembers?size={size}&sortField={sortField}&sortDirection={sortDirection}&seekOperation={seekOperation}URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
role_id
|
path | True |
string |
The role identifier. |
|
version
|
path | True |
string |
Api version. |
|
seek
|
query |
string |
The seek operation to perform on the role's user members.This is useful in paging scenarios where the next or previous pages of user members is needed. |
|
|
size
|
query |
integer int32 |
The maximum number of user members to return, value should not be over 500 and should not be lower than 1 |
|
|
sort
|
query |
string |
An optional sorting parameter for the direction to sort by, values accepted are Ascending and Descending, default is Ascending |
|
|
sort
|
query |
string |
An optional sorting parameter for the field to sort by, values accepted are DisplayName and UserPrincipalName, default is UserPrincipalName. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True |
string |
Authorization Bearer token |
| Accept | True |
string |
Acceptable content type; widely accepeted type application/json |
| ms-correlationid |
string |
Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request |
|
| ms-requestid |
string |
Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The request was successful. The response body contains the list of user members. Media Types: "application/json", "text/json" |
|
| 400 Bad Request |
There was a missing or an invalid input. The response body will provide the error details. Media Types: "application/json", "text/json" |
|
| 401 Unauthorized |
The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "application/json", "text/json" |
|
| 403 Forbidden |
The request was authenticated but was refused since the caller does not have the rights to invoke it. Media Types: "application/json", "text/json" |
|
| 404 Not Found |
The resource is not found or not available with the given input parameters. Media Types: "application/json", "text/json" |
|
| 500 Internal Server Error |
The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this. Media Types: "application/json", "text/json" |
Definitions
| Name | Description |
|---|---|
|
Microsoft. |
Contains a collection of resources with JSON properties to represent the output |
|
Microsoft. |
Link represents a URI and the HTTP method which indicates the desired action for accessing the resource. |
|
Microsoft. |
Refers to the common object attributes |
|
Microsoft. |
Navigation links for the resource |
|
Microsoft. |
Describes a user's member information. |
|
System. |
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]
Contains a collection of resources with JSON properties to represent the output
| Name | Type | Description |
|---|---|---|
| attributes |
Microsoft. |
Gets the attributes. |
| items |
Microsoft. |
Gets the collection items. |
| links |
Gets or sets the links. |
|
| totalCount |
integer |
Gets the total count. |
Microsoft.Partner.Sdk.Contracts.V1.Common.Link
Link represents a URI and the HTTP method which indicates the desired action for accessing the resource.
| Name | Type | Description |
|---|---|---|
| headers |
System. |
Gets the link headers. |
| method |
string |
The method. |
| uri |
string |
The URI. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes
Refers to the common object attributes
| Name | Type | Description |
|---|---|---|
| etag |
string |
Gets or sets the etag. The object version in providers. |
| objectType |
string |
The type of object. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks
Navigation links for the resource
| Name | Type | Description |
|---|---|---|
| next |
The next page of items. |
|
| previous |
The previous page of items. |
|
| self |
The self uri. |
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember
Describes a user's member information.
| Name | Type | Description |
|---|---|---|
| accountId |
string |
Gets or sets the account id where role assignment is tied. |
| attributes |
Microsoft. |
Gets the attributes. |
| displayName |
string |
Gets or sets the display name for the user. |
| id |
string |
The identifier of the member. |
| roleId |
string |
The identifier of the user's role. |
| userPrincipalName |
string |
Gets or sets the name of the user principal. |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Name | Type | Description |
|---|---|---|
| key |
string |
|
| value |
string |