User - Get Shared Access Token

Obtém o token de autorização de acesso compartilhado para o usuário.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token?api-version=2021-08-01

Parâmetros de URI

Name In Required Type Description
resourceGroupName
path True
  • string

O nome do grupo de recursos.

serviceName
path True
  • string

O nome do serviço Gerenciamento de API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Credenciais de assinatura que identificam exclusivamente Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.

userId
path True
  • string

Identificador do usuário. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente.

Corpo da solicitação

Name Required Type Description
properties.expiry True
  • string

A hora de expiração do token. O tempo máximo de expiração do token é definido como 30 dias. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

properties.keyType True

A chave a ser usada para gerar token para o usuário.

Respostas

Name Type Description
200 OK

O corpo da resposta contém o token de autorização para o usuário.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementUserToken

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId1718/token?api-version=2021-08-01

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

Sample Response

{
  "value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

Definições

ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta de erro.

KeyType

A chave a ser usada para gerar token para o usuário.

UserTokenParameters

Obter parâmetros do Token de Usuário.

UserTokenResult

Obter detalhes da resposta do Token de Usuário.

ErrorFieldContract

Contrato de Campo de Erro.

Name Type Description
code
  • string

Código de erro no nível da propriedade.

message
  • string

Representação legível de erro no nível da propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Type Description
error.code
  • string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

error.details

A lista de campos inválidos enviados na solicitação, em caso de erro de validação.

error.message
  • string

Representação legível ao olho humano do erro.

KeyType

A chave a ser usada para gerar token para o usuário.

Name Type Description
primary
  • string
secondary
  • string

UserTokenParameters

Obter parâmetros do Token de Usuário.

Name Type Default Value Description
properties.expiry
  • string

A hora de expiração do token. O tempo máximo de expiração do token é definido como 30 dias. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

properties.keyType primary

A chave a ser usada para gerar token para o usuário.

UserTokenResult

Obter detalhes da resposta do Token de Usuário.

Name Type Description
value
  • string

Token de Autorização de Acesso Compartilhado para o Usuário.