Compartilhar via


Manage account profiles - Get all available roles

Obtém todas as funções disponíveis.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
version
path True

string

Versão da API.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Token de portador de autorização

Accept True

string

Tipo de conteúdo aceitável; aplicativo/json de tipo amplamente accepeted

ms-correlationid

string

Usado para acompanhar solicitações internamente. Se um ms-correlationid não for fornecido, o servidor gerará um novo para cada solicitação

ms-requestid

string

Usado para idempotência de solicitações. Se um ms-requestid não for fornecido, o servidor gerará um novo para cada solicitação

Respostas

Nome Tipo Description
200 OK

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

A solicitação foi bem-sucedida. O corpo da resposta contém a lista de funções com suporte.

Media Types: "application/json", "text/json"

400 Bad Request

Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro.

Media Types: "application/json", "text/json"

401 Unauthorized

A solicitação não foi autenticada. O cliente precisa se autenticar com o serviço de API do parceiro primeiro.

Media Types: "application/json", "text/json"

403 Forbidden

A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la.

Media Types: "application/json", "text/json"

404 Not Found

O recurso não foi encontrado ou não está disponível com os parâmetros de entrada fornecidos.

Media Types: "application/json", "text/json"

500 Internal Server Error

O serviço de API do parceiro ou uma de suas dependências falhou ao atender à solicitação. Os chamadores podem repetir isso.

Media Types: "application/json", "text/json"

Definições

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

Contém uma coleção de recursos com propriedades JSON para representar a saída

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

Link representa um URI e o método HTTP que indica a ação desejada para acessar o recurso.

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

Refere-se aos atributos de objeto comuns

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

Links de navegação para o recurso

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

Representa um objeto de função usado como um contrato para operações de função.

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

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

Contém uma coleção de recursos com propriedades JSON para representar a saída

Nome Tipo Description
attributes

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

Obtém os atributos.

items

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

Obtém os itens da coleção.

links

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

Obtém ou define os links.

totalCount

integer

Obtém a contagem total.

Link representa um URI e o método HTTP que indica a ação desejada para acessar o recurso.

Nome Tipo Description
headers

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

Obtém os cabeçalhos de link.

method

string

O método.

uri

string

O URI.

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

Refere-se aos atributos de objeto comuns

Nome Tipo Description
etag

string

Obtém ou define a etag. A versão do objeto em provedores.

objectType

string

O tipo de objeto.

Links de navegação para o recurso

Nome Tipo Description
next

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

A próxima página de itens.

previous

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

A página anterior de itens.

self

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

O auto-URI.

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

Representa um objeto de função usado como um contrato para operações de função.

Nome Tipo Description
attributes

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

Obtém os atributos.

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

Obtém ou define a categoria da função.

id

string

Obtém ou define a ID da função.

links

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

Obtém ou define os links.

name

string

Obtém ou define o nome da função.

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

Nome Tipo Description
key

string

value

string