Gateway - Generate Token

Usługa:

API Management

Wersja interfejsu API:

2024-05-01

Pobiera token autoryzacji dostępu współdzielonego dla bramy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
gatewayId	path	True	string minLength: 1 maxLength: 80	Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
expiry	True	string (date-time)	Czas wygaśnięcia tokenu. Maksymalny czas wygaśnięcia tokenu jest ustawiony na 30 dni. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.
keyType	True	KeyType	Klucz do wygenerowania tokenu bramy.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GatewayTokenContract	Treść odpowiedzi zawiera token autoryzacji bramy.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementGatewayGenerateToken

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GatewayTokenContract	Token dostępu bramy.
GatewayTokenRequestContract	Właściwości kontraktu żądania tokenu bramy.
KeyType	Klucz jest ponownie wygenerowany.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

GatewayTokenContract

Objekt

Token dostępu bramy.

Nazwa	Typ	Opis
value	string	Wartość tokenu uwierzytelniania dostępu współdzielonego dla bramy.

GatewayTokenRequestContract

Objekt

Właściwości kontraktu żądania tokenu bramy.

Nazwa	Typ	Domyślna wartość	Opis
expiry	string (date-time)		Czas wygaśnięcia tokenu. Maksymalny czas wygaśnięcia tokenu jest ustawiony na 30 dni. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.
keyType	KeyType	primary	Klucz do wygenerowania tokenu bramy.

KeyType

Wyliczanie

Klucz jest ponownie wygenerowany.

Wartość	Opis
primary
secondary