User - Get Shared Access Token

Service:

API Management

Version d'API:

2024-05-01

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=2024-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
userId	path	True	string minLength: 1 maxLength: 80	Identificateur de l’utilisateur. Doit être unique dans l’instance actuelle du service Gestion des API.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.expiry	True	string (date-time)	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 comme 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 pourquoi l’opération a échoué.

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

HTTP

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

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
KeyType	Clé à utiliser pour générer un jeton pour l’utilisateur.
UserTokenParameters	Obtenir les paramètres du jeton utilisateur.
UserTokenResult	Obtenir les détails de la réponse du jeton utilisateur.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

KeyType

Énumération

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

Valeur	Description
primary
secondary

UserTokenParameters

Object

Obtenir les paramètres du jeton utilisateur.

Nom	Type	Valeur par défaut	Description
properties.expiry	string (date-time)		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 comme spécifié par la norme ISO 8601.
properties.keyType	KeyType	primary	Clé à utiliser pour générer un jeton pour l’utilisateur.

UserTokenResult

Object

Obtenir 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.