Skip to main content

Step 3. Get User

The third step in consent flow is to get information about a specific Principal (using the principalid) and return the customer information, which may be for an individual (Person) or a company (Organisation).

Note

This step may be skipped if there is only ONE PRINCIPAL associated with the username (i.e., the user has no authority to operate/ATO or does not have any shared accounts).

Data Adapter Call​

Get User

POST/login/user

Note

For every principal returned from Step 2, Get User is called, and depending on the response we do the following things.

This data adapter call happens before the page is loaded for each principal returned from Step 2.

Responses and Error Mapping​

Note

Please be aware that the adapter calls for Consent flow (CDR data sharing) and Dashboard Login occur on 2 different realms. If you return 451 errors for CDR Consent Flow, you will also block login for the dashboard.

HTTP Status - 200 - Success​

This applies when the user has successfully authenticated and is eligible for CDR sharing as per the example screenshot below.

Select Principal screen

  • Next Action
    • Principal name will be taken from getUser (Step 2) which will be used in the account selector screen, as well as the ATOs.
  • Screen displayed to user

account selector page

HTTP Status - 400 - Invalid Field​

This applies when there is an OAuth error and the flow is terminated.

  • URN code
    • "urn:au-cds:error:cds-all:Field/Invalid"
  • Next action
    • Redirect back to the ADR
  • Error to User
    • Determined by the ADR

HTTP Status - 400 - Expected Error Encountered​

This applies when there is an OAuth error and the flow is terminated.

  • URN code
    • "urn:au-cds:error:cds-all:GeneralError/Expected"
  • Next action
    • Redirect back to the ADR
  • Error to User
    • Determined by the ADR

HTTP Status - 400 - Invalid Header​

This applies when there is an OAuth error and the flow is terminated.

  • URN code
    • "urn:au-cds:error:cds-all:Header/Invalid"
  • Next action
    • Redirect back to the ADR
  • Error to User
    • Determined by the ADR

HTTP Status - 404 - Invalid Resource​

This applies when there is an OAuth error and the flow is terminated.

  • URN code
    • "urn:au-cds:error:cds-all:Resource/Invalid"
  • Next action
    • Redirect back to the ADR
  • Error to User
    • Determined by the ADR

HTTP Status - 422 - Expected Error Encountered​

This applies when there is an OAuth error and the flow is terminated.

  • URN code
    • "urn:au-cds:error:cds-all:GeneralError/Expected"
  • Next action
    • Redirect back to the ADR
  • Error to User
    • Determined by the ADR

HTTP Status - 429 - Too Many Requests​

This is used for data adapter rate limiting to the HaaS platform.

  • Next action
    • Redirect back to the ADR
  • Error to User
    • Determined by the ADR

This status code indicates that the server is denying access to the resource as a consequence of a legal demand.

  • URN code
    • "urn:dio:error:cds-all:Resource/LegalBlock"
  • Next Action
    • Principal (customer) account not added to profile selection. No specific flag.
  • Error to User
    • There will not be a principle available for selection.
  • Screen displayed to user
    • User will see the Login screen upon clicking "Back"

HTTP Status - 451 - Ineligible block​

This status code indicates that the Customer is ineligible for CDR Data Sharing. Ineligible user set to true.

  • URN code
    • urn:dio:error:cds-all:Resource/IneligibleBlock
  • Next Action
    • Principal (customer) account not added to profile selection. Has ineligible principal flag set to true.
  • Error to User
    • "Some of your customers are not eligible for data sharing at this time".
  • Screen displayed to user
    • User will see the Login screen upon clicking "Back"

image

HTTP Status - 451 - Call Centre Block​

This status code indicates that the customer should call the Call Center for further information.

  • URN code
    • urn:dio:error:cds-all:Resource/CallCenterBlock
  • Next Action
    • Principal (customer) account not added to profile selection. Has call centre flag set to true.
  • Error to User
    • "Data Sharing is not possible at this time. Please contact the call centre to resolve"
  • Screen displayed to user
    • User will see the Login screen upon clicking "Back"

image

Note

For 451 errors, the following applies

  • If there are no selectable principals (customers)
    • If the Ineligible Customer Flag is set - there will be an ineligible warning and the "next" button will be deactivated.
    • If the Call Centre Block flag is set - there will be a call centre block warning and the "next" button will not appear.
    • If no flags are set - a generic warning will be displayed and the "next" button will be deactivated.
  • If the Ineligible flag is set - an ineligible warning will appear, and the principal selector screen will be displayed but have no accounts will be available to select, but the "next" button will appear.

HTTP Status - 504 - Gateway timout​

This error applies when there is a network connection issue or when the web server has not received a timely response from an upstream server that it needed to access to complete the request.

  • URN code
    • TBA
  • Error to User
    • Gateway timeout
  • Screen displayed to user
    • Please note that the screen below will only be displayed in production (not in the test environments)

image