AuthorizationServerContractProperties interface

Pacote:

@azure/arm-apimanagement

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

Extends

AuthorizationServerContractBaseProperties

Propriedades

authorizationEndpoint	Ponto de extremidade de autorização OAuth. Ver http://tools.ietf.org/html/rfc6749#section-3.2.
clientId	ID do cliente ou aplicativo registrado com este servidor de autorização.
clientRegistrationEndpoint	Referência opcional a uma página onde o registro de cliente ou aplicativo para este servidor de autorização é executado. Contém URL absoluta para a entidade que está sendo referenciada.
clientSecret	Segredo do cliente ou aplicativo registrado neste servidor de autorização. Esta propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
displayName	Nome do servidor de autorização de fácil utilização.
grantTypes	Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso.
useInApiDocumentation	Se verdadeiro, 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 verdadeiro, o servidor de autorização pode ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido.

Propriedades Herdadas

authorizationMethods	Verbos HTTP suportados pelo ponto de extremidade de autorização. O GET deve estar sempre presente. O POST é opcional.
bearerTokenSendingMethods	Especifica o mecanismo pelo qual o token de acesso é passado para a API.
clientAuthenticationMethod	Método de autenticação suportado pelo ponto de extremidade de token deste 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.
defaultScope	Escopo do token de acesso que será solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres contendo valores delimitados por espaço.
description	Descrição do servidor de autorização. Pode conter tags de formatação HTML.
resourceOwnerPassword	Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário do recurso é suportado por este servidor de autorização. Senha padrão do proprietário do recurso.
resourceOwnerUsername	Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário do recurso é suportado por este servidor de autorização. Nome de usuário padrão do proprietário do recurso.
supportState	Se verdadeiro, o servidor de autorização incluirá o parâmetro state da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro state para aumentar a segurança do protocolo.
tokenBodyParameters	Parâmetros adicionais exigidos pelo ponto de extremidade de token deste 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 URI absoluto para entidade que está sendo referenciada.

Detalhes de Propriedade

authorizationEndpoint

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

authorizationEndpoint: string

Valor de Propriedade

string

clientId

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

clientId: string

Valor de Propriedade

string

clientRegistrationEndpoint

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

clientRegistrationEndpoint: string

Valor de Propriedade

string

clientSecret

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

clientSecret?: string

Valor de Propriedade

string

displayName

Nome do servidor de autorização de fácil utilização.

displayName: string

Valor de Propriedade

string

grantTypes

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

grantTypes: string[]

Valor de Propriedade

string[]

useInApiDocumentation

Se verdadeiro, 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 de Propriedade

boolean

useInTestConsole

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

useInTestConsole?: boolean

Valor de Propriedade

boolean

Detalhes da Propriedade Herdada

authorizationMethods

Verbos HTTP suportados pelo ponto de extremidade de autorização. O GET deve estar sempre presente. O POST é opcional.

authorizationMethods?: AuthorizationMethod[]

Valor de Propriedade

AuthorizationMethod[]

herdado deAuthorizationServerContractBaseProperties.authorizationMethods

bearerTokenSendingMethods

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

bearerTokenSendingMethods?: string[]

Valor de Propriedade

string[]

herdado deAuthorizationServerContractBaseProperties.bearerTokenSendingMethods

clientAuthenticationMethod

Método de autenticação suportado pelo ponto de extremidade de token deste 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 de Propriedade

string[]

herdado deAuthorizationServerContractBaseProperties.clientAuthenticationMethod

defaultScope

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

defaultScope?: string

Valor de Propriedade

string

herdado do AuthorizationServerContractBaseProperties.defaultScope

description

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

description?: string

Valor de Propriedade

string

herdado deAuthorizationServerContractBaseProperties.description

resourceOwnerPassword

Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário do recurso é suportado por este servidor de autorização. Senha padrão do proprietário do recurso.

resourceOwnerPassword?: string

Valor de Propriedade

string

herdado de AuthorizationServerContractBaseProperties.resourceOwnerPassword

resourceOwnerUsername

Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário do recurso é suportado por este servidor de autorização. Nome de usuário padrão do proprietário do recurso.

resourceOwnerUsername?: string

Valor de Propriedade

string

herdado de AuthorizationServerContractBaseProperties.resourceOwnerUsername

supportState

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

supportState?: boolean

Valor de Propriedade

boolean

herdado do AuthorizationServerContractBaseProperties.supportState

tokenBodyParameters

Parâmetros adicionais exigidos pelo ponto de extremidade de token deste 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 de Propriedade

TokenBodyParameterContract[]

herdado doAuthorizationServerContractBaseProperties.tokenBodyParameters

tokenEndpoint

Ponto de extremidade do token OAuth. Contém URI absoluto para entidade que está sendo referenciada.

tokenEndpoint?: string

Valor de Propriedade

string

herdado doAuthorizationServerContractBaseProperties.tokenEndpoint