Manage account profiles - Get user members by role
Ottiene un segmento dei membri utente di un ruolo con estensione limitata a una dimensione specifica.
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}Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
role_id
|
path | True |
string |
Identificatore del ruolo. |
|
version
|
path | True |
string |
Versione dell'API. |
|
seek
|
query |
string |
Operazione di ricerca da eseguire sui membri utente del ruolo. Ciò è utile negli scenari di paging in cui sono necessarie le pagine successive o precedenti dei membri dell'utente. |
|
|
size
|
query |
integer int32 |
Il numero massimo di membri utente da restituire, il valore non deve essere superiore a 500 e non deve essere inferiore a 1 |
|
|
sort
|
query |
string |
Un parametro di ordinamento facoltativo per la direzione da ordinare, i valori accettati sono Crescente e Decrescente, il valore predefinito è Crescente |
|
|
sort
|
query |
string |
Un parametro di ordinamento facoltativo per il campo da ordinare, i valori accettati sono DisplayName e UserPrincipalName, il valore predefinito è UserPrincipalName. |
Intestazione della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| Authorization | True |
string |
Token di connessione dell'autorizzazione |
| Accept | True |
string |
Tipo di contenuto accettabile; applicazione/json di tipo ampiamente accepeted |
| ms-correlationid |
string |
Usato per il rilevamento delle richieste internamente. Se non viene specificato un ms-correlationid, il server genererà un nuovo oggetto per ogni richiesta |
|
| ms-requestid |
string |
Usato per la idempotenza delle richieste. Se non viene fornito un ms-requestid, il server genererà un nuovo oggetto per ogni richiesta |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
La richiesta è stata completata. Il corpo della risposta contiene l'elenco dei membri dell'utente. Media Types: "application/json", "text/json" |
|
| 400 Bad Request |
Non è stato presente un input mancante o non valido. Il corpo della risposta fornirà i dettagli dell'errore. Media Types: "application/json", "text/json" |
|
| 401 Unauthorized |
La richiesta non è stata autenticata. Per prima cosa, il client deve eseguire l'autenticazione con il servizio API partner. Media Types: "application/json", "text/json" |
|
| 403 Forbidden |
La richiesta è stata autenticata, ma è stata rifiutata perché il chiamante non ha i diritti per richiamarlo. Media Types: "application/json", "text/json" |
|
| 404 Not Found |
La risorsa non viene trovata o non disponibile con i parametri di input specificati. Media Types: "application/json", "text/json" |
|
| 500 Internal Server Error |
Il servizio API partner o una delle relative dipendenze non è riuscita a soddisfare la richiesta. I chiamanti possono riprovare. Media Types: "application/json", "text/json" |
Definizioni
| Nome | Descrizione |
|---|---|
|
Microsoft. |
Contiene una raccolta di risorse con proprietà JSON per rappresentare l'output |
|
Microsoft. |
Il collegamento rappresenta un URI e il metodo HTTP che indica l'azione desiderata per l'accesso alla risorsa. |
|
Microsoft. |
Si riferisce agli attributi comuni degli oggetti |
|
Microsoft. |
Collegamenti di spostamento per la risorsa |
|
Microsoft. |
Descrive le informazioni del membro di un utente. |
|
System. |
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]
Contiene una raccolta di risorse con proprietà JSON per rappresentare l'output
| Nome | Tipo | Descrizione |
|---|---|---|
| attributes |
Microsoft. |
Ottiene gli attributi. |
| items |
Microsoft. |
Ottiene gli elementi della raccolta. |
| links |
Ottiene o imposta i collegamenti. |
|
| totalCount |
integer |
Ottiene il conteggio totale. |
Microsoft.Partner.Sdk.Contracts.V1.Common.Link
Il collegamento rappresenta un URI e il metodo HTTP che indica l'azione desiderata per l'accesso alla risorsa.
| Nome | Tipo | Descrizione |
|---|---|---|
| headers |
System. |
Ottiene le intestazioni di collegamento. |
| method |
string |
Metodo. |
| uri |
string |
URI. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes
Si riferisce agli attributi comuni degli oggetti
| Nome | Tipo | Descrizione |
|---|---|---|
| etag |
string |
Ottiene o imposta l'etag. Versione dell'oggetto nei provider. |
| objectType |
string |
Tipo di oggetto. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks
Collegamenti di spostamento per la risorsa
| Nome | Tipo | Descrizione |
|---|---|---|
| next |
Pagina successiva degli elementi. |
|
| previous |
Pagina precedente di elementi. |
|
| self |
URI self. |
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember
Descrive le informazioni del membro di un utente.
| Nome | Tipo | Descrizione |
|---|---|---|
| accountId |
string |
Ottiene o imposta l'ID dell'account in cui l'assegnazione di ruolo è associata. |
| attributes |
Microsoft. |
Ottiene gli attributi. |
| displayName |
string |
Ottiene o imposta il nome visualizzato per l'utente. |
| id |
string |
Identificatore del membro. |
| roleId |
string |
Identificatore del ruolo dell'utente. |
| userPrincipalName |
string |
Ottiene o imposta il nome dell'entità utente. |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Nome | Tipo | Descrizione |
|---|---|---|
| key |
string |
|
| value |
string |