Skip to main content

OAuth2 Profiles

info

This documentation is currently under development and will be updated with additional information and architecture diagrams as they become available.

Due to the varied nature of Open Gateway (OG) endpoints, there are a number of different OAuth2 client profiles (i.e., configurations).

This page outlines the individual security profiles relevant to the operation of OG.

For specific client configurations required please refer to the OAuth2 Clients page.

Consumer​

This profile is intended for the identity and access management of end-user Consumers of OG and its associated Software Products. This is the only OAuth2 profile that customers are required to configure.

ItemValue
Intended AuthorisersEnd Users
Grant Typesauthorization_code and refresh_token
Back-channel Client TypeConfidential
Back-channel Client AuthClient Secret Post
Response Typecode with PKCE
Scopes Requiredopenid email profile
Access Token FormatJWT
ID Token Claim - Permissionsroles or biza-au:auth:roles as JSON string array
ID Token Claims - Consumer Identifiersbiza-au:auth:user_id containing the User ID
biza-au:auth:principal_id containing the Principal ID
warning

Consumer Identity relies on globally consistent User and Principal IDs to be provided which align with these identifiers passed via other channels such as the Open Gateway API utilised by downstream software products.

OG Access​

This profile is a machine-to-machine (M2M) client profile for interacting with Open Gateway APIs and is used by Software Products to retrieve CDR Data.

OG Access credentials are administered by Biza on behalf of customers. Customers do not configure this profile directly — credentials and roles are provisioned during the onboarding process.

ItemValue
Intended AuthorisersSoftware Products using Open Gateway API
Client TypeConfidential
Client AuthClient Secret Post
Grant Type(s)client_credentials
Scopes RequiredDepends on Software Product
Access Token FormatJWT
Expected aud of ATs{OG_API_URI} or CLIENT_ID
Permissions Identifier (Access Token)roles or biza-au:auth:roles as JSON string array
Access Token Claim - Software Productbiza-au:og:software_product_id containing the OG Software Product Identifier
important

One of Permissions Identifier (Token Endpoint) or Permissions Identifier (Access Token) are required.