User - Get Shared Access Token
Возвращает маркер авторизации общего доступа для пользователя.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token?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, используемая для данной операции. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
properties.expiry | True |
string |
Время окончания срока действия маркера. Максимальный срок действия маркера — 30 дней. Дата соответствует следующему формату: |
properties.keyType | True |
Ключ, используемый для создания маркера для пользователя. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Текст ответа содержит маркер авторизации для пользователя. |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementUserToken
Образец запроса
Пример ответа
{
"value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}
Определения
Имя | Описание |
---|---|
Error |
Контракт поля ошибки. |
Error |
Ответ об ошибке. |
Key |
Ключ, используемый для создания маркера для пользователя. |
User |
Получение параметров маркера пользователя. |
User |
Получение сведений об ответе маркера пользователя. |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойства. |
message |
string |
Удобочитаемое представление ошибки на уровне свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ об ошибке.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое представление ошибки. |
KeyType
Ключ, используемый для создания маркера для пользователя.
Имя | Тип | Описание |
---|---|---|
primary |
string |
|
secondary |
string |
UserTokenParameters
Получение параметров маркера пользователя.
Имя | Тип | Default value | Описание |
---|---|---|---|
properties.expiry |
string |
Время окончания срока действия маркера. Максимальный срок действия маркера — 30 дней. Дата соответствует следующему формату: |
|
properties.keyType | primary |
Ключ, используемый для создания маркера для пользователя. |
UserTokenResult
Получение сведений об ответе маркера пользователя.
Имя | Тип | Описание |
---|---|---|
value |
string |
Маркер авторизации общего доступа для пользователя. |