AuthorizationServerContractBaseProperties interface

套件:

@azure/arm-apimanagement

外部 OAuth 授權伺服器更新設定合約。

屬性

authorizationMethods	授權端點支援的 HTTP 動詞。 GET 必須一律存在。 POST 是選擇性的。
bearerTokenSendingMethods	指定將存取令牌傳遞至 API 的機制。
clientAuthenticationMethod	此授權伺服器的令牌端點所支持的驗證方法。 可能的值為 Basic 和/或 Body。 指定 Body 時，客戶端認證和其他參數會在 application/x-www-form-urlencoded 格式的要求本文內傳遞。
defaultScope	預設會要求存取令牌範圍。 可以在 API 層級覆寫。 應以包含空格分隔值的字串形式提供。
description	授權伺服器的描述。 可以包含 HTML 格式標記。
resourceOwnerPassword	當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者密碼。
resourceOwnerUsername	當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者用戶名稱。
supportState	如果為 true，授權伺服器會包含授權要求到其回應的狀態參數。 用戶端可以使用狀態參數來提高通訊協定安全性。
tokenBodyParameters	此授權伺服器的令牌端點所需的其他參數，以名稱與值字串屬性表示為 JSON 對象的陣列，亦即 {“name” ： “name value”， “value”： “a value”}。
tokenEndpoint	OAuth 令牌端點。 包含所參考實體的絕對 URI。

屬性詳細資料

authorizationMethods

授權端點支援的 HTTP 動詞。 GET 必須一律存在。 POST 是選擇性的。

authorizationMethods?: AuthorizationMethod[]

屬性值

AuthorizationMethod[]

bearerTokenSendingMethods

指定將存取令牌傳遞至 API 的機制。

bearerTokenSendingMethods?: string[]

屬性值

string[]

clientAuthenticationMethod

此授權伺服器的令牌端點所支持的驗證方法。 可能的值為 Basic 和/或 Body。 指定 Body 時，客戶端認證和其他參數會在 application/x-www-form-urlencoded 格式的要求本文內傳遞。

clientAuthenticationMethod?: string[]

屬性值

string[]

defaultScope

預設會要求存取令牌範圍。 可以在 API 層級覆寫。 應以包含空格分隔值的字串形式提供。

defaultScope?: string

屬性值

string

description

授權伺服器的描述。 可以包含 HTML 格式標記。

description?: string

屬性值

string

resourceOwnerPassword

當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者密碼。

resourceOwnerPassword?: string

屬性值

string

resourceOwnerUsername

當此授權伺服器支援資源擁有者密碼授與類型時，可以選擇性地指定。 默認資源擁有者用戶名稱。

resourceOwnerUsername?: string

屬性值

string

supportState

如果為 true，授權伺服器會包含授權要求到其回應的狀態參數。 用戶端可以使用狀態參數來提高通訊協定安全性。

supportState?: boolean

屬性值

boolean

tokenBodyParameters

此授權伺服器的令牌端點所需的其他參數，以名稱與值字串屬性表示為 JSON 對象的陣列，亦即 {“name” ： “name value”， “value”： “a value”}。

tokenBodyParameters?: TokenBodyParameterContract[]

屬性值

TokenBodyParameterContract[]

tokenEndpoint

OAuth 令牌端點。 包含所參考實體的絕對 URI。

tokenEndpoint?: string

屬性值

string