Gateway - Generate Token

Obtient le jeton d’autorisation d’accès partagé pour la passerelle.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken?api-version=2021-01-01-preview

Paramètres URI

Name In Required Type Description
gatewayId
path True
  • string

Identificateur d’entité de la passerelle. Doit être unique dans l’instance actuelle du service gestion des API. Ne doit pas avoir la valeur’Managed'

resourceGroupName
path True
  • string

Nom du groupe de ressources.

serviceName
path True
  • string

Nom du service gestion des API.

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

subscriptionId
path True
  • string

Informations d’identification d’abonnement qui identifient de manière unique Microsoft Azure abonnement. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True
  • string

Version de l’API à utiliser avec la demande du client.

Corps de la demande

Name Required Type Description
expiry True
  • string

Heure d’expiration du jeton. Le délai d’expiration maximal du jeton est défini sur 30 jours. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.

keyType True

Clé à utiliser pour générer le jeton de passerelle.

Réponses

Name Type Description
200 OK

Le corps de la réponse contient le jeton d’autorisation pour la passerelle.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2.

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

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementGatewayGenerateToken

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/generateToken?api-version=2021-01-01-preview
{
  "keyType": "primary",
  "expiry": "2020-04-21T00:44:24.2845269Z"
}

Sample Response

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

Définitions

ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

GatewayTokenContract

Jeton d’accès de la passerelle.

GatewayTokenRequestContract

Propriétés du contrat de demande de jeton de la passerelle.

KeyType

Clé à utiliser pour générer le jeton de passerelle.

ErrorFieldContract

Contrat de champ d’erreur.

Name Type Description
code
  • string

Code d'erreur de niveau propriété.

message
  • string

Représentation lisible de l’erreur au niveau de la propriété.

target
  • string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Name Type Description
error.code
  • string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

La liste des champs non valides est envoyée dans la demande, en cas d’erreur de validation.

error.message
  • string

Représentation contrôlable de visu de l’erreur.

GatewayTokenContract

Jeton d’accès de la passerelle.

Name Type Description
value
  • string

Valeur du jeton d’authentification d’accès partagé pour la passerelle.

GatewayTokenRequestContract

Propriétés du contrat de demande de jeton de la passerelle.

Name Type Description
expiry
  • string

Heure d’expiration du jeton. Le délai d’expiration maximal du jeton est défini sur 30 jours. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.

keyType

Clé à utiliser pour générer le jeton de passerelle.

KeyType

Clé à utiliser pour générer le jeton de passerelle.

Name Type Description
primary
  • string
secondary
  • string