Broadleaf Microservices
  • v1.0.0-latest-prod

Transaction Manager

Used for managing authorization transactions during the authorization code grant flow.

Authorization Transaction

Represents a transaction during the authorization code grant flow between the client and the Auth Server.

Properties

Name Type Required Description

clientId

string

✅

The client ID.

redirectUri

string

✅

The redirect URI.

scope

string

✅

The scope requested.

responseType

string

✅

The response type.

state

string

✅

The random state string.

appState

unknown

❌

Any application data stored with the transaction.

Get Transaction

Retrieves the currently stored transaction record if any.

Operation

TransactionManager#get(options);

Parameters

None.

Response

The requested AuthorizationTransaction or undefined if not found.

Create Transaction

Stores a new transaction record.

Operation

TransactionManager#create(transaction);

Parameters

Parameter Type Required? Description

transaction

AuthorizationTransaction

✅

The transaction to create and store.

Response

None.

Remove Transaction

Remove transaction from the manager because it is completed.

Operation

TransactionManager#remove();

Parameters

None.

Response

None.