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


Manage account profiles - Get all available roles

Возвращает все доступные роли.

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

Параметры URI

Имя В Обязательно Тип Описание
version
path True

string

Версия API.

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

Имя Обязательно Тип Описание
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.Role]

Запрос выполнен успешно. Текст ответа содержит список поддерживаемых ролей.

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.Role]

Содержит коллекцию ресурсов со свойствами 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.Role

Представляет объект роли, используемый в качестве контракта для операций роли.

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

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

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

Имя Тип Описание
attributes

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

Возвращает атрибуты.

items

Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.Role[]

Возвращает элементы коллекции.

links

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

Возвращает или задает ссылки.

totalCount

integer

Возвращает общее число.

Ссылка представляет 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

Тип объекта.

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

Имя Тип Описание
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.Role

Представляет объект роли, используемый в качестве контракта для операций роли.

Имя Тип Описание
attributes

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

Возвращает атрибуты.

category enum:
  • account_admin
  • developer
  • incentive
  • marketing
  • mpn
  • partner_agent
  • publisher
  • referrals
  • tenant

Возвращает или задает категорию роли.

id

string

Возвращает или задает идентификатор роли.

links

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

Возвращает или задает ссылки.

name

string

Возвращает или задает имя роли.

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

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

string

value

string