Auth Info

The auth_info claim provides authorization details for the authenticated user.

This claim is only returned in the Userinfo Endpoint response if authinfo scope is present.

auth_info Attributes

Field	Data Type	Length	Description
Result_Set	JSON	-	Digital Service authorization result set.

auth_info.Result_Set attributes

Field	Data Type	Length	Description
ESrvc_Row_Count	Integer	10	The number of Digital Services for which the authorizations are present in the Result_Set.ESrvc_Result JSON object. Returns 0 if ESrvc_Result is empty.
ESrvc_Result	Array of JSON	-	Array of JSON objects, each containing authorization details for the Digital Service. Refer to E-Service item attributes for more details.

E-Service item attributes (auth_info.Result_Set.ESrvc_Result[] item)

Contains authorization details for the digital service.

Field	Data Type	Length	Description
CPESrvcID	String	25	The readable ID of the Digital Service.
Auth_Result_Set	JSON	-	JSON object. Contains user assignment details for the Digital Service. Refer to User Assignment Result Set attributes for more details.

User Assignment Result Set attributes (auth_info.Result_Set.ESrvc_Result[].Auth_Result_Set)

Field	Data Type	Length	Description
Row_Count	Integer	10	The number of rows included in the auth result set (ie. number of assignments the user has for the e-service). e.g. If the user is granted two separate assignments to the same e-service on behalf of the same entity, this value will be 2 . The following result set will contain then contain two objects, each representing one assignment.
Row	Array of JSON	-	Array of JSON objects, where each JSON object describes a single third-party assignment. Refer to User Assignment Item attributes for more details.

User Assignment Item attributes (auth_info.Result_Set.ESrvc_Result[].Auth_Result_Set.Row[] item)

Field	Data Type	Length	Description
CPEntID_SUB	String	32	Sub-UEN value of that entity to which the user is assigned the authorization. If the Digital Service requires a mandatory Sub-UEN attribute but no value was supplied, "ERROR_MISSING_VALUE" will be returned for the field.
CPRole	String	20	The role assigned to the user in this particular authorisation.
StartDate	String (format YYYY-MM-DD)	10	The start date for validity of the authorisation.
EndDate	String (format YYYY-MM-DD)	10	The end date for validity of the authorisation.
Parameter	Array of JSON	-	This is an 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. 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. Refer to User Assignment Parameter attributes for more details.

User Assignment Parameter attributes (auth_info.Result_Set.ESrvc_Result[].Auth_Result_Set.Row[].Parameter)

Field	Data Type	Length	Description
name	String	30	Parameter name defined by defined by Digital Service administrator
value	String	66	Parameter value defined by defined by Digital Service administrator

Sample Payload

User with two authorisations

Authorization info payload for a User with two authorisations:

• One to e-service SAMPLE-ESERVICE

• One to e-service OTHER-ESERVICE

{
  "auth_info": {
    "Result_Set": {
      "ESrvc_Row_Count": 2,
      "ESrvc_Result": [
        {
          "CPESrvcID": "SAMPLE-ESERVICE",
          "Auth_Result_Set": {
            "Row_Count": 1,
            "Row": [
              {
                "CPEntID_SUB": "",
                "CPRole": "Approver",
                "StartDate": "2017-11-14",
                "EndDate": "9999-12-31",
                "Parameter": [
                  {
                    "name": "Effective YA",
                    "value": "2020"
                  },
                ]
              }
            ]
          }
        },
        {
          "CPESrvcID": "OTHER-ESERVICE",
          "Auth_Result_Set": {
            "Row_Count": 1,
            "Row": [
              {
                "CPEntID_SUB": "",
                "CPRole": "Editor",
                "StartDate": "2017-11-14",
                "EndDate": "9999-12-31",
                "Parameter": []
              }
            ]
          }
        }
      ]
    }
  }
}