User - Get Shared Access Token
Získá token autorizace sdíleného přístupu pro uživatele.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token?api-version=2022-08-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
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. Regex pattern: |
subscription
|
path | True |
string |
ID cílového předplatného. |
user
|
path | True |
string |
Identifikátor uživatele. Musí být jedinečný v aktuální instanci služby API Management. |
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 |
---|---|---|---|
properties.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: |
properties.keyType | True |
Klíč, který se má použít ke generování tokenu pro uživatele. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Text odpovědi obsahuje autorizační token pro uživatele. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
ApiManagementUserToken
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId1718/token?api-version=2022-08-01
{
"properties": {
"keyType": "primary",
"expiry": "2019-04-21T00:44:24.2845269Z"
}
}
Sample Response
{
"value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}
Definice
Name | Description |
---|---|
Error |
Chybový kontrakt pole. |
Error |
Odpověď na chybu. |
Key |
Klíč, který se má použít ke generování tokenu pro uživatele. |
User |
Získání parametrů tokenu uživatele |
User |
Získejte podrobnosti o odpovědi tokenu uživatele. |
ErrorFieldContract
Chybový kontrakt pole.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby na úrovni vlastnosti. |
message |
string |
Pro člověka čitelná reprezentace 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 požadavku v případě chyby ověření. |
|
error.message |
string |
Pro člověka čitelná reprezentace chyby. |
KeyType
Klíč, který se má použít ke generování tokenu pro uživatele.
Name | Typ | Description |
---|---|---|
primary |
string |
|
secondary |
string |
UserTokenParameters
Získání parametrů tokenu uživatele
Name | Typ | Výchozí hodnota | Description |
---|---|---|---|
properties.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: |
|
properties.keyType | primary |
Klíč, který se má použít ke generování tokenu pro uživatele. |
UserTokenResult
Získejte podrobnosti o odpovědi tokenu uživatele.
Name | Typ | Description |
---|---|---|
value |
string |
Token autorizace sdíleného přístupu pro uživatele. |