你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
AuthorizationServerUpdateContractProperties interface
外部 OAuth 授权服务器更新设置协定。
- 扩展
属性
| authorization |
OAuth 授权终结点。 请参阅 http://tools.ietf.org/html/rfc6749#section-3.2。 |
| client |
已注册到此授权服务器的客户端或应用程序 ID。 |
| client |
对执行此授权服务器的客户端或应用程序注册时所在页的可选引用。 包含所引用实体的绝对 URL。 |
| client |
已注册到此授权服务器的客户端或应用程序机密。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 |
| display |
用户友好的授权服务器名称。 |
| grant |
授权的形式，客户端使用该授权请求访问令牌。 |
| use |
如果为 true，则将在开发人员门户的 API 文档中使用授权服务器。 如果未提供任何值，则默认为 False。 |
| use |
如果为 true，可以在开发人员门户测试控制台中使用授权服务器。 如果未提供任何值，则默认为 True。 |
继承属性
| authorization |
授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。 |
| bearer |
指定用于向 API 传递访问令牌的机制。 |
| client |
此授权服务器的令牌终结点支持的身份验证方法。 可能的值为 Basic 和/或 Body。 指定 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。 |
属性详细信息
authorizationEndpoint
OAuth 授权终结点。 请参阅 http://tools.ietf.org/html/rfc6749#section-3.2。
authorizationEndpoint?: string属性值
string
clientId
已注册到此授权服务器的客户端或应用程序 ID。
clientId?: string属性值
string
clientRegistrationEndpoint
对执行此授权服务器的客户端或应用程序注册时所在页的可选引用。 包含所引用实体的绝对 URL。
clientRegistrationEndpoint?: string属性值
string
clientSecret
已注册到此授权服务器的客户端或应用程序机密。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。
clientSecret?: string属性值
string
displayName
用户友好的授权服务器名称。
displayName?: string属性值
string
grantTypes
授权的形式，客户端使用该授权请求访问令牌。
grantTypes?: string[]属性值
string[]
useInApiDocumentation
如果为 true，则将在开发人员门户的 API 文档中使用授权服务器。 如果未提供任何值，则默认为 False。
useInApiDocumentation?: boolean属性值
boolean
useInTestConsole
如果为 true，可以在开发人员门户测试控制台中使用授权服务器。 如果未提供任何值，则默认为 True。
useInTestConsole?: boolean属性值
boolean
继承属性详细信息
authorizationMethods
授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。
authorizationMethods?: AuthorizationMethod[]属性值
继承自AuthorizationServerContractBaseProperties.authorizationMethods
bearerTokenSendingMethods
指定用于向 API 传递访问令牌的机制。
bearerTokenSendingMethods?: string[]属性值
string[]
继承自AuthorizationServerContractBaseProperties.bearerTokenSendingMethods
clientAuthenticationMethod
此授权服务器的令牌终结点支持的身份验证方法。 可能的值为 Basic 和/或 Body。 指定 Body 时，客户端凭据和其他参数以 application/x-www-form-urlencoded 格式在请求正文中传递。
clientAuthenticationMethod?: string[]属性值
string[]
继承自AuthorizationServerContractBaseProperties.clientAuthenticationMethod
defaultScope
将按默认请求的访问令牌作用域。 可以在 API 级别重写。 应以包含空格分隔值的字符串形式提供。
defaultScope?: string属性值
string
description
授权服务器的说明。 可以包含采用 HTML 格式的标记。
description?: string属性值
string
resourceOwnerPassword
当此授权服务器支持资源所有者密码授权类型时，可以根据需要指定。 默认的资源所有者密码。
resourceOwnerPassword?: string属性值
string
继承自AuthorizationServerContractBaseProperties.resourceOwnerPassword
resourceOwnerUsername
当此授权服务器支持资源所有者密码授权类型时，可以根据需要指定。 默认的资源所有者用户名。
resourceOwnerUsername?: string属性值
string
继承自AuthorizationServerContractBaseProperties.resourceOwnerUsername
supportState
如果为 true，授权服务器将包含授权请求中对其响应的状态参数。 客户端可以使用状态参数来引发协议安全性。
supportState?: boolean属性值
boolean
tokenBodyParameters
此授权服务器的令牌终结点所需的其他参数表示为具有名称和值字符串属性的 JSON 对象数组，即 {“name” ： “name value”， “value”： “a value”}。
tokenBodyParameters?: TokenBodyParameterContract[]属性值
继承自AuthorizationServerContractBaseProperties.tokenBodyParameters
tokenEndpoint
OAuth 令牌终结点。 包含所引用实体的绝对 URI。
tokenEndpoint?: string属性值
string