Skip to main content

Step 3. Get User

The third step when logging into the dashboard 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](./images/Select principal screen.png)

  • Next Action
    • The user will be taken to the dashboard home screen.
  • Screen displayed to user

Dashboard Homescreen

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 dashboard login
  • Error to User
    • Server_error

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 dashboard login
  • Error to User
    • Server_error

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 dashboard login
  • Error to User
    • Server_error

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 dashboard login
  • Error to User
    • Server_error

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 dashboard login
  • Error to User
    • Server_error

HTTP Status - 429 - Too Many Requests​

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

  • Next action
    • Redirect back to dashboard login
  • Error to User
    • Server_error

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 (see screenshot below).

Image

  • Error to User
    • "Your login is not eligible for data sharing at this time. Please press back to return to the login page".
  • Screen displayed to user
    • User will see the Dashboard 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.

Image

  • Error to User
    • "Your login is not eligible for data sharing at this time. Please press back to return to the login page".
  • Screen displayed to user
    • User will see the Dashboard Login screen upon clicking "Back"

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.

Image

  • 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 Dashboard Login screen upon clicking "Back"

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