User - Get
Возвращает сведения о пользователе, заданном его идентификатором.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2022-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
service
|
path | True |
string |
Имя службы Управление API. Шаблон регулярного выражения: |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
user
|
path | True |
string |
Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы Управление API. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Возвращает указанную сущность пользователя. Заголовки ETag: string |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementGetUser
Образец запроса
Пример ответа
{
"id": "/subscriptions/subid/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": "*************"
}
]
}
}
Определения
Имя | Описание |
---|---|
Error |
Контракт поля ошибки. |
Error |
Ответ на ошибку. |
Group |
Свойства контракта группы. |
Group |
Тип группы. |
User |
Сведения о пользователе. |
User |
Сведения об удостоверении пользователя. |
User |
Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно. |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойства. |
message |
string |
Понятное представление ошибки на уровне свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ на ошибку.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое представление ошибки. |
GroupContractProperties
Свойства контракта группы.
Имя | Тип | Описание |
---|---|---|
builtIn |
boolean |
true, если группа является одной из трех системных групп (администраторы, разработчики или гости); в противном случае — false. |
description |
string |
Описание группы. Может содержать теги форматирования HTML. |
displayName |
string |
Имя группы. |
externalId |
string |
Для внешних групп это свойство содержит идентификатор группы из внешнего поставщика удостоверений, например для Azure Active Directory |
type |
Тип группы. |
GroupType
Тип группы.
Имя | Тип | Описание |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |
UserContract
Сведения о пользователе.
Имя | Тип | Default value | Описание |
---|---|---|---|
id |
string |
Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
name |
string |
Имя ресурса. |
|
properties.email |
string |
Электронная почта. |
|
properties.firstName |
string |
Имя. |
|
properties.groups |
Коллекция групп пользователей является частью. |
||
properties.identities |
Коллекция удостоверений пользователей. |
||
properties.lastName |
string |
Фамилия. |
|
properties.note |
string |
Дополнительное примечание о пользователе, заданном администратором. |
|
properties.registrationDate |
string |
Дата регистрации пользователя. Дата соответствует следующему формату: |
|
properties.state | active |
Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно. |
|
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
UserIdentityContract
Сведения об удостоверении пользователя.
Имя | Тип | Описание |
---|---|---|
id |
string |
Значение идентификатора в поставщике. |
provider |
string |
Имя поставщика удостоверений. |
UserState
Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно.
Имя | Тип | Описание |
---|---|---|
active |
string |
Состояние пользователя активно. |
blocked |
string |
Пользователь заблокирован. Заблокированные пользователи не могут пройти проверку подлинности на портале разработчика или вызвать API. |
deleted |
string |
Учетная запись пользователя закрыта. Удаляются все удостоверения и связанные сущности. |
pending |
string |
Учетная запись пользователя находится в состоянии ожидания. Прежде чем сделать его активным, требуется подтверждение удостоверения. |