User - Get

Ссылка

Служба:: API Management

Версия API:: 2024-05-01

Возвращает сведения о пользователе, указанном идентификатором.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2024-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
userId	path	True	string minLength: 1 maxLength: 80	Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы управления API.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	UserContract	Возвращает указанную сущность пользователя. Заголовки ETag: string
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

UserContract

Возвращает указанную сущность пользователя.

Заголовки

ETag: string

Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementGetUser

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b?api-version=2024-05-01

Пример ответа

Код состояния:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2017-06-02T17:58:50.357Z",
    "identities": [
      {
        "provider": "Microsoft",
        "id": "*************"
      }
    ]
  }
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GroupContractProperties	Свойства контракта группы.
GroupType	Тип группы.
UserContract	Сведения о пользователе.
UserIdentityContract	Сведения об удостоверениях пользователя.
UserState	Состояние учетной записи. Указывает, является ли пользователь активным или нет. Заблокированные пользователи не могут войти на портал разработчика или вызвать все API подписываемых продуктов. Состояние по умолчанию — "Активный".

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

GroupContractProperties

Object

Свойства контракта группы.

Имя	Тип	Описание
builtIn	boolean	значение true, если группа является одной из трех системных групп (администраторы, разработчики или гости); в противном случае значение false.
description	string maxLength: 1000	Описание группы. Может содержать теги форматирования HTML.
displayName	string minLength: 1 maxLength: 300	Имя группы.
externalId	string	Для внешних групп это свойство содержит идентификатор группы из внешнего поставщика удостоверений, например для Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; в противном случае значение равно NULL.
type	GroupType	Тип группы.

GroupType

Перечисление

Тип группы.

Значение	Описание
custom
external
system

UserContract

Object

Сведения о пользователе.

Имя	Тип	Default value	Описание
id	string		Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Имя ресурса
properties.email	string		Адрес электронной почты.
properties.firstName	string		Имя.
properties.groups	GroupContractProperties[]		Коллекция пользователей групп является частью.
properties.identities	UserIdentityContract[]		Коллекция удостоверений пользователей.
properties.lastName	string		Фамилия.
properties.note	string		Необязательное примечание о пользователе, заданном администратором.
properties.registrationDate	string (date-time)		Дата регистрации пользователя. Дата соответствует следующему формату: `yyyy-MM-ddTHH:mm:ssZ`, как указано в стандарте ISO 8601.
properties.state	UserState	active	Состояние учетной записи. Указывает, является ли пользователь активным или нет. Заблокированные пользователи не могут войти на портал разработчика или вызвать все API подписываемых продуктов. Состояние по умолчанию — "Активный".
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

UserIdentityContract

Object

Сведения об удостоверениях пользователя.

Имя	Тип	Описание
id	string	Значение идентификатора в поставщике.
provider	string	Имя поставщика удостоверений.

UserState

Перечисление

Состояние учетной записи. Указывает, является ли пользователь активным или нет. Заблокированные пользователи не могут войти на портал разработчика или вызвать все API подписываемых продуктов. Состояние по умолчанию — "Активный".

Значение	Описание
active	Состояние пользователя активно.
blocked	Пользователь заблокирован. Заблокированные пользователи не могут пройти проверку подлинности на портале разработчика или в API вызова.
deleted	Учетная запись пользователя закрыта. Все удостоверения и связанные сущности удаляются.
pending	Учетная запись пользователя ожидается. Требуется подтверждение удостоверения, прежде чем его можно будет активировать.

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

User - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

ApiManagementGetUser

Образец запроса

Пример ответа

Определения

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserIdentityContract

UserState

Дополнительные ресурсы