Gateway - Generate Token
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=2022-08-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
gateway
|
path | True |
string |
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej" |
resource
|
path | True |
string |
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. |
service
|
path | True |
string |
Nazwa usługi API Management. Regex pattern: |
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
expiry | True |
string |
Czas wygaśnięcia tokenu. Maksymalny czas wygaśnięcia tokenu jest ustawiony na 30 dni. Data jest zgodna z następującym formatem: |
keyType | True |
Klucz, który ma być używany do generowania tokenu bramy. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Treść odpowiedzi zawiera token autoryzacji dla bramy. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
ApiManagementGatewayGenerateToken
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/generateToken?api-version=2022-08-01
{
"keyType": "primary",
"expiry": "2020-04-21T00:44:24.2845269Z"
}
Sample Response
{
"value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}
Definicje
Nazwa | Opis |
---|---|
Error |
Błąd Kontrakt pola. |
Error |
Odpowiedź na błąd. |
Gateway |
Token dostępu bramy. |
Gateway |
Właściwości kontraktu żądania tokenu bramy. |
Key |
Klucz jest ponownie wygenerowany. |
ErrorFieldContract
Błąd Kontrakt pola.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu poziomu właściwości. |
message |
string |
Czytelna dla człowieka reprezentacja błędu na poziomie właściwości. |
target |
string |
Nazwa właściwości. |
ErrorResponse
Odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
error.code |
string |
Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi. |
error.details |
Lista nieprawidłowych pól jest wysyłana w żądaniu w przypadku błędu walidacji. |
|
error.message |
string |
Czytelna dla człowieka reprezentacja błędu. |
GatewayTokenContract
Token dostępu bramy.
Nazwa | Typ | Opis |
---|---|---|
value |
string |
Wartość tokenu uwierzytelniania dostępu współdzielonego dla bramy. |
GatewayTokenRequestContract
Właściwości kontraktu żądania tokenu bramy.
Nazwa | Typ | Wartość domyślna | Opis |
---|---|---|---|
expiry |
string |
Czas wygaśnięcia tokenu. Maksymalny czas wygaśnięcia tokenu jest ustawiony na 30 dni. Data jest zgodna z następującym formatem: |
|
keyType | primary |
Klucz, który ma być używany do generowania tokenu bramy. |
KeyType
Klucz jest ponownie wygenerowany.
Nazwa | Typ | Opis |
---|---|---|
primary |
string |
|
secondary |
string |