Compartir a través de


Manage account profiles - Get user members by role

Obtiene un segmento de los miembros de usuario de un rol limitado a un tamaño específico.

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}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
role_id
path True

string

Identificador del rol.

version
path True

string

Versión de api.

seekOperation
query

string

Operación seek que se va a realizar en los miembros del usuario del rol. Esto resulta útil en escenarios de paginación en los que se necesitan las páginas siguientes o anteriores de los miembros del usuario.

size
query

integer

int32

El número máximo de miembros de usuario que se van a devolver, el valor no debe ser superior a 500 y no debe ser inferior a 1.

sortDirection
query

string

Un parámetro de ordenación opcional para la dirección por la que se va a ordenar, los valores aceptados son ascendentes y descendentes, el valor predeterminado es Ascendente.

sortField
query

string

Un parámetro de ordenación opcional para que el campo se ordene por, los valores aceptados son DisplayName y UserPrincipalName, el valor predeterminado es UserPrincipalName.

Encabezado de la solicitud

Nombre Requerido Tipo Description
Authorization True

string

Token de portador de autorización

Accept True

string

Tipo de contenido aceptable; aplicación/json de tipo ampliamente accepeted

ms-correlationid

string

Se usa para realizar el seguimiento de solicitudes internamente. Si no se proporciona un valor ms-correlationid, el servidor generará uno nuevo para cada solicitud.

ms-requestid

string

Se usa para la idempotencia de las solicitudes. Si no se proporciona un ms-requestid, el servidor generará uno nuevo para cada solicitud.

Respuestas

Nombre Tipo Description
200 OK

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

La solicitud fue correcta. El cuerpo de la respuesta contiene la lista de miembros del usuario.

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

400 Bad Request

Faltaba o faltaba una entrada no válida. El cuerpo de la respuesta proporcionará los detalles del error.

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

401 Unauthorized

La solicitud no se ha autenticado. El cliente debe autenticarse primero con el servicio de API de asociado.

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

403 Forbidden

La solicitud se autenticó pero se rechazó, ya que el autor de la llamada no tiene los derechos para invocarla.

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

404 Not Found

El recurso no se encuentra o no está disponible con los parámetros de entrada especificados.

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

500 Internal Server Error

El servicio de API del asociado o una de sus dependencias no pudo cumplir la solicitud. Los autores de llamadas pueden reintentar esto.

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

Definiciones

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

Contiene una colección de recursos con propiedades JSON para representar la salida.

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

Link representa un URI y el método HTTP que indica la acción deseada para acceder al recurso.

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

Hace referencia a los atributos de objeto comunes

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

Vínculos de navegación para el recurso

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

Describe la información de miembro de un usuario.

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

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

Contiene una colección de recursos con propiedades JSON para representar la salida.

Nombre Tipo Description
attributes

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

Obtiene los atributos.

items

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

Obtiene los elementos de la colección.

links

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

Obtiene o establece los vínculos.

totalCount

integer

Obtiene el recuento total.

Link representa un URI y el método HTTP que indica la acción deseada para acceder al recurso.

Nombre Tipo Description
headers

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

Obtiene los encabezados de vínculo.

method

string

Método.

uri

string

Identificador URI.

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

Hace referencia a los atributos de objeto comunes

Nombre Tipo Description
etag

string

Obtiene o establece la etag. Versión del objeto en proveedores.

objectType

string

Tipo del objeto.

Vínculos de navegación para el recurso

Nombre Tipo Description
next

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

Página siguiente de elementos.

previous

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

Página anterior de elementos.

self

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

El autouri.

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

Describe la información de miembro de un usuario.

Nombre Tipo Description
accountId

string

Obtiene o establece el identificador de cuenta donde está vinculada la asignación de roles.

attributes

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

Obtiene los atributos.

displayName

string

Obtiene o establece el nombre para mostrar del usuario.

id

string

Identificador del miembro.

roleId

string

Identificador del rol del usuario.

userPrincipalName

string

Obtiene o establece el nombre de la entidad de seguridad de usuario.

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

Nombre Tipo Description
key

string

value

string