通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

AuthorizationServerContract interface

  • 参考
包:
@azure/arm-apimanagement

外部 OAuth 授权服务器设置。

扩展
ProxyResource

属性

authorizationEndpoint

OAuth 授权终结点。 请参阅 http://tools.ietf.org/html/rfc6749#section-3.2。
authorizationMethods

授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。
bearerTokenSendingMethods

指定用于向 API 传递访问令牌的机制。
clientAuthenticationMethod

此授权服务器的令牌终结点支持的身份验证方法。 可能的值为 Basic 和/或 Body。 指定 Body 时，客户端凭据和其他参数以 application/x-www-form-urlencoded 格式在请求正文中传递。
clientId

已注册到此授权服务器的客户端或应用程序 ID。
clientRegistrationEndpoint

对执行此授权服务器的客户端或应用程序注册时所在页的可选引用。 包含所引用实体的绝对 URL。
clientSecret

已注册到此授权服务器的客户端或应用程序机密。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。
defaultScope

将按默认请求的访问令牌作用域。 可以在 API 级别重写。 应以包含空格分隔值的字符串形式提供。
description

授权服务器的说明。 可以包含采用 HTML 格式的标记。
displayName

用户友好的授权服务器名称。
grantTypes

授权的形式，客户端使用该授权请求访问令牌。
resourceOwnerPassword

当此授权服务器支持资源所有者密码授权类型时，可以根据需要指定。 默认的资源所有者密码。
resourceOwnerUsername

当此授权服务器支持资源所有者密码授权类型时，可以根据需要指定。 默认的资源所有者用户名。
supportState

如果为 true，授权服务器将包含授权请求中对其响应的状态参数。 客户端可以使用状态参数来引发协议安全性。
tokenBodyParameters

此授权服务器的令牌终结点所需的其他参数表示为具有名称和值字符串属性的 JSON 对象数组，即 {“name” ： “name value”， “value”： “a value”}。
tokenEndpoint

OAuth 令牌终结点。 包含所引用实体的绝对 URI。
useInApiDocumentation

如果为 true，则将在开发人员门户的 API 文档中使用授权服务器。 如果未提供任何值，则默认为 False。
useInTestConsole

如果为 true，可以在开发人员门户测试控制台中使用授权服务器。 如果未提供任何值，则默认为 True。

继承属性

id

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会被序列化。 它只能由服务器填充。
name

资源的名称 注意：此属性不会被序列化。 它只能由服务器填充。
type

资源类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会被序列化。 它只能由服务器填充。

属性详细信息

authorizationEndpoint

OAuth 授权终结点。 请参阅 http://tools.ietf.org/html/rfc6749#section-3.2。

authorizationEndpoint?: string

属性值

string

authorizationMethods

授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。

authorizationMethods?: AuthorizationMethod[]

属性值

AuthorizationMethod[]

bearerTokenSendingMethods

指定用于向 API 传递访问令牌的机制。

bearerTokenSendingMethods?: string[]

属性值

string[]

clientAuthenticationMethod

此授权服务器的令牌终结点支持的身份验证方法。 可能的值为 Basic 和/或 Body。 指定 Body 时，客户端凭据和其他参数以 application/x-www-form-urlencoded 格式在请求正文中传递。

clientAuthenticationMethod?: string[]

属性值

string[]

clientId

已注册到此授权服务器的客户端或应用程序 ID。

clientId?: string

属性值

string

clientRegistrationEndpoint

对执行此授权服务器的客户端或应用程序注册时所在页的可选引用。 包含所引用实体的绝对 URL。

clientRegistrationEndpoint?: string

属性值

string

clientSecret

已注册到此授权服务器的客户端或应用程序机密。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。

clientSecret?: string

属性值

string

defaultScope

将按默认请求的访问令牌作用域。 可以在 API 级别重写。 应以包含空格分隔值的字符串形式提供。

defaultScope?: string

属性值

string

description

授权服务器的说明。 可以包含采用 HTML 格式的标记。

description?: string

属性值

string

displayName

用户友好的授权服务器名称。

displayName?: string

属性值

string

grantTypes

授权的形式，客户端使用该授权请求访问令牌。

grantTypes?: 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

useInApiDocumentation

如果为 true，则将在开发人员门户的 API 文档中使用授权服务器。 如果未提供任何值，则默认为 False。

useInApiDocumentation?: boolean

属性值

boolean

useInTestConsole

如果为 true，可以在开发人员门户测试控制台中使用授权服务器。 如果未提供任何值，则默认为 True。

useInTestConsole?: boolean

属性值

boolean

继承属性详细信息

id

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会被序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自ProxyResource.id

name

资源的名称 注意：此属性不会被序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自ProxyResource.name

type

资源类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会被序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自ProxyResource.type