AuthenticationApi

Functions

authenticateWithJwt

@POST(value = jwtAuthenticate)

abstract suspend fun authenticateWithJwt(@Body() jwtAuthenticateRequestDto: JwtAuthenticateRequestDto): Response<JwtAuthenticateResponseDto>

Authentication using JWT Allows clients to authenticate and acquire an access token using a JSON Web Token.

createAccessToken

@POST(value = accessToken)

abstract suspend fun createAccessToken(@Query(value = grant_type) grantType: String, @Query(value = redirect_uri) redirectUri: String, @Query(value = code) code: String, @Query(value = refresh_token) refreshToken: String, @Body() accessTokenRequestDto: AccessTokenRequestDto): Response<AccessTokenResponseDto>

Obtain an Access Token Allows a client to use its credentials to obtain an access token, to swap an authorization grant for an access token, or to swap a refresh token for a new access token.

getAuthorizationGrant

@GET(value = authorizationGrant)

abstract suspend fun getAuthorizationGrant(@Query(value = client_id) clientId: String, @Query(value = response_type) responseType: String, @Query(value = redirect_uri) redirectUri: String, @Query(value = credential_type) credentialType: String? = "sensibill", @Query(value = redirect) redirect: String? = "true"): Response<AuthorizationResponse>

Request an authorization grant Allows clients to request an authorization grant to begin the OAuth2 flow.

getClientInfo

@GET(value = clientInfo)

abstract suspend fun getClientInfo(): Response<ClientInfoResponseDto>

Client information Allows a client to retrieve information about itself.

invalidateAccessToken

@POST(value = invalidate)

abstract suspend fun invalidateAccessToken(): Response<Unit>

Invalidate access token This endpoint can be used to permanently invalidate an access token.

logout

@GET(value = logout)

abstract suspend fun logout(): Response<Unit>

Logout user Performs a user logout, clearing the session and invalidating the access token.