OAuthModel interface
Modelo para autenticação de API com OAuth2.
- Extends
Propriedades
| access |
Prepend do token de acesso. O padrão é "Portador". |
| authorization |
O código de autorização do usuário. |
| authorization |
O ponto de extremidade de autorização. |
| authorization |
Os cabeçalhos do ponto de extremidade de autorização. |
| authorization |
Os parâmetros de consulta do ponto de extremidade de autorização. |
| client |
A ID do aplicativo (cliente) que o provedor OAuth atribuiu ao seu aplicativo. |
| client |
O segredo do aplicativo (cliente) que o provedor OAuth atribuiu ao seu aplicativo. |
| grant |
O tipo de concessão, geralmente, será "código de autorização". |
| is |
Indicando se queremos enviar o clientId e clientSecret para o ponto de extremidade de token nos cabeçalhos. |
| is |
Um valor que indica se é um fluxo JWT. |
| redirect |
A URL de redirecionamento de aplicativo que o usuário configura no provedor OAuth. |
| scope | O escopo do aplicativo (cliente) que o provedor OAuth atribuiu ao seu aplicativo. |
| token |
O ponto de extremidade do token. Define o token de atualização OAuth2. |
| token |
Os cabeçalhos do ponto de extremidade do token. |
| token |
Os parâmetros de consulta de ponto de extremidade de token. |
| type | O tipo de autenticação |
Detalhes da propriedade
accessTokenPrepend
Prepend do token de acesso. O padrão é "Portador".
accessTokenPrepend?: stringValor da propriedade
string
authorizationCode
O código de autorização do usuário.
authorizationCode?: stringValor da propriedade
string
authorizationEndpoint
O ponto de extremidade de autorização.
authorizationEndpoint?: stringValor da propriedade
string
authorizationEndpointHeaders
Os cabeçalhos do ponto de extremidade de autorização.
authorizationEndpointHeaders?: Record<string, string>Valor da propriedade
Record<string, string>
authorizationEndpointQueryParameters
Os parâmetros de consulta do ponto de extremidade de autorização.
authorizationEndpointQueryParameters?: Record<string, string>Valor da propriedade
Record<string, string>
clientId
A ID do aplicativo (cliente) que o provedor OAuth atribuiu ao seu aplicativo.
clientId: stringValor da propriedade
string
clientSecret
O segredo do aplicativo (cliente) que o provedor OAuth atribuiu ao seu aplicativo.
clientSecret: stringValor da propriedade
string
grantType
O tipo de concessão, geralmente, será "código de autorização".
grantType: stringValor da propriedade
string
isCredentialsInHeaders
Indicando se queremos enviar o clientId e clientSecret para o ponto de extremidade de token nos cabeçalhos.
isCredentialsInHeaders?: booleanValor da propriedade
boolean
isJwtBearerFlow
Um valor que indica se é um fluxo JWT.
isJwtBearerFlow?: booleanValor da propriedade
boolean
redirectUri
A URL de redirecionamento de aplicativo que o usuário configura no provedor OAuth.
redirectUri?: stringValor da propriedade
string
scope
O escopo do aplicativo (cliente) que o provedor OAuth atribuiu ao seu aplicativo.
scope?: stringValor da propriedade
string
tokenEndpoint
O ponto de extremidade do token. Define o token de atualização OAuth2.
tokenEndpoint: stringValor da propriedade
string
tokenEndpointHeaders
Os cabeçalhos do ponto de extremidade do token.
tokenEndpointHeaders?: Record<string, string>Valor da propriedade
Record<string, string>
tokenEndpointQueryParameters
Os parâmetros de consulta de ponto de extremidade de token.
tokenEndpointQueryParameters?: Record<string, string>Valor da propriedade
Record<string, string>
type
O tipo de autenticação
type: "OAuth2"Valor da propriedade
"OAuth2"
