Manage account profiles - Get user members by role

Ссылка

Служба:: Partner Center Rest

Версия API:: v1

Возвращает сегмент элементов пользователя роли, привязанных к определенному размеру.

GET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembers

С использованием необязательных параметров:

GET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembers?size={size}&sortField={sortField}&sortDirection={sortDirection}&seekOperation={seekOperation}

Параметры URI

Имя	В	Обязательно	Тип	Описание
role_id	path	True	string	Идентификатор роли.
version	path	True	string	Версия API.
seekOperation	query		string	Операция поиска для выполнения для членов пользователя роли. Это полезно в сценариях разбиения на страницы, где необходимы следующие или предыдущие страницы участников пользователя.
size	query		integer int32	Максимальное количество возвращаемых пользователей, значение не должно превышать 500 и не должно быть меньше 1
sortDirection	query		string	Необязательный параметр сортировки для направления сортировки по, значения, принятые по возрастанию и убыванию, по умолчанию — по возрастанию
sortField	query		string	Необязательный параметр сортировки поля для сортировки по значению — DisplayName и UserPrincipalName, по умолчанию — UserPrincipalName.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Authorization	True	string	Маркер носителя авторизации
Accept	True	string	Допустимый тип контента; приложение типа или json с расширенным доступом
ms-correlationid		string	Используется для отслеживания запросов внутри системы. Если ms-correlationid не указан, сервер создаст новый для каждого запроса.
ms-requestid		string	Используется для идемпотентности запросов. Если ms-requestid не указан, сервер создаст новый для каждого запроса.

Ответы

Имя	Тип	Описание
200 OK	Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]	Запрос выполнен успешно. Текст ответа содержит список участников пользователя. Media Types: "application/json", "text/json"
400 Bad Request		Отсутствуют или недопустимые входные данные. Текст ответа предоставит сведения об ошибке. Media Types: "application/json", "text/json"
401 Unauthorized		Запрос не прошел проверку подлинности. Сначала клиент должен пройти проверку подлинности с помощью службы API партнеров. Media Types: "application/json", "text/json"
403 Forbidden		Запрос прошел проверку подлинности, но был отклонен, так как вызывающий объект не имеет прав на его вызов. Media Types: "application/json", "text/json"
404 Not Found		Ресурс не найден или недоступен с заданными входными параметрами. Media Types: "application/json", "text/json"
500 Internal Server Error		Служба API партнера или одна из зависимостей не выполнила запрос. Вызывающие могут повторить это. Media Types: "application/json", "text/json"

Определения

Имя	Описание
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]	Содержит коллекцию ресурсов со свойствами JSON для представления выходных данных
Microsoft.Partner.Sdk.Contracts.V1.Common.Link	Ссылка представляет URI и метод HTTP, указывающий требуемое действие для доступа к ресурсу.
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	Относится к общим атрибутам объекта
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks	Ссылки навигации для ресурса
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember	Описывает сведения о членах пользователя.
System.Collections.Generic.KeyValuePair[System.String,System.String]

Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]

Содержит коллекцию ресурсов со свойствами JSON для представления выходных данных

Имя	Тип	Описание
attributes	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	Возвращает атрибуты.
items	Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember[]	Возвращает элементы коллекции.
links	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks	Возвращает или задает ссылки.
totalCount	integer	Возвращает общее число.

Microsoft.Partner.Sdk.Contracts.V1.Common.Link

Ссылка представляет URI и метод HTTP, указывающий требуемое действие для доступа к ресурсу.

Имя	Тип	Описание
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]	Возвращает заголовки ссылок.
method	string	Метод.
uri	string	Универсальный код ресурса (URI).

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes

Относится к общим атрибутам объекта

Имя	Тип	Описание
etag	string	Возвращает или задает etag. Версия объекта в поставщиках.
objectType	string	Тип объекта.

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks

Ссылки навигации для ресурса

Имя	Тип	Описание
next	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	Следующая страница элементов.
previous	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	Предыдущая страница элементов.
self	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	Самоуправляемый код ресурса (URI).

Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember

Описывает сведения о членах пользователя.

Имя	Тип	Описание
accountId	string	Возвращает или задает идентификатор учетной записи, в которой привязано назначение роли.
attributes	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	Возвращает атрибуты.
displayName	string	Возвращает или задает отображаемое имя пользователя.
id	string	Идентификатор элемента.
roleId	string	Идентификатор роли пользователя.
userPrincipalName	string	Возвращает или задает имя участника-пользователя.

System.Collections.Generic.KeyValuePair[System.String,System.String]

Имя	Тип	Описание
key	string
value	string

Поделиться через