AuthorizationServerUpdateContractProperties interface

Pacchetto:

@azure/arm-apimanagement

Contratto delle impostazioni di aggiornamento del server di autorizzazione OAuth esterno.

Extends

AuthorizationServerContractBaseProperties

Proprietà

authorizationEndpoint	Endpoint di autorizzazione OAuth. Vedere http://tools.ietf.org/html/rfc6749#section-3.2.
clientId	ID client o app registrato con il server di autorizzazione.
clientRegistrationEndpoint	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.
clientSecret	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.
displayName	Nome del server di autorizzazione descrittivo.
grantTypes	Forma di concessione di autorizzazione, utilizzata dal client per richiedere il token di accesso.
useInApiDocumentation	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.
useInTestConsole	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.

Proprietà ereditate

authorizationMethods	Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo.
bearerTokenSendingMethods	Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.
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.
defaultScope	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.
description	Descrizione del server autorizzazione. Può contenere tag di formattazione HTML.
resourceOwnerPassword	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.
resourceOwnerUsername	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.
supportState	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.
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"}.
tokenEndpoint	Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento.

Dettagli proprietà

authorizationEndpoint

Endpoint di autorizzazione OAuth. Vedere http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Valore della proprietà

string

clientId

ID client o app registrato con il server di autorizzazione.

clientId?: string

Valore della proprietà

string

clientRegistrationEndpoint

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.

clientRegistrationEndpoint?: string

Valore della proprietà

string

clientSecret

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.

clientSecret?: string

Valore della proprietà

string

displayName

Nome del server di autorizzazione descrittivo.

displayName?: string

Valore della proprietà

string

grantTypes

Forma di concessione di autorizzazione, utilizzata dal client per richiedere il token di accesso.

grantTypes?: string[]

Valore della proprietà

string[]

useInApiDocumentation

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.

useInApiDocumentation?: boolean

Valore della proprietà

boolean

useInTestConsole

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.

useInTestConsole?: boolean

Valore della proprietà

boolean

Dettagli proprietà ereditate

authorizationMethods

Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo.

authorizationMethods?: AuthorizationMethod[]

Valore della proprietà

AuthorizationMethod[]

Ereditato daAuthorizationServerContractBaseProperties.authorizationMethods

bearerTokenSendingMethods

Specifica il meccanismo per mezzo del quale il token di accesso viene passato all'API.

bearerTokenSendingMethods?: string[]

Valore della proprietà

string[]

Ereditato daAuthorizationServerContractBaseProperties.bearerTokenSendingMethods

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.

clientAuthenticationMethod?: string[]

Valore della proprietà

string[]

Ereditato daAuthorizationServerContractBaseProperties.clientAuthenticationMethod

defaultScope

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.

defaultScope?: string

Valore della proprietà

string

Ereditato daAuthorizationServerContractBaseProperties.defaultScope

description

Descrizione del server autorizzazione. Può contenere tag di formattazione HTML.

description?: string

Valore della proprietà

string

Ereditato daAuthorizationServerContractBaseProperties.description

resourceOwnerPassword

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.

resourceOwnerPassword?: string

Valore della proprietà

string

Ereditato daAuthorizationServerContractBaseProperties.resourceOwnerPassword

resourceOwnerUsername

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.

resourceOwnerUsername?: string

Valore della proprietà

string

Ereditato daAuthorizationServerContractBaseProperties.resourceOwnerUsername

supportState

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.

supportState?: boolean

Valore della proprietà

boolean

Ereditato daAuthorizationServerContractBaseProperties.supportState

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"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Valore della proprietà

TokenBodyParameterContract[]

Ereditato daAuthorizationServerContractBaseProperties.tokenBodyParameters

tokenEndpoint

Endpoint del token OAuth. Contiene l'URI assoluto dell'entità a cui si fa riferimento.

tokenEndpoint?: string

Valore della proprietà

string

Ereditato daAuthorizationServerContractBaseProperties.tokenEndpoint