Sdílet prostřednictvím


Manage account profiles - Get user members by role

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

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}

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ánka členů uživatele.

size
query

integer

int32

Maximální počet uživatelských členů, které se mají vrátit, hodnota by neměla být vyšší než 500 a neměla by být nižší než 1.

sortDirection
query

string

Volitelný parametr řazení pro směr řazení, podle které se má řadit, přijaté hodnoty jsou Vzestupně a Sestupně, výchozí hodnota je Vzestupně.

sortField
query

string

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

Hlavička požadavku

Name Vyžadováno Typ Description
Authorization True

string

Nosný token autorizace

Accept True

string

Přijatelný typ obsahu; široce používaný typ application/json

ms-correlationid

string

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

ms-requestid

string

Používá se pro idempotenci požadavků. Pokud není zadaný identifikátor ms-requestid, server pro každou žádost 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živatelů.

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

400 Bad Request

Chybí nebo je neplatný vstup. 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

Požadavek byl ověřen, ale byl odmítnut, protože volající nemá práva k jeho vyvolání.

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

404 Not Found

Prostředek se s danými vstupními parametry nenašel nebo není k dispozici.

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 požadavek splnit. Volající to můžou zkusit 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 společ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]

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.

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

Odkazuje na společné atributy objektu.

Name Typ Description
etag

string

Získá nebo nastaví etag. Verze objektu ve zprostředkovatelích.

objectType

string

Typ objektu.

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 vlastního počítače

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

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 pro uživatele.

id

string

Identifikátor členu.

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]

Name Typ Description
key

string

value

string