User - Get Shared Access Token
Ottiene il token di autorizzazione di accesso condiviso per l'utente.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token?api-version=2024-05-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Nome del servizio Gestione API. |
subscription
|
path | True |
string (uuid) |
ID della sottoscrizione di destinazione. Il valore deve essere un UUID. |
user
|
path | True |
string minLength: 1maxLength: 80 |
Identificatore utente. Deve essere univoco nell'istanza corrente del servizio Gestione API. |
api-version
|
query | True |
string minLength: 1 |
Versione dell'API da usare per questa operazione. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
properties.expiry | True |
string (date-time) |
Ora di scadenza del token. Il tempo massimo di scadenza del token è impostato su 30 giorni. La data è conforme al formato seguente: |
properties.keyType | True |
Chiave da usare per generare il token per l'utente. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Il corpo della risposta contiene il token di autorizzazione per l'utente. |
|
Other Status Codes |
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
ApiManagementUserToken
Esempio di richiesta
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId1718/token?api-version=2024-05-01
{
"properties": {
"keyType": "primary",
"expiry": "2019-04-21T00:44:24.2845269Z"
}
}
Risposta di esempio
{
"value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore |
Key |
Chiave da usare per generare il token per l'utente. |
User |
Ottenere i parametri del token utente. |
User |
Ottenere i dettagli della risposta del token utente. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorResponse
Risposta di errore
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
KeyType
Chiave da usare per generare il token per l'utente.
Valore | Descrizione |
---|---|
primary | |
secondary |
UserTokenParameters
Ottenere i parametri del token utente.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
properties.expiry |
string (date-time) |
Ora di scadenza del token. Il tempo massimo di scadenza del token è impostato su 30 giorni. La data è conforme al formato seguente: |
|
properties.keyType | primary |
Chiave da usare per generare il token per l'utente. |
UserTokenResult
Ottenere i dettagli della risposta del token utente.
Nome | Tipo | Descrizione |
---|---|---|
value |
string |
Token di autorizzazione di accesso condiviso per l'utente. |