Package io.moov.sdk

Class Authentication

java.lang.Object

io.moov.sdk.Authentication

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallCreateAccessToken, SDKMethodInterfaces.MethodCallRevokeAccessToken

public class Authentication
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallRevokeAccessToken, SDKMethodInterfaces.MethodCallCreateAccessToken

Method Summary

Modifier and Type	Method	Description
CreateAccessTokenRequestBuilder	createAccessToken()	Create or refresh an access token.
CreateAccessTokenResponse	createAccessToken(AuthTokenRequest authTokenRequest)	Create or refresh an access token.
CreateAccessTokenResponse	createAccessToken(java.util.Optional<java.lang.String> xMoovVersion, AuthTokenRequest authTokenRequest)	Create or refresh an access token.
RevokeAccessTokenRequestBuilder	revokeAccessToken()	Revoke an auth token.
RevokeAccessTokenResponse	revokeAccessToken(RevokeTokenRequest revokeTokenRequest)	Revoke an auth token.
RevokeAccessTokenResponse	revokeAccessToken(java.util.Optional<java.lang.String> xMoovVersion, RevokeTokenRequest revokeTokenRequest)	Revoke an auth token.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

revokeAccessToken

public RevokeAccessTokenRequestBuilder revokeAccessToken()

Revoke an auth token.

Allows clients to notify the authorization server that a previously obtained refresh or access token is no longer needed.

Returns:

The call builder

revokeAccessToken

public RevokeAccessTokenResponse revokeAccessToken(RevokeTokenRequest revokeTokenRequest)
                                            throws java.lang.Exception

Revoke an auth token.

Allows clients to notify the authorization server that a previously obtained refresh or access token is no longer needed.

Parameters:

revokeTokenRequest -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

revokeAccessToken

public RevokeAccessTokenResponse revokeAccessToken(java.util.Optional<java.lang.String> xMoovVersion,
                                                   RevokeTokenRequest revokeTokenRequest)
                                            throws java.lang.Exception

Revoke an auth token.

Allows clients to notify the authorization server that a previously obtained refresh or access token is no longer needed.

Specified by:

revokeAccessToken in interface SDKMethodInterfaces.MethodCallRevokeAccessToken

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

revokeTokenRequest -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createAccessToken

public CreateAccessTokenRequestBuilder createAccessToken()

Create or refresh an access token.

Returns:

The call builder

createAccessToken

public CreateAccessTokenResponse createAccessToken(AuthTokenRequest authTokenRequest)
                                            throws java.lang.Exception

Create or refresh an access token.

Parameters:

authTokenRequest -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createAccessToken

public CreateAccessTokenResponse createAccessToken(java.util.Optional<java.lang.String> xMoovVersion,
                                                   AuthTokenRequest authTokenRequest)
                                            throws java.lang.Exception

Create or refresh an access token.

Specified by:

createAccessToken in interface SDKMethodInterfaces.MethodCallCreateAccessToken

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

authTokenRequest -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails