Manage account profiles - Get user members by role

Referens

Tjänst:: Partner Center Rest

API-version:: v1

Hämtar ett segment av en rolls användarmedlemmar som är begränsade till en viss storlek.

GET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembers

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
role_id	path	True	string	Rollidentifieraren.
version	path	True	string	Api-version.
seekOperation	query		string	Sökåtgärden som ska utföras på rollens användarmedlemmar. Detta är användbart i växlingsscenarier där nästa eller föregående sidor av användarmedlemmar behövs.
size	query		integer int32	Det maximala antalet användarmedlemmar som ska returneras, värdet ska inte vara över 500 och får inte vara lägre än 1
sortDirection	query		string	En valfri sorteringsparameter för riktningen som ska sorteras efter, värden som accepteras är Stigande och Fallande, standardvärdet är Stigande
sortField	query		string	En valfri sorteringsparameter för fältet som ska sorteras efter, värden som accepteras är DisplayName och UserPrincipalName, standardvärdet är UserPrincipalName.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Token för auktoriseringsbärare
Accept	True	string	Godkänd innehållstyp; brett accepeted typprogram/json
ms-correlationid		string	Används för att spåra begäranden internt. Om ett ms-correlationid inte anges genererar servern en ny för varje begäran
ms-requestid		string	Används för idempotens för begäranden. Om ett ms-requestid inte har angetts genererar servern en ny för varje begäran

Svar

Name	Typ	Description
200 OK	Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]	Begäran lyckades. Svarstexten innehåller listan över användarmedlemmar. Media Types: "application/json", "text/json"
400 Bad Request		Det saknades eller ogiltiga indata. Svarstexten innehåller felinformationen. Media Types: "application/json", "text/json"
401 Unauthorized		Begäran autentiserades inte. Klienten måste autentisera med partner-API-tjänsten först. Media Types: "application/json", "text/json"
403 Forbidden		Begäran autentiserades men nekades eftersom anroparen inte har behörighet att anropa den. Media Types: "application/json", "text/json"
404 Not Found		Resursen hittades inte eller är inte tillgänglig med de angivna indataparametrarna. Media Types: "application/json", "text/json"
500 Internal Server Error		Partner-API-tjänsten eller något av dess beroenden kunde inte uppfylla begäran. Anropare kan försöka igen. Media Types: "application/json", "text/json"

Definitioner

Name	Description
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]	Innehåller en samling resurser med JSON-egenskaper som representerar utdata
Microsoft.Partner.Sdk.Contracts.V1.Common.Link	Link representerar en URI och HTTP-metoden som anger önskad åtgärd för åtkomst till resursen.
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	Refererar till de vanliga objektattributen
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks	Navigeringslänkar för resursen
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember	Beskriver en användares medlemsinformation.
System.Collections.Generic.KeyValuePair[System.String,System.String]

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

Innehåller en samling resurser med JSON-egenskaper som representerar utdata

Name	Typ	Description
attributes	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	Hämtar attributen.
items	Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember[]	Hämtar samlingsobjekten.
links	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks	Hämtar eller anger länkarna.
totalCount	integer	Hämtar det totala antalet.

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

Link representerar en URI och HTTP-metoden som anger önskad åtgärd för åtkomst till resursen.

Name	Typ	Description
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]	Hämtar länkrubrikerna.
method	string	Metoden.
uri	string	URI:n.

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

Refererar till de vanliga objektattributen

Name	Typ	Description
etag	string	Hämtar eller anger etag. Objektversionen i providers.
objectType	string	Typ av objekt.

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

Navigeringslänkar för resursen

Name	Typ	Description
next	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	Nästa sida med objekt.
previous	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	Föregående sida med objekt.
self	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	Själv-uri.

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

Beskriver en användares medlemsinformation.

Name	Typ	Description
accountId	string	Hämtar eller anger konto-ID:t där rolltilldelningen är knuten.
attributes	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	Hämtar attributen.
displayName	string	Hämtar eller anger visningsnamnet för användaren.
id	string	Medlemmens identifierare.
roleId	string	Identifieraren för användarens roll.
userPrincipalName	string	Hämtar eller anger namnet på användarens huvudnamn.

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

Name	Typ	Description
key	string
value	string

Dela via