AuthorizationServerContractBaseProperties interface
外部 OAuth 授权服务器更新设置协定。
属性
| authorization |
授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。 |
| bearer |
指定将访问令牌传递给 API 的机制。 |
| client |
此授权服务器的令牌终结点支持的身份验证方法。 可能的值为 Basic 和/或 Body。 指定正文时,客户端凭据和其他参数在 application/x-www-form-urlencoded 格式的请求正文中传递。 |
| default |
默认情况下将请求的访问令牌范围。 可以在 API 级别重写。 应以包含空格分隔值的字符串的形式提供。 |
| description | 授权服务器的说明。 可以包含 HTML 格式标记。 |
| resource |
当此授权服务器支持资源所有者密码授予类型时,可以选择指定。 默认资源所有者密码。 |
| resource |
当此授权服务器支持资源所有者密码授予类型时,可以选择指定。 默认资源所有者用户名。 |
| support |
如果为 true,授权服务器将包含授权请求到其响应的状态参数。 客户端可以使用状态参数提高协议安全性。 |
| token |
此授权服务器的令牌终结点所需的附加参数,这些参数表示为具有名称和值字符串属性的 JSON 对象数组,即 {“name”: “name value”, “value”: “a value”}。 |
| token |
OAuth 令牌终结点。 包含所引用实体的绝对 URI。 |
属性详细信息
authorizationMethods
授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。
authorizationMethods?: AuthorizationMethod[]
属性值
bearerTokenSendingMethods
指定将访问令牌传递给 API 的机制。
bearerTokenSendingMethods?: string[]
属性值
string[]
clientAuthenticationMethod
此授权服务器的令牌终结点支持的身份验证方法。 可能的值为 Basic 和/或 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[]
属性值
tokenEndpoint
OAuth 令牌终结点。 包含所引用实体的绝对 URI。
tokenEndpoint?: string
属性值
string