Record: PasswordGrantConfig

Represents the data structure, which is used to configure the OAuth2 password grant type.

Closed record


  • tokenUrl string
  • Token URL of the token endpoint

  • username string
  • Username for the password grant type

  • password string
  • Password for the password grant type

  • clientId string?
  • Client ID of the client authentication

  • clientSecret string?
  • Client secret of the client authentication

  • scopes string[ ]?
  • Scope(s) of the access request

  • refreshConfig record {| refreshUrl string, scopes string[ ], optionalParams map<string>, credentialBearer CredentialBearer, clientConfig ClientConfiguration |}?
  • Configurations for refreshing the access token

  • defaultTokenExpTime decimal(default 3600)
  • Expiration time (in seconds) of the tokens if the token endpoint response does not contain an expires_in field

  • clockSkew decimal(default 0)
  • Clock skew (in seconds) that can be used to avoid token validation failures due to clock synchronization problems

  • optionalParams map<string>?
  • Map of the optional parameters used for the token endpoint

  • credentialBearer CredentialBearer(default AUTH_HEADER_BEARER)
  • Bearer of the authentication credentials, which is sent to the token endpoint

  • clientConfig ClientConfiguration(default {})
  • HTTP client configurations, which are used to call the token endpoint