Compartilhar via


AuthorizationServerContractBaseProperties interface

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

Propriedades

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.

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.

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.

Detalhes da propriedade

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

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[]

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

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

tokenEndpoint

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

tokenEndpoint?: string

Valor da propriedade

string