AuthorizationServerContractBaseProperties interface
Külső OAuth engedélyezési kiszolgáló frissítési beállításainak szerződése.
Tulajdonságok
| authorization |
Az engedélyezési végpont által támogatott HTTP-parancsok. A GET-nek mindig jelen kell lennie. A POST nem kötelező. |
| bearer |
Meghatározza azt a mechanizmust, amellyel a hozzáférési jogkivonatot a rendszer átadja az API-nak. |
| client |
Az engedélyezési kiszolgáló jogkivonatvégpontja által támogatott hitelesítési módszer. A lehetséges értékek alapszintűek és/vagy törzsek. A törzs megadásakor az ügyfél hitelesítő adatai és egyéb paraméterei az alkalmazás/x-www-form-urlencoded formátumban a kérelem törzsén belül lesznek átadva. |
| default |
Alapértelmezés szerint kérendő hozzáférési jogkivonat-hatókör. Az API szintjén felül lehet bírálni. Szóközzel tagolt értékeket tartalmazó sztring formájában kell megadni. |
| description | Az engedélyezési kiszolgáló leírása. HTML-formázási címkéket tartalmazhat. |
| resource |
Opcionálisan megadható, ha az erőforrás-tulajdonosi jelszó megadásának típusát ez az engedélyezési kiszolgáló támogatja. Alapértelmezett erőforrás-tulajdonosi jelszó. |
| resource |
Opcionálisan megadható, ha az erőforrás-tulajdonosi jelszó megadásának típusát ez az engedélyezési kiszolgáló támogatja. Alapértelmezett erőforrás-tulajdonosi felhasználónév. |
| support |
Ha igaz, az engedélyezési kiszolgáló az engedélyezési kérelemtől a válaszig tartalmazni fogja az állapotparamétert. Az ügyfél az állapotparamétert használhatja a protokollbiztonság növeléséhez. |
| token |
Az engedélyezési kiszolgáló jogkivonatvégpontja által megkövetelt további paraméterek név- és értéksztring-tulajdonságokkal rendelkező JSON-objektumok tömbjeként jelenik meg, például {"name" : "name value", "value": "a value"}. |
| token |
OAuth-jogkivonat végpontja. Abszolút URI-t tartalmaz a hivatkozott entitáshoz. |
Tulajdonság adatai
authorizationMethods
Az engedélyezési végpont által támogatott HTTP-parancsok. A GET-nek mindig jelen kell lennie. A POST nem kötelező.
authorizationMethods?: AuthorizationMethod[]
Tulajdonság értéke
bearerTokenSendingMethods
Meghatározza azt a mechanizmust, amellyel a hozzáférési jogkivonatot a rendszer átadja az API-nak.
bearerTokenSendingMethods?: string[]
Tulajdonság értéke
string[]
clientAuthenticationMethod
Az engedélyezési kiszolgáló jogkivonatvégpontja által támogatott hitelesítési módszer. A lehetséges értékek alapszintűek és/vagy törzsek. A törzs megadásakor az ügyfél hitelesítő adatai és egyéb paraméterei az alkalmazás/x-www-form-urlencoded formátumban a kérelem törzsén belül lesznek átadva.
clientAuthenticationMethod?: string[]
Tulajdonság értéke
string[]
defaultScope
Alapértelmezés szerint kérendő hozzáférési jogkivonat-hatókör. Az API szintjén felül lehet bírálni. Szóközzel tagolt értékeket tartalmazó sztring formájában kell megadni.
defaultScope?: string
Tulajdonság értéke
string
description
Az engedélyezési kiszolgáló leírása. HTML-formázási címkéket tartalmazhat.
description?: string
Tulajdonság értéke
string
resourceOwnerPassword
Opcionálisan megadható, ha az erőforrás-tulajdonosi jelszó megadásának típusát ez az engedélyezési kiszolgáló támogatja. Alapértelmezett erőforrás-tulajdonosi jelszó.
resourceOwnerPassword?: string
Tulajdonság értéke
string
resourceOwnerUsername
Opcionálisan megadható, ha az erőforrás-tulajdonosi jelszó megadásának típusát ez az engedélyezési kiszolgáló támogatja. Alapértelmezett erőforrás-tulajdonosi felhasználónév.
resourceOwnerUsername?: string
Tulajdonság értéke
string
supportState
Ha igaz, az engedélyezési kiszolgáló az engedélyezési kérelemtől a válaszig tartalmazni fogja az állapotparamétert. Az ügyfél az állapotparamétert használhatja a protokollbiztonság növeléséhez.
supportState?: boolean
Tulajdonság értéke
boolean
tokenBodyParameters
Az engedélyezési kiszolgáló jogkivonatvégpontja által megkövetelt további paraméterek név- és értéksztring-tulajdonságokkal rendelkező JSON-objektumok tömbjeként jelenik meg, például {"name" : "name value", "value": "a value"}.
tokenBodyParameters?: TokenBodyParameterContract[]
Tulajdonság értéke
tokenEndpoint
OAuth-jogkivonat végpontja. Abszolút URI-t tartalmaz a hivatkozott entitáshoz.
tokenEndpoint?: string
Tulajdonság értéke
string