Manage customer accounts - Get users for a customer

Service:

Partner Center Rest

API Version:

v1

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
customer_id	path	True	string	The customer tenant id.
seekOperation	query		string	The seek operation to perform on the customer's users. Microsoft.Partner.Providers.All.Contracts.Query.SeekOperation.
size	query		integer int32	The maximum number of customer users to return.
SortDirection	query		string
SortField	query		string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Authorization Bearer token
ms-correlationid		string	Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request
ms-cv		string	Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request
ms-requestid		string	Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Responses

Name	Type	Description
200 OK	Microsoft.Partner.Core.Collections.PagedResourceCollection[Microsoft.Partner.Providers.Contracts.V1.CustomerUser]	The request was successful. The response body contains a list of customer users that match the filter or requested customer's users segment is returned along with a continuation token for further seek requests. Media Types: "application/json", "text/json"

Definitions

Name	Description
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

Name	Type	Description
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	Type	Description
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	Type	Description
etag	string
objectType	string

Microsoft.Partner.Core.Collections.ResourceLinks

Name	Type	Description
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	Type	Description
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	Type	Description
forceChangePassword	boolean
password	System.Security.SecureString

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

Name	Type	Description
key	string
value	string

System.Security.SecureString

Name	Type	Description
length	integer