Corppass
  • INTRODUCTION
    • About Corppass
    • Corppass Design Guidelines
      • Brand Guidelines
      • Button Guidelines
  • Technical Specifications
    • Corppass Authorization API
      • Key concepts
        • Client JWKS
        • JWS and JWE
        • Client Assertion JWT
        • Proof Key of Code Exchange (PKCE)
      • Staging and Production URLs
      • Well-known Endpoints
        • OpenID Discovery Endpoint
        • JWKS Endpoint
      • Scopes
      • Authorization Endpoint
        • Authorization Code with Proof Key of Code Exchange (PKCE) Flow
        • Pushed Authorization Request (PAR) Flow
      • Token Endpoint
        • ID Token Structure
          • UserInfo Claim Structure
          • EntityInfo Claim Structure
        • Access Token Structure
      • Authorization Info Endpoint
        • AuthInfo Structure
        • TPAuthInfo Structure
      • Pushed Authorization Request (PAR) Endpoint
  • Corppass Developer Portal (CDP)
    • User Guide
      • Getting Started
      • Login to CDP
      • Available Digital Service Settings
        • FAQs
      • Toggle Between Staging and Production Environments
      • Portal Features
        • Updating the Digital Service and Managing Metadata
      • User Roles and Permissions
      • Frequently Asked Questions (FAQ)
        • Login Issues
        • Access and Permissions
        • How is CDP Different from Corppass Agency Admin (AA) Portal?
        • Other Common Issues
  • MORE INFORMATION
    • Is Corppass working?
    • Contact Us
Powered by GitBook
On this page
  1. Technical Specifications
  2. Corppass Authorization API
  3. Authorization Info Endpoint

AuthInfo Structure

PreviousAuthorization Info EndpointNextTPAuthInfo Structure

Last updated 2 months ago

The AuthInfo claim provides detailed user authorization information. The table below describes the fields included in the AuthInfo claim returned by the .

Mandatory Field: Always present in the object and contain values, which could be a blank string if no data is available.

Non-Mandatory Field: Included only if data is available and not required by the schema.

Field
Description
Data Type
Length
Mandatory

Auth_Result_Set

JSON object contains authorization result for the user for a specific Digital Service.

JSON

-

Yes

CPEntID_SUB

Sub-UEN value of that entity to which the user is assigned the authorization. Sub-UEN is a mandatory attribute for a Digital Service if there is no value was supplied, "ERROR_MISSING_VALUE" will be returned for the field.

String

32

Yes

CPESrvcID

ID of the Digital Service that is requesting the authorization.

String

25

Yes

CPRole

The role assigned to the user for that Digital Service.

String

20

Yes

EndDate

The end date for validity of the role i.e. the date at which this role is no longer valid for the user for that Digital Service.

String (format YYYY-MM-DD)

10

Yes

ESrvc_Result

Array of JSON objects, each object contains authorization details for a specific Digital Service. There could be scenario where ESrvc_Row_Count = 0, when ESrvc_Row_Count = 0, ESrvc_Result will be an empty array

Array of JSON

-

Yes

ESrvc_Row_Count

This value indicates the number of Digital Services for which the authorizations are present in the Result_Set JSON object.

Integer

10

Yes

name

Parameter name defined by defined by Digital Service administrator

String

30

No

Parameter

This is optional array of parameters (JSON objects containing only name and value pair attributes) defined by Digital Service administrator. These parameters will be populated as required. These parameters use a name-value pair format and will contain the "Digital Service defined name" from Corppass in the name field. If no parameters are defined this will be returned as empty array. If a parameter is defined as mandatory by the Digital Service administrator but no value was supplied, "ERROR_MISSING_VALUE" will be returned for the field.

Array of JSON

-

Yes

Result_Set

Digital Service authorization result set.

JSON

-

Yes

Row

Array of JSON objects, each JSON object represents actual authorization values for a given Sub-UEN for a user.

Array of JSON

-

Yes

Row_Count

The count of the number of rows included in the auth result set e.g. If the user access to two Sub-UENs within the same entity, the result set will contain two rows with the role information for each Sub-UEN in one individual row.

Integer

10

Yes

StartDate

The start date for validity of the role i.e. the date from which this role is valid for the user for that Digital Service.

String (format YYYY-MM-DD)

10

Yes

value

Parameter value defined by defined by Digital Service administrator

String

66

No

Authorization Info Endpoint