Manage customer accounts - Get users for a customer

  • Referenz
Dienst:
Partner Center Rest
API-Version:
v1 
GET https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/users
Mit optionalen Parametern: 
GET https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/users?size={size}&SortField={SortField}&SortDirection={SortDirection}&seekOperation={seekOperation}

URI-Parameter

Name In Erforderlich Typ Beschreibung
customer_id
 path True

string

Die Kundenmandanten-ID.
seekOperation
 query

string

Der Suchvorgang, der für die Benutzer des Kunden ausgeführt werden soll. Microsoft.Partner.Providers.All.Contracts.Query.SeekOperation.
size
 query

integer

int32

Die maximale Anzahl von Kundenbenutzern, die zurückgegeben werden sollen.
SortDirection
 query

string

SortField
 query

string

Anforderungsheader

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

Name Erforderlich Typ Beschreibung
Authorization True

string

Autorisierungs-Bearertoken
ms-correlationid

string

Wird intern zum Nachverfolgen von Anforderungen verwendet. Wenn keine ms-correlationid angegeben wird, generiert der Server für jede Anforderung eine neue.
ms-cv

string

Wird intern zum Nachverfolgen von Anforderungen verwendet. Wenn kein ms-cv bereitgestellt wird, generiert der Server für jede Anforderung eine neue.
ms-requestid

string

Wird für die Idempotenz von Anforderungen verwendet. Wenn keine ms-requestid angegeben wird, generiert der Server für jede Anforderung eine neue anforderung.

Antworten

Name Typ Beschreibung
200 OK

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

Die Anforderung war erfolgreich. Der Antworttext enthält eine Liste von Kundenbenutzern, die dem Filter oder dem Benutzersegment des angeforderten Kunden entsprechen, wird zusammen mit einem Fortsetzungstoken für weitere Suchanforderungen zurückgegeben.

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

Definitionen

Name Beschreibung
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
Name Typ Beschreibung
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]

Name Typ Beschreibung
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

Name Typ Beschreibung
etag

string

objectType

string

Name Typ Beschreibung
next

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Providers.Contracts.V1.CustomerUser

Name Typ Beschreibung
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

Name Typ Beschreibung
forceChangePassword

boolean

password

System.Security.SecureString

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

Name Typ Beschreibung
key

string

value

string

System.Security.SecureString

Name Typ Beschreibung
length

integer