Gateway - Generate Token

Dienst:

API Management

API-Version:

2024-05-01

Ruft das Autorisierungstoken für den freigegebenen Zugriff für das Gateway ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
gatewayId	path	True	string minLength: 1 maxLength: 80	Gatewayentitätsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Darf keinen Wert 'verwaltet' haben
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
expiry	True	string (date-time)	Die Ablaufzeit des Tokens. Die maximale Ablaufzeit des Tokens wird auf 30 Tage festgelegt. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
keyType	True	KeyType	Der Schlüssel, der zum Generieren des Gatewaytokens verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	GatewayTokenContract	Der Antworttext enthält das Autorisierungstoken für das Gateway.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementGatewayGenerateToken

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GatewayTokenContract	Gatewayzugriffstoken.
GatewayTokenRequestContract	Vertragseigenschaften für Gatewaytokenanforderung.
KeyType	Der Schlüssel, der neu generiert wird.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GatewayTokenContract

Objekt

Gatewayzugriffstoken.

Name	Typ	Beschreibung
value	string	Tokenwert für die freigegebene Zugriffsauthentifizierung für das Gateway.

GatewayTokenRequestContract

Objekt

Vertragseigenschaften für Gatewaytokenanforderung.

Name	Typ	Standardwert	Beschreibung
expiry	string (date-time)		Die Ablaufzeit des Tokens. Die maximale Ablaufzeit des Tokens wird auf 30 Tage festgelegt. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
keyType	KeyType	primary	Der Schlüssel, der zum Generieren des Gatewaytokens verwendet werden soll.

KeyType

Enumeration

Der Schlüssel, der neu generiert wird.

Wert	Beschreibung
primary
secondary