Partager via


User - Get Shared Access Token

Obtient le jeton d’autorisation d’accès partagé pour l’utilisateur.

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

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
path True

string

Nom du groupe de ressources.

serviceName
path True

string

Nom du service Gestion des API.

Modèle d’expression régulière: ^[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 l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

userId
path True

string

Identificateur de l'utilisateur. Doit être unique dans le instance de service Gestion des API actuel.

api-version
query True

string

Version de l’API à utiliser avec la demande cliente.

Corps de la demande

Nom Obligatoire Type Description
properties.expiry True

string

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

properties.keyType True

KeyType

Clé à utiliser pour générer un jeton pour l’utilisateur.

Réponses

Nom Type Description
200 OK

UserTokenResult

Le corps de la réponse contient le jeton d’autorisation de l’utilisateur.

Other Status Codes

ErrorResponse

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

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementUserToken

Exemple de requête

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"
  }
}

Exemple de réponse

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

Définitions

Nom Description
ErrorFieldContract

Contrat champ d’erreur.

ErrorResponse

Réponse d’erreur.

KeyType

Clé à utiliser pour générer un jeton pour l’utilisateur.

UserTokenParameters

Obtenez les paramètres du jeton utilisateur.

UserTokenResult

Obtenez les détails de la réponse du jeton utilisateur.

ErrorFieldContract

Contrat champ d’erreur.

Nom Type Description
code

string

Code d'erreur de niveau propriété.

message

string

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

target

string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom 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

ErrorFieldContract[]

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.

error.message

string

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

KeyType

Clé à utiliser pour générer un jeton pour l’utilisateur.

Nom Type Description
primary

string

secondary

string

UserTokenParameters

Obtenez les paramètres du jeton utilisateur.

Nom Type Valeur par défaut Description
properties.expiry

string

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

properties.keyType

KeyType

primary

Clé à utiliser pour générer un jeton pour l’utilisateur.

UserTokenResult

Obtenez les détails de la réponse du jeton utilisateur.

Nom Type Description
value

string

Jeton d’autorisation d’accès partagé pour l’utilisateur.