OAuth2 Clients
Open Gateway (OG) has a number of OAuth2 Client setup requirements as outlined below.
OG Dashboard
The OG Consent Dashboard is accessed by Consumers to view the Agreements they have made with Software Products attached to OG.
| Item | Value |
|---|---|
| Realm Type | Consumer |
| Redirect URI | {OG_DASHBOARD_URI}/api/auth/callback/rbac_oauth |
| ID Token Claim - Permissions Required | None |
| ID Token Claims - Consumer Identifiers | biza-au:auth:user_id and biza-au:auth:principal_id |
This Guide explains how the OG Dashboard login can be integrated with AWS Cognito.
The following example demonstrates how you can add custom claims to an ID Token using the Auth0 Dashboard. Here is some useful background if you have not customised Auth0 before:
This code is to be used in the Auth0 Actions Library:
exports.onExecutePostLogin = async (event, api) => {
if (event.authorization) {
// Set claims
api.idToken.setCustomClaim('biza-au:auth:roles', []);
api.idToken.setCustomClaim('biza-au:auth:user_id', event.user.user_id);
api.idToken.setCustomClaim('biza-au:auth:principal_id', event.user.user_id);
}
};
OG API Access (M2M)
Software Products use Machine-to-Machine (M2M) credentials to authenticate with the Open Gateway API. These credentials are provisioned and administered by Biza via Biza ID — customers do not set up this OAuth2 client directly.
M2M credentials and the required permission scopes are provided to customers as part of the onboarding process.
For the full scope list associated with the OG Access profile, refer to OAuth2 Profiles — OG Access.