AuthorizationServerContractBaseProperties interface

Pacote:

@azure/arm-apimanagement

Contrato de definições de atualização do servidor de autorização OAuth externo.

Propriedades

authorizationMethods	Verbos HTTP suportados pelo ponto final de autorização. O GET tem de estar sempre presente. POST é opcional.
bearerTokenSendingMethods	Especifica o mecanismo através do qual o token de acesso é transmitido para a API.
clientAuthenticationMethod	Método de autenticação suportado pelo ponto final de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando o Corpo é especificado, as credenciais do cliente e outros parâmetros são transmitidos no corpo do pedido no formato application/x-www-form-urlencoded.
defaultScope	Âmbito do token de acesso que vai ser pedido por predefinição. Pode ser substituído ao nível da API. Deve ser fornecido sob a forma de uma cadeia que contém valores delimitados por espaço.
description	Descrição do servidor de autorização. Pode conter etiquetas de formatação HTML.
resourceOwnerPassword	Opcionalmente, pode ser especificado quando o tipo de concessão de palavra-passe do proprietário do recurso é suportado por este servidor de autorização. Palavra-passe predefinida do proprietário do recurso.
resourceOwnerUsername	Opcionalmente, pode ser especificado quando o tipo de concessão de palavra-passe do proprietário do recurso é suportado por este servidor de autorização. Nome de utilizador do proprietário do recurso predefinido.
supportState	Se for verdadeiro, o servidor de autorização incluirá o parâmetro de estado do pedido de autorização para a respetiva resposta. O cliente pode utilizar o parâmetro de estado para aumentar a segurança do protocolo.
tokenBodyParameters	Parâmetros adicionais exigidos pelo ponto final do token deste servidor de autorização representados como uma matriz de objetos JSON com propriedades de nome e cadeia de valor, ou seja, {"name" : "name value", "value": "a value"}.
tokenEndpoint	Ponto final do token OAuth. Contém o URI absoluto para a entidade que está a ser referenciada.

Detalhes de Propriedade

authorizationMethods

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

authorizationMethods?: AuthorizationMethod[]

Valor de Propriedade

AuthorizationMethod[]

bearerTokenSendingMethods

Especifica o mecanismo através do qual o token de acesso é transmitido para a API.

bearerTokenSendingMethods?: string[]

Valor de Propriedade

string[]

clientAuthenticationMethod

Método de autenticação suportado pelo ponto final de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando o Corpo é especificado, as credenciais do cliente e outros parâmetros são transmitidos no corpo do pedido no formato application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Valor de Propriedade

string[]

defaultScope

Âmbito do token de acesso que vai ser pedido por predefinição. Pode ser substituído ao nível da API. Deve ser fornecido sob a forma de uma cadeia que contém valores delimitados por espaço.

defaultScope?: string

Valor de Propriedade

string

description

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

description?: string

Valor de Propriedade

string

resourceOwnerPassword

Opcionalmente, pode ser especificado quando o tipo de concessão de palavra-passe do proprietário do recurso é suportado por este servidor de autorização. Palavra-passe predefinida do proprietário do recurso.

resourceOwnerPassword?: string

Valor de Propriedade

string

resourceOwnerUsername

Opcionalmente, pode ser especificado quando o tipo de concessão de palavra-passe do proprietário do recurso é suportado por este servidor de autorização. Nome de utilizador do proprietário do recurso predefinido.

resourceOwnerUsername?: string

Valor de Propriedade

string

supportState

Se for verdadeiro, o servidor de autorização incluirá o parâmetro de estado do pedido de autorização para a respetiva resposta. O cliente pode utilizar o parâmetro de estado para aumentar a segurança do protocolo.

supportState?: boolean

Valor de Propriedade

boolean

tokenBodyParameters

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

tokenBodyParameters?: TokenBodyParameterContract[]

Valor de Propriedade

TokenBodyParameterContract[]

tokenEndpoint

Ponto final do token OAuth. Contém o URI absoluto para a entidade que está a ser referenciada.

tokenEndpoint?: string

Valor de Propriedade

string