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

User - Get Shared Access Token

  • Ссылка
Служба:
API Management
Версия API:
2024-05-01

Возвращает маркер авторизации общего доступа для пользователя.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token?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, используемая для этой операции.

Текст запроса

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

string (date-time)

Время истечения срока действия маркера. Максимальное время истечения срока действия маркера — 30 дней. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ, как указано в стандарте ISO 8601.
properties.keyType True

KeyType

Ключ, используемый для создания маркера для пользователя.

Ответы

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

UserTokenResult

Текст ответа содержит маркер авторизации для пользователя.
Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementUserToken

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

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

{
  "properties": {
    "keyType": "primary",
    "expiry": "2019-04-21T00:44:24.2845269Z"
  }
}

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

Код состояния:
200 
{
  "value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

Определения

Имя Описание
ErrorAdditionalInfo

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

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

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

Ключ, используемый для создания маркера для пользователя.
UserTokenParameters

Получение параметров маркера пользователя.
UserTokenResult

Получение сведений об ответе маркера пользователя.

ErrorAdditionalInfo

Object

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

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

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

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

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

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

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

ErrorDetail

Объект ошибки.

KeyType

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

Ключ, используемый для создания маркера для пользователя.

Значение Описание
primary
secondary

UserTokenParameters

Object

Получение параметров маркера пользователя.

Имя Тип Default value Описание
properties.expiry

string (date-time)

Время истечения срока действия маркера. Максимальное время истечения срока действия маркера — 30 дней. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ, как указано в стандарте ISO 8601.
properties.keyType

KeyType

primary

Ключ, используемый для создания маркера для пользователя.

UserTokenResult

Object

Получение сведений об ответе маркера пользователя.

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

string

Маркер авторизации общего доступа для пользователя.