Scopes

Scopes are used during authentication to authorise access to a user's details.

In the context of Corppass, each scope grants access to a set of entity or acting user's attributes called claims. Once authorised, these claims are turned in an ID Token (via the Token Endpoint) and/or made available via the Userinfo Endpoint.

Usage

To initiate an OpenID Connect flow, clients must specify the desired permissions as a space-delimited list in the scope parameter of the request.

Refer to the Pushed Authorization Request section for detailed specifications on constructing the request.

Consent Screen

Depending on the requested scopes, a consent screen may be displayed to the end user during authorization. The consent screen informs the user about the data or permissions being requested and allows them to grant or deny access.

Supported Scopes

Protocol Scopes

Scope	Description
openid	Mandatory scope to indicate the request is an OpenID Connect flow. Required for all requests.

Authorization Scopes

Scope	Description	Data Access	Endpoint
authinfo	View authorization details for the authenticated user.	auth_info	Userinfo
tpauthinfo	View third-party authorization details for the authenticated user.	tp_auth_info	Userinfo

Entity Scopes

Scope	Description	Data Access	Endpoint
entity.identity	View entity identity - includes entity type, registration number, and country of incorporation.	sub_attributes entity_type entity_reg_number entity_coi	Token
entity.basic_profile.entity_name	View entity name.	sub_attributes entity_name	Token
entity.basic_profile.uen_status	View entity UEN status.	sub_attributes entity_uen_status	Token

User Scopes

Scope	Description	Data Access	Endpoint
user.identity	View acting user's identity - includes account type, identity number, and country of issuance.	act.sub_attributes account_type identity_number identity_coi	Token
user.name	View acting user's name.	act.sub_attributes name	Token
user.corppass.email	View acting user's Corppass registered email address.	act.sub_attributes corppass_email corppass_email_verified	Token