Gateway - Generate Token
Získá token autorizace sdíleného přístupu pro bránu.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken?api-version=2022-08-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Identifikátor entity brány. Musí být v aktuální instanci služby API Management jedinečná. Nesmí mít hodnotu "managed". |
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
service
|
path | True |
string |
Název služby API Management. Vzor regulárního výrazu: |
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
expiry | True |
string |
Čas vypršení platnosti tokenu. Maximální doba vypršení platnosti tokenu je nastavená na 30 dnů. Datum odpovídá následujícímu formátu: |
keyType | True |
Klíč, který se má použít ke generování tokenu brány. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Tělo odpovědi obsahuje autorizační token pro bránu. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
ApiManagementGatewayGenerateToken
Ukázkový požadavek
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"
}
Ukázková odpověď
{
"value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}
Definice
Name | Description |
---|---|
Error |
Chyba Kontrakt pole. |
Error |
Odpověď na chybu. |
Gateway |
Přístupový token brány. |
Gateway |
Vlastnosti kontraktu žádosti o token brány. |
Key |
Klíč se vygeneruje. |
ErrorFieldContract
Chyba Kontrakt pole.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby na úrovni vlastnosti. |
message |
string |
Čitelné znázornění chyby na úrovni vlastností. |
target |
string |
Název vlastnosti. |
ErrorResponse
Odpověď na chybu.
Name | Typ | Description |
---|---|---|
error.code |
string |
Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi. |
error.details |
Seznam neplatných polí se odešle v žádosti v případě chyby ověření. |
|
error.message |
string |
Znázornění chyby čitelné pro člověka |
GatewayTokenContract
Přístupový token brány.
Name | Typ | Description |
---|---|---|
value |
string |
Hodnota tokenu sdíleného ověřování přístupu pro bránu. |
GatewayTokenRequestContract
Vlastnosti kontraktu žádosti o token brány.
Name | Typ | Default value | Description |
---|---|---|---|
expiry |
string |
Čas vypršení platnosti tokenu. Maximální doba vypršení platnosti tokenu je nastavená na 30 dnů. Datum odpovídá následujícímu formátu: |
|
keyType | primary |
Klíč, který se má použít ke generování tokenu brány. |
KeyType
Klíč se vygeneruje.
Name | Typ | Description |
---|---|---|
primary |
string |
|
secondary |
string |