Authorization Server - Create Or Update
Crea un nuovo server di autorizzazione o aggiorna un server di autorizzazione esistente.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
authsid
|
path | True |
string |
Identificatore del server di autorizzazione. Regex pattern: |
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio di Gestione API. Regex pattern: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
If-Match |
string |
ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
properties.authorizationEndpoint | True |
string |
Endpoint di autorizzazione OAuth. Vedere http://tools.ietf.org/html/rfc6749#section-3.2. |
properties.clientId | True |
string |
ID client o app registrato con il server di autorizzazione. |
properties.clientRegistrationEndpoint | True |
string |
Riferimento facoltativo a una pagina in cui viene eseguita la registrazione del client o dell'app per questo server autorizzazione. Contiene l'URL assoluto dell'entità a cui si fa riferimento. |
properties.displayName | True |
string |
Nome del server di autorizzazione descrittivo. |
properties.grantTypes | True |
Forma di concessione di autorizzazione, utilizzata dal client per richiedere il token di accesso. |
|
properties.authorizationMethods |
Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo. |
||
properties.bearerTokenSendingMethods |
Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API. |
||
properties.clientAuthenticationMethod |
Metodo di autenticazione supportato dall'endpoint del token di questo server autorizzazione. I valori possibili sono Basic e/o Body. Quando viene specificato Body, le credenziali client e altri parametri vengono passati all'interno del corpo della richiesta nel formato application/x-www-form-urlencoded. |
||
properties.clientSecret |
string |
Chiave privata dell'app o segreto client registrato con il server autorizzazione. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. |
|
properties.defaultScope |
string |
Ambito del token di accesso che verrà richiesto per impostazione predefinita. Può essere sottoposto a override a livello di API. Deve essere specificato sotto forma di stringa contenente valori delimitati da spazi. |
|
properties.description |
string |
Descrizione del server autorizzazione. Può contenere tag di formattazione HTML. |
|
properties.resourceOwnerPassword |
string |
Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Password del proprietario delle risorse predefinito. |
|
properties.resourceOwnerUsername |
string |
Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Nome utente del proprietario delle risorse predefinito. |
|
properties.supportState |
boolean |
Se true, il server di autorizzazione includerà il parametro di stato dalla richiesta di autorizzazione alla risposta. Il client può usare il parametro di stato per aumentare la sicurezza del protocollo. |
|
properties.tokenBodyParameters |
Parametri aggiuntivi richiesti dall'endpoint token di questo server di autorizzazione rappresentato come matrice di oggetti JSON con proprietà stringa nome e valore, ad esempio {"name" : "name value", "value": "a value"}. |
||
properties.tokenEndpoint |
string |
Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento. |
|
properties.useInApiDocumentation |
boolean |
Se true, il server di autorizzazione verrà usato nella documentazione dell'API nel portale per sviluppatori. False per impostazione predefinita se non viene fornito alcun valore. |
|
properties.useInTestConsole |
boolean |
Se true, il server di autorizzazione può essere usato nella console di test del portale per sviluppatori. True per impostazione predefinita se non viene fornito alcun valore. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Il server di autorizzazione è già registrato. Headers ETag: string |
|
201 Created |
Il server autorizzazione è stato registrato. Headers ETag: string |
|
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.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
ApiManagementCreateAuthorizationServer
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer?api-version=2022-08-01
{
"properties": {
"displayName": "test2",
"useInTestConsole": false,
"useInApiDocumentation": true,
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
"authorizationMethods": [
"GET"
],
"tokenEndpoint": "https://www.contoso.com/oauth2/token",
"supportState": true,
"defaultScope": "read write",
"grantTypes": [
"authorizationCode",
"implicit"
],
"bearerTokenSendingMethods": [
"authorizationHeader"
],
"clientId": "1",
"clientSecret": "2",
"resourceOwnerUsername": "un",
"resourceOwnerPassword": "pwd"
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
"type": "Microsoft.ApiManagement/service/authorizationServers",
"name": "newauthServer",
"properties": {
"displayName": "test2",
"useInTestConsole": false,
"useInApiDocumentation": true,
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
"authorizationMethods": [
"GET"
],
"tokenEndpoint": "https://www.contoso.com/oauth2/token",
"supportState": true,
"defaultScope": "read write",
"grantTypes": [
"authorizationCode",
"implicit"
],
"bearerTokenSendingMethods": [
"authorizationHeader"
],
"clientId": "1",
"resourceOwnerUsername": "un",
"resourceOwnerPassword": "pwd"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
"type": "Microsoft.ApiManagement/service/authorizationServers",
"name": "newauthServer",
"properties": {
"displayName": "test2",
"useInTestConsole": false,
"useInApiDocumentation": true,
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
"authorizationMethods": [
"GET"
],
"tokenEndpoint": "https://www.contoso.com/oauth2/token",
"supportState": true,
"defaultScope": "read write",
"grantTypes": [
"authorizationCode",
"implicit"
],
"bearerTokenSendingMethods": [
"authorizationHeader"
],
"clientId": "1",
"resourceOwnerUsername": "un",
"resourceOwnerPassword": "pwd"
}
}
Definizioni
Nome | Descrizione |
---|---|
Authorization |
Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo. |
Authorization |
Impostazioni del server di autorizzazione OAuth esterne. |
Bearer |
Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API. |
Client |
Metodo di autenticazione supportato dall'endpoint del token di questo server autorizzazione. I valori possibili sono Basic e/o Body. Quando viene specificato Body, le credenziali client e altri parametri vengono passati all'interno del corpo della richiesta nel formato application/x-www-form-urlencoded. |
Error |
Contratto campo errore. |
Error |
Risposta errore. |
Grant |
Forma di concessione di autorizzazione, utilizzata dal client per richiedere il token di accesso. |
Token |
Parametro del corpo della richiesta del token di acquisizione di OAuth (www-url-form-codificato). |
AuthorizationMethod
Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo.
Nome | Tipo | Descrizione |
---|---|---|
DELETE |
string |
|
GET |
string |
|
HEAD |
string |
|
OPTIONS |
string |
|
PATCH |
string |
|
POST |
string |
|
PUT |
string |
|
TRACE |
string |
AuthorizationServerContract
Impostazioni del server di autorizzazione OAuth esterne.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.authorizationEndpoint |
string |
Endpoint di autorizzazione OAuth. Vedere http://tools.ietf.org/html/rfc6749#section-3.2. |
properties.authorizationMethods |
Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo. |
|
properties.bearerTokenSendingMethods |
Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API. |
|
properties.clientAuthenticationMethod |
Metodo di autenticazione supportato dall'endpoint del token di questo server autorizzazione. I valori possibili sono Basic e/o Body. Quando viene specificato Body, le credenziali client e altri parametri vengono passati all'interno del corpo della richiesta nel formato application/x-www-form-urlencoded. |
|
properties.clientId |
string |
ID client o app registrato con il server di autorizzazione. |
properties.clientRegistrationEndpoint |
string |
Riferimento facoltativo a una pagina in cui viene eseguita la registrazione del client o dell'app per questo server autorizzazione. Contiene l'URL assoluto dell'entità a cui si fa riferimento. |
properties.clientSecret |
string |
Chiave privata dell'app o segreto client registrato con il server autorizzazione. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. |
properties.defaultScope |
string |
Ambito del token di accesso che verrà richiesto per impostazione predefinita. Può essere sottoposto a override a livello di API. Deve essere specificato sotto forma di stringa contenente valori delimitati da spazi. |
properties.description |
string |
Descrizione del server autorizzazione. Può contenere tag di formattazione HTML. |
properties.displayName |
string |
Nome del server di autorizzazione descrittivo. |
properties.grantTypes |
Forma di concessione di autorizzazione, utilizzata dal client per richiedere il token di accesso. |
|
properties.resourceOwnerPassword |
string |
Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Password del proprietario delle risorse predefinito. |
properties.resourceOwnerUsername |
string |
Può essere specificato facoltativamente quando il tipo di concessione della password del proprietario delle risorse è supportato dal server autorizzazione. Nome utente del proprietario delle risorse predefinito. |
properties.supportState |
boolean |
Se true, il server di autorizzazione includerà il parametro di stato dalla richiesta di autorizzazione alla risposta. Il client può usare il parametro di stato per aumentare la sicurezza del protocollo. |
properties.tokenBodyParameters |
Parametri aggiuntivi richiesti dall'endpoint token di questo server di autorizzazione rappresentato come matrice di oggetti JSON con proprietà stringa nome e valore, ad esempio {"name" : "name value", "value": "a value"}. |
|
properties.tokenEndpoint |
string |
Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento. |
properties.useInApiDocumentation |
boolean |
Se true, il server di autorizzazione verrà usato nella documentazione dell'API nel portale per sviluppatori. False per impostazione predefinita se non viene fornito alcun valore. |
properties.useInTestConsole |
boolean |
Se true, il server di autorizzazione può essere usato nella console di test del portale per sviluppatori. True per impostazione predefinita se non viene fornito alcun valore. |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
BearerTokenSendingMethod
Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.
Nome | Tipo | Descrizione |
---|---|---|
authorizationHeader |
string |
|
query |
string |
ClientAuthenticationMethod
Metodo di autenticazione supportato dall'endpoint del token di questo server autorizzazione. I valori possibili sono Basic e/o Body. Quando viene specificato Body, le credenziali client e altri parametri vengono passati all'interno del corpo della richiesta nel formato application/x-www-form-urlencoded.
Nome | Tipo | Descrizione |
---|---|---|
Basic |
string |
Metodo di autenticazione client di base. |
Body |
string |
Metodo Di autenticazione basato sul corpo. |
ErrorFieldContract
Contratto campo errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
GrantType
Forma di concessione di autorizzazione, utilizzata dal client per richiedere il token di accesso.
Nome | Tipo | Descrizione |
---|---|---|
authorizationCode |
string |
Flusso di concessione del codice di autorizzazione come descritto https://tools.ietf.org/html/rfc6749#section-4.1. |
clientCredentials |
string |
Flusso di concessione credenziali client come descritto https://tools.ietf.org/html/rfc6749#section-4.4. |
implicit |
string |
Flusso di concessione del codice implicito come descritto https://tools.ietf.org/html/rfc6749#section-4.2. |
resourceOwnerPassword |
string |
Flusso di concessione password del proprietario della risorsa come descritto https://tools.ietf.org/html/rfc6749#section-4.3. |
TokenBodyParameterContract
Parametro del corpo della richiesta del token di acquisizione di OAuth (www-url-form-codificato).
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
nome del parametro del corpo. |
value |
string |
valore del parametro body. |