AuthorizationServerContractBaseProperties interface
Contratto delle impostazioni di aggiornamento del server di autorizzazione OAuth esterno.
Proprietà
| authorization |
Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo. |
| bearer |
Specifica il meccanismo in base al quale viene passato il token di accesso all'API. |
| client |
Metodo di autenticazione supportato dall'endpoint token di questo server di autorizzazione. I valori possibili sono Basic e/o Body. Quando si specifica Body, le credenziali client e altri parametri vengono passati all'interno del corpo della richiesta nel formato application/x-www-form-urlencoded. |
| default |
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 di autorizzazione. Può contenere tag di formattazione HTML. |
| resource |
Può essere specificato facoltativamente quando il tipo di concessione password del proprietario della risorsa è supportato da questo server di autorizzazione. Password predefinita del proprietario della risorsa. |
| resource |
Può essere specificato facoltativamente quando il tipo di concessione password del proprietario della risorsa è supportato da questo server di autorizzazione. Nome utente predefinito del proprietario della risorsa. |
| support |
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 generare la sicurezza del protocollo. |
| token |
Parametri aggiuntivi richiesti dall'endpoint token di questo server di autorizzazione rappresentato come matrice di oggetti JSON con proprietà nome e stringa valore, ad esempio {"name" : "name value", "value": "a value"}. |
| token |
Endpoint del token OAuth. Contiene l'URI assoluto a cui viene fatto riferimento all'entità. |
Dettagli proprietà
authorizationMethods
Verbi HTTP supportati dall'endpoint di autorizzazione. GET deve essere sempre presente. POST è facoltativo.
authorizationMethods?: AuthorizationMethod[]
Valore della proprietà
bearerTokenSendingMethods
Specifica il meccanismo in base al quale viene passato il token di accesso all'API.
bearerTokenSendingMethods?: string[]
Valore della proprietà
string[]
clientAuthenticationMethod
Metodo di autenticazione supportato dall'endpoint token di questo server di autorizzazione. I valori possibili sono Basic e/o Body. Quando si specifica 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[]
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
description
Descrizione del server di autorizzazione. Può contenere tag di formattazione HTML.
description?: string
Valore della proprietà
string
resourceOwnerPassword
Può essere specificato facoltativamente quando il tipo di concessione password del proprietario della risorsa è supportato da questo server di autorizzazione. Password predefinita del proprietario della risorsa.
resourceOwnerPassword?: string
Valore della proprietà
string
resourceOwnerUsername
Può essere specificato facoltativamente quando il tipo di concessione password del proprietario della risorsa è supportato da questo server di autorizzazione. Nome utente predefinito del proprietario della risorsa.
resourceOwnerUsername?: string
Valore della proprietà
string
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 generare la sicurezza del protocollo.
supportState?: boolean
Valore della proprietà
boolean
tokenBodyParameters
Parametri aggiuntivi richiesti dall'endpoint token di questo server di autorizzazione rappresentato come matrice di oggetti JSON con proprietà nome e stringa valore, ad esempio {"name" : "name value", "value": "a value"}.
tokenBodyParameters?: TokenBodyParameterContract[]
Valore della proprietà
tokenEndpoint
Endpoint del token OAuth. Contiene l'URI assoluto a cui viene fatto riferimento all'entità.
tokenEndpoint?: string
Valore della proprietà
string