Manage customer accounts - Get users for a customer

Usługa:

Partner Center Rest

Wersja interfejsu API:

v1

GET https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/users

Z parametrami opcjonalnymi:

GET https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/users?size={size}&SortField={SortField}&SortDirection={SortDirection}&seekOperation={seekOperation}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
customer_id	path	True	string	Identyfikator dzierżawy klienta.
seekOperation	query		string	Operacja wyszukiwania wykonywana na użytkownikach klienta. Microsoft.Partner.Providers.All.Contracts.Query.SeekOperation.
size	query		integer int32	Maksymalna liczba użytkowników do zwrócenia.
SortDirection	query		string
SortField	query		string

Nagłówek żądania

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token elementu nośnego autoryzacji
ms-correlationid		string	Służy do śledzenia żądań wewnętrznie. Jeśli nie podano identyfikatora ms-correlationid, serwer wygeneruje nowy dla każdego żądania
ms-cv		string	Służy do śledzenia żądań wewnętrznie. Jeśli nie podano ms-cv, serwer wygeneruje nowy dla każdego żądania
ms-requestid		string	Służy do idempotentności żądań. Jeśli nie podano identyfikatora ms-requestid, serwer wygeneruje nowy dla każdego żądania

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Microsoft.Partner.Core.Collections.PagedResourceCollection[Microsoft.Partner.Providers.Contracts.V1.CustomerUser]	Żądanie zakończyło się pomyślnie. Treść odpowiedzi zawiera listę użytkowników klientów, którzy są zgodni z segmentem filtru lub żądanych użytkowników klienta, wraz z tokenem kontynuacji dla dalszych żądań wyszukiwania. Media Types: "application/json", "text/json"

Definicje

Nazwa	Opis
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.PagedResourceCollection[Microsoft.Partner.Providers.Contracts.V1.CustomerUser]
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Providers.Contracts.V1.CustomerUser
Microsoft.Partner.Providers.Contracts.V1.PasswordProfile
System.Collections.Generic.KeyValuePair[System.String,System.String]
System.Security.SecureString

Microsoft.Partner.Core.Collections.Link

Nazwa	Typ	Opis
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.PagedResourceCollection[Microsoft.Partner.Providers.Contracts.V1.CustomerUser]

Nazwa	Typ	Opis
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
continuationToken	string
items	Microsoft.Partner.Providers.Contracts.V1.CustomerUser[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer

Microsoft.Partner.Core.Collections.ResourceAttributes

Nazwa	Typ	Opis
etag	string
objectType	string

Microsoft.Partner.Core.Collections.ResourceLinks

Nazwa	Typ	Opis
next	Microsoft.Partner.Core.Collections.Link
previous	Microsoft.Partner.Core.Collections.Link
self	Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Providers.Contracts.V1.CustomerUser

Nazwa	Typ	Opis
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
displayName	string
firstName	string
id	string
immutableId	string
lastDirectorySyncTime	string
lastName	string
links	Microsoft.Partner.Core.Collections.ResourceLinks
passwordProfile	Microsoft.Partner.Providers.Contracts.V1.PasswordProfile
phoneNumber	string
softDeletionTime	string
state	enum: active inactive
usageLocation	string
userDomainType	enum: federated managed none
userPrincipalName	string

Microsoft.Partner.Providers.Contracts.V1.PasswordProfile

Nazwa	Typ	Opis
forceChangePassword	boolean
password	System.Security.SecureString

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

Nazwa	Typ	Opis
key	string
value	string

System.Security.SecureString

Nazwa	Typ	Opis
length	integer