Sdílet prostřednictvím

Manage account profiles - Get user members by role

  • Reference
Služba:
Partner Center Rest
Verze rozhraní API:
v1

Získá segment členů uživatele role omezený na určitou velikost.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
role_id
 path True

string

Identifikátor role.
version
 path True

string

Verze rozhraní API.
seekOperation
 query

string

Operace hledání, která se má provést u členů uživatele role. To je užitečné ve scénářích stránkování, kde je potřeba další nebo předchozí stránky členů uživatele.
size
 query

integer

int32

Maximální počet členů uživatele, kteří se mají vrátit, by neměl být větší než 500 a neměl by být nižší než 1.
sortDirection
 query

string

Volitelný parametr řazení pro směr řazení podle, hodnoty přijaté vzestupně a sestupně, výchozí hodnota je Vzestupně
sortField
 query

string

Volitelný parametr řazení pro pole, podle které se má řadit, hodnoty akceptované jsou DisplayName a UserPrincipalName, výchozí hodnota je UserPrincipalName.

Hlavička požadavku

Name Vyžadováno Typ Description
Authorization True

string

Autorizační nosný token
Accept True

string

Přijatelný typ obsahu; široce accepeted type application/json
ms-correlationid

string

Používá se pro interní sledování požadavků. Pokud není zadaný parametr ms-correlationid, server pro každý požadavek vygeneruje nový.
ms-requestid

string

Používá se k idempotenci požadavků. Pokud není zadaný identifikátor ms-requestid, server pro každý požadavek vygeneruje nový.

Odpovědi

Name Typ Description
200 OK

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

Požadavek byl úspěšný. Text odpovědi obsahuje seznam členů uživatele.

Media Types: "application/json", "text/json"
400 Bad Request

Došlo k chybě nebo neplatnému vstupu. Text odpovědi poskytne podrobnosti o chybě.

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

Požadavek nebyl ověřen. Klient se musí nejprve ověřit ve službě partnerského rozhraní API.

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

Žádost byla ověřena, ale byla odmítnuta, protože volající nemá práva k jeho vyvolání.

Media Types: "application/json", "text/json"
404 Not Found

Prostředek nebyl nalezen nebo není k dispozici s danými vstupními parametry.

Media Types: "application/json", "text/json"
500 Internal Server Error

Službě partnerského rozhraní API nebo některé z jejích závislostí se nepodařilo splnit požadavek. Volající to možná zkusí znovu.

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

Definice

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

Obsahuje kolekci prostředků s vlastnostmi JSON, které představují výstup.
Microsoft.Partner.Sdk.Contracts.V1.Common.Link

Odkaz představuje identifikátor URI a metodu HTTP, která označuje požadovanou akci pro přístup k prostředku.
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes

Odkazuje na běžné atributy objektu.
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks

Navigační odkazy pro prostředek
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember

Popisuje informace o členech uživatele.
System.Collections.Generic.KeyValuePair[System.String,System.String]

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

Objekt

Obsahuje kolekci prostředků s vlastnostmi JSON, které představují výstup.

Name Typ Description
attributes

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

Získá atributy.
items

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

Získá položky kolekce.
links

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

Získá nebo nastaví odkazy.
totalCount

integer

Získá celkový počet.
Objekt

Odkaz představuje identifikátor URI a metodu HTTP, která označuje požadovanou akci pro přístup k prostředku.

Name Typ Description
headers

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

Získá záhlaví odkazu.
method

string

Metoda.
uri

string

Identifikátor URI.

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

Objekt

Odkazuje na běžné atributy objektu.

Name Typ Description
etag

string

Získá nebo nastaví značku etag. Verze objektu ve zprostředkovatelích.
objectType

string

Typ objektu.
Objekt

Navigační odkazy pro prostředek

Name Typ Description
next

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

Další stránka položek
previous

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

Předchozí stránka položek.
self

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

Identifikátor URI sebe sama.

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

Objekt

Popisuje informace o členech uživatele.

Name Typ Description
accountId

string

Získá nebo nastaví ID účtu, kde je přiřazení role svázané.
attributes

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

Získá atributy.
displayName

string

Získá nebo nastaví zobrazované jméno uživatele.
id

string

Identifikátor člena.
roleId

string

Identifikátor role uživatele.
userPrincipalName

string

Získá nebo nastaví název objektu zabezpečení uživatele.

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

Objekt
Name Typ Description
key

string

value

string