Поделиться через

Manage customer accounts - Get users for a customer

  • Ссылка
Служба:
Partner Center Rest
Версия API:
v1 
GET https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/users
С использованием необязательных параметров: 
GET https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/users?size={size}&SortField={SortField}&SortDirection={SortDirection}&seekOperation={seekOperation}

Параметры URI

Имя В Обязательно Тип Описание
customer_id
 path True

string

Идентификатор клиента.
seekOperation
 query

string

Операция поиска для выполнения пользователей клиента. Microsoft.Partner.Providers.All.Contracts.Query.SeekOperation.
size
 query

integer

int32

Максимальное количество возвращаемых пользователей клиента.
SortDirection
 query

string

SortField
 query

string

Заголовок запроса

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

Имя Обязательно Тип Описание
Authorization True

string

Маркер носителя авторизации
ms-correlationid

string

Используется для отслеживания запросов внутри системы. Если ms-correlationid не указан, сервер создаст новый для каждого запроса.
ms-cv

string

Используется для отслеживания запросов внутри системы. Если ms-cv не предоставлено, сервер создаст новый для каждого запроса.
ms-requestid

string

Используется для идемпотентности запросов. Если ms-requestid не указан, сервер создаст новый для каждого запроса.

Ответы

Имя Тип Описание
200 OK

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

Запрос выполнен успешно. Текст ответа содержит список пользователей, соответствующих фильтру или запрошенному сегменту пользователей клиента, возвращается вместе с маркером продолжения для дальнейших запросов на поиск.

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

Определения

Имя Описание
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
Имя Тип Описание
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]

Имя Тип Описание
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

Имя Тип Описание
etag

string

objectType

string

Имя Тип Описание
next

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Providers.Contracts.V1.CustomerUser

Имя Тип Описание
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

Имя Тип Описание
forceChangePassword

boolean

password

System.Security.SecureString

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

Имя Тип Описание
key

string

value

string

System.Security.SecureString

Имя Тип Описание
length

integer