AuthorizationServerContractBaseProperties interface
Contrato de configurações de atualização do servidor de autorização OAuth externo.
Propriedades
| authorization |
Verbos HTTP suportados pelo ponto de extremidade de autorização. O GET deve estar sempre presente. O POST é opcional. |
| bearer |
Especifica o mecanismo pelo qual o token de acesso é passado para a API. |
| client |
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. |
| default |
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. |
| resource |
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. |
| resource |
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. |
| support |
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. |
| token |
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"}. |
| token |
Ponto de extremidade do token OAuth. Contém URI absoluto para entidade que está sendo referenciada. |
Detalhes de Propriedade
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
bearerTokenSendingMethods
Especifica o mecanismo pelo qual o token de acesso é passado para a API.
bearerTokenSendingMethods?: string[]
Valor de Propriedade
string[]
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[]
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
description
Descrição do servidor de autorização. Pode conter tags de formatação HTML.
description?: string
Valor de Propriedade
string
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
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
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
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
tokenEndpoint
Ponto de extremidade do token OAuth. Contém URI absoluto para entidade que está sendo referenciada.
tokenEndpoint?: string
Valor de Propriedade
string