Manage account profiles - Get user members by role
Obtém um segmento dos membros de usuário de uma função limitados a um tamanho específico.
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}Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
role_id
|
path | True |
string |
O identificador de função. |
|
version
|
path | True |
string |
Versão da API. |
|
seek
|
query |
string |
A operação de busca a ser executada nos membros usuários da função. Isso é útil em cenários de paginação em que as páginas seguintes ou anteriores dos membros do usuário são necessárias. |
|
|
size
|
query |
integer int32 |
O número máximo de membros de usuário a retornar, valor não deve ser superior a 500 e não deve ser inferior a 1 |
|
|
sort
|
query |
string |
Um parâmetro de classificação opcional para a direção de classificação, os valores aceitos são Ascendente e Descendente, o padrão é Ascendente |
|
|
sort
|
query |
string |
Um parâmetro de classificação opcional para o campo para classificar, os valores aceitos são DisplayName e UserPrincipalName, o padrão é UserPrincipalName. |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| Authorization | True |
string |
Token de portador de autorização |
| Accept | True |
string |
Tipo de conteúdo aceitável; Aplicação/JSON do tipo amplamente acessado |
| ms-correlationid |
string |
Usado para rastrear 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
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
O pedido foi bem-sucedido. O corpo da resposta contém a lista de membros do usuário. 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 |
O pedido não foi autenticado. O cliente precisa se autenticar com o serviço de API do parceiro primeiro. Media Types: "application/json", "text/json" |
|
| 403 Forbidden |
O pedido foi autenticado, mas foi recusado, uma vez que o autor da chamada não tem o direito de o invocar. Media Types: "application/json", "text/json" |
|
| 404 Not Found |
O recurso não é 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 não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Media Types: "application/json", "text/json" |
Definições
| Name | Description |
|---|---|
|
Microsoft. |
Contém uma coleção de recursos com propriedades JSON para representar a saída |
|
Microsoft. |
Link representa um URI e o método HTTP que indica a ação desejada para acessar o recurso. |
|
Microsoft. |
Refere-se aos atributos de objeto comuns |
|
Microsoft. |
Links de navegação para o recurso |
|
Microsoft. |
Descreve as informações de membro de um usuário. |
|
System. |
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]
Contém uma coleção de recursos com propriedades JSON para representar a saída
| Name | Tipo | Description |
|---|---|---|
| attributes |
Microsoft. |
Obtém os atributos. |
| items |
Microsoft. |
Obtém os itens da coleção. |
| links |
Obtém ou define os links. |
|
| totalCount |
integer |
Obtém a contagem total. |
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.
| Name | Tipo | Description |
|---|---|---|
| headers |
System. |
Obtém os cabeçalhos dos links. |
| method |
string |
O método. |
| uri |
string |
O URI. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes
Refere-se aos atributos de objeto comuns
| Name | Tipo | Description |
|---|---|---|
| etag |
string |
Obtém ou define o etag. A versão do objeto em provedores. |
| objectType |
string |
O tipo de objeto. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks
Links de navegação para o recurso
| Name | Tipo | Description |
|---|---|---|
| next |
A próxima página de itens. |
|
| previous |
A página anterior de itens. |
|
| self |
O self uri. |
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember
Descreve as informações de membro de um usuário.
| Name | Tipo | Description |
|---|---|---|
| accountId |
string |
Obtém ou define a ID da conta onde a atribuição de função está vinculada. |
| attributes |
Microsoft. |
Obtém os atributos. |
| displayName |
string |
Obtém ou define o nome para exibição do usuário. |
| id |
string |
O identificador do membro. |
| roleId |
string |
O identificador da função do usuário. |
| userPrincipalName |
string |
Obtém ou define o nome da entidade de usuário. |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Name | Tipo | Description |
|---|---|---|
| key |
string |
|
| value |
string |