AuthorizationServerContract interface

Pacote:

@azure/arm-apimanagement

Configurações externas do servidor de autorização OAuth.

Extends

ProxyResource

Propriedades

authorizationEndpoint	Ponto de extremidade de autorização OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2.
authorizationMethods	Verbos HTTP compatíveis com o ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional.
bearerTokenSendingMethods	Especifica o mecanismo pelo qual o token de acesso é passado para a API.
clientAuthenticationMethod	Método de autenticação com suporte pelo ponto de extremidade do token desse servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando Body é especificado, as credenciais do cliente e outros parâmetros são passados dentro do corpo da solicitação no formato application/x-www-form-urlencoded.
clientId	ID do cliente ou do aplicativo registrado com esse servidor de autorização.
clientRegistrationEndpoint	Referência opcional para uma página em que o registro de cliente ou aplicativo para esse servidor de autorização é executado. Contém a URL absoluta para a entidade referenciada.
clientSecret	Segredo do cliente ou do aplicativo registrado com esse servidor de autorização. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
defaultScope	Escopo do token de acesso que vai ser solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres que contém valores delimitados por espaço.
description	Descrição do servidor de autorização. Pode conter marcas de formatação HTML.
displayName	Nome do servidor de autorização amigável.
grantTypes	Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso.
resourceOwnerPassword	Pode, opcionalmente, ser especificado quando o tipo de concessão de senha de proprietário do recurso é compatível com esse servidor de autorização. Senha do proprietário do recurso padrão.
resourceOwnerUsername	Pode, opcionalmente, ser especificado quando o tipo de concessão de senha de proprietário do recurso é compatível com esse servidor de autorização. Nome de usuário do proprietário do recurso padrão.
supportState	Se for true, o servidor de autorização incluirá o parâmetro de estado da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro de estado para aumentar a segurança de protocolo.
tokenBodyParameters	Parâmetros adicionais exigidos pelo ponto de extremidade de token desse servidor de autorização representado como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"name" : "name value", "value": "a value"}.
tokenEndpoint	Ponto de extremidade do token OAuth. Contém o URI absoluto para a entidade referenciada.
useInApiDocumentation	Se for true, o servidor de autorização será usado na documentação da API no portal do desenvolvedor. False por padrão se nenhum valor for fornecido.
useInTestConsole	Se for true, o servidor de autorização poderá ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido.

Propriedades herdadas

id	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name	O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da propriedade

authorizationEndpoint

Ponto de extremidade de autorização OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Valor da propriedade

string

authorizationMethods

Verbos HTTP compatíveis com o ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional.

authorizationMethods?: AuthorizationMethod[]

Valor da propriedade

AuthorizationMethod[]

bearerTokenSendingMethods

Especifica o mecanismo pelo qual o token de acesso é passado para a API.

bearerTokenSendingMethods?: string[]

Valor da propriedade

string[]

clientAuthenticationMethod

Método de autenticação com suporte pelo ponto de extremidade do token desse servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando Body é especificado, as credenciais do cliente e outros parâmetros são passados dentro do corpo da solicitação no formato application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Valor da propriedade

string[]

clientId

ID do cliente ou do aplicativo registrado com esse servidor de autorização.

clientId?: string

Valor da propriedade

string

clientRegistrationEndpoint

Referência opcional para uma página em que o registro de cliente ou aplicativo para esse servidor de autorização é executado. Contém a URL absoluta para a entidade referenciada.

clientRegistrationEndpoint?: string

Valor da propriedade

string

clientSecret

Segredo do cliente ou do aplicativo registrado com esse servidor de autorização. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.

clientSecret?: string

Valor da propriedade

string

defaultScope

Escopo do token de acesso que vai ser solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres que contém valores delimitados por espaço.

defaultScope?: string

Valor da propriedade

string

description

Descrição do servidor de autorização. Pode conter marcas de formatação HTML.

description?: string

Valor da propriedade

string

displayName

Nome do servidor de autorização amigável.

displayName?: string

Valor da propriedade

string

grantTypes

Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso.

grantTypes?: string[]

Valor da propriedade

string[]

resourceOwnerPassword

Pode, opcionalmente, ser especificado quando o tipo de concessão de senha de proprietário do recurso é compatível com esse servidor de autorização. Senha do proprietário do recurso padrão.

resourceOwnerPassword?: string

Valor da propriedade

string

resourceOwnerUsername

Pode, opcionalmente, ser especificado quando o tipo de concessão de senha de proprietário do recurso é compatível com esse servidor de autorização. Nome de usuário do proprietário do recurso padrão.

resourceOwnerUsername?: string

Valor da propriedade

string

supportState

Se for true, o servidor de autorização incluirá o parâmetro de estado da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro de estado para aumentar a segurança de protocolo.

supportState?: boolean

Valor da propriedade

boolean

tokenBodyParameters

Parâmetros adicionais exigidos pelo ponto de extremidade de token desse servidor de autorização representado como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Valor da propriedade

TokenBodyParameterContract[]

tokenEndpoint

Ponto de extremidade do token OAuth. Contém o URI absoluto para a entidade referenciada.

tokenEndpoint?: string

Valor da propriedade

string

useInApiDocumentation

Se for true, o servidor de autorização será usado na documentação da API no portal do desenvolvedor. False por padrão se nenhum valor for fornecido.

useInApiDocumentation?: boolean

Valor da propriedade

boolean

useInTestConsole

Se for true, o servidor de autorização poderá ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido.

useInTestConsole?: boolean

Valor da propriedade

boolean

Detalhes das propriedades herdadas

id

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor da propriedade

string

Herdado deProxyResource.id

name

O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor da propriedade

string

Herdado deProxyResource.name

type

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor da propriedade

string

Herdado deProxyResource.type