To Register a Client Application

You use the Connected Applications (SM303010) form to register an OAuth 2.0 or OpenID Connect (OIDC) client application.

To register a client application in MYOB Advanced, you need to know the flow that this application implements. For more information on the flows, see Authorization Code Flow, Implicit Flow, Resource Owner Password Credentials Flow, and Hybrid Flow.

Important:
  • According to the OAuth 2.0 specification, a secure connection between an OAuth 2.0 client application and the MYOB Advanced website with a Secure Socket Layer (SSL) certificate is required. Therefore, you have to set up the MYOB Advanced website for HTTPS before the OAuth 2.0 client application can work with data in MYOB Advanced. For more information, see Setting Up an HTTPS Service in Web Server (IIS).
  • When you are registering the client application, you have to be logged in to the tenant whose data the client application needs to access.

To Register a Client Application with the Authorization Code Flow

  1. In the Client Name box, type the name of the registered application.
    Note: Leave the Client ID box blank. The system will fill it in when you save your changes on the form.
  2. In the Flow box, select Authorization Code.
  3. Optionally, in the Plug-In box, select the plug-in that contains custom claims.
  4. On the Secrets tab, do the following for each client secret you want to add:
    1. On the tab toolbar, click Add Shared Secret. The Add Shared Secret dialog box opens.
    2. In the Description box, type the description of the shared secret.
    3. Optional: In the Expires On (UTC) box, enter the date and time on which the secret expires.
    4. Copy and save the value that is displayed in the Value box. The client application should use this client secret for authentication in MYOB Advanced.
      Important: For security reasons, the value of the secret is displayed only once: when you create the secret by invoking this dialog box.
    5. Click OK to save the secret and close the dialog box.
  5. On the Redirect URIs tab, do the following for each redirect URI you want to add:
    1. On the tab toolbar, click Add Row.
    2. In the Redirect URI column of the new row, type the exact redirect URI to which MYOB Advanced should redirect the client application after the client application has been authorized. The redirect URI must be absolute and must not have the fragment part (the part preceded with #).
  6. For the OIDC client application, on the Claims tab, in the Active column, select the claims that will be included in the ID token.
  7. On the form toolbar, click Save. Notice that the client ID has been generated in the Client ID box. The client application should use this client ID along with the client secret for authentication in MYOB Advanced.

To Register a Client Application with the Implicit Flow

  1. In the Client Name box, type the name of the registered application.
    Note: Leave the Client ID box blank. The system will fill it in when you save your changes on the form.
  2. In the Flow box, select Implicit.
  3. Optionally, in the Plug-In box, select the plug-in that contains custom claims.
  4. On the Redirect URIs tab, do the following for each redirect URI you want to add:
    1. On the tab toolbar, click Add Row.
    2. In the Redirect URI column of the new row, type the exact redirect URI to which MYOB Advanced should redirect the client application after the client application has been authorized. The redirect URI must be absolute and must not have the fragment part (the part preceded with #).
  5. For the OIDC client application, on the Claims tab, in the Active column, select the claims that will be included in the ID token.
  6. On the form toolbar, click Save. Notice that the client ID has been generated in the Client ID box. You should use this client ID to connect the client application to the authorization endpoint of MYOB Advanced.

To Register a Client Application with the Resource Owner Password Flow

  1. In the Client Name box, type the name of the registered application.
    Note: Leave the Client ID box blank. The system will fill it in when you save your changes on the form.
  2. In the Flow box, select Resource Owner Password Credentials.
  3. On the Secrets tab, do the following for each client secret you want to add:
    1. On the tab toolbar, click Add Shared Secret. The Add Shared Secret dialog box opens.
    2. In the Description box, type the description of the shared secret.
    3. Optional: In the Expires On (UTC) box, enter the date and time on which the secret expires.
    4. Copy and save the value that is displayed in the Value box. The client application should use this client secret for authentication in MYOB Advanced.
      Important: For security reasons, the value of the secret is displayed only once: when you create the secret by invoking this dialog box.
    5. Click OK to save the secret and close the dialog box.
  4. On the form toolbar, click Save. Notice that the client ID has been generated in the Client ID box. The client application should use this client ID along with the client secret for authentication in MYOB Advanced.

To Register a Client Application with the Hybrid Flow

  1. In the Client Name box, type the name of the registered application.
    Note: Leave the Client ID box blank. The system will fill it in when you save your changes on the form.
  2. In the Flow box, select Hybrid.
  3. Optionally, in the Plug-In box, select the plug-in that contains custom claims.
  4. On the Secrets tab, do the following for each client secret you want to add:
    1. On the tab toolbar, click Add Shared Secret. The Add Shared Secret dialog box opens.
    2. In the Description box, type the description of the shared secret.
    3. Optional: In the Expires On (UTC) box, enter the date and time on which the secret expires.
    4. Copy and save the value that is displayed in the Value box. The client application should use this client secret for authentication in MYOB Advanced.
      Important: For security reasons, the value of the secret is displayed only once: when you create the secret by invoking this dialog box.
    5. Click OK to save the secret and close the dialog box.
  5. On the Redirect URIs tab, do the following for each redirect URI you want to add:
    1. On the tab toolbar, click Add Row.
    2. In the Redirect URI column of the new row, type the exact redirect URI to which MYOB Advanced should redirect the client application after the client application has been authorized. The redirect URI must be absolute and must not have the fragment part (the part preceded with #).
  6. For the OIDC client application, on the Claims tab, in the Active column, select the claims that will be included in the ID token.
  7. On the form toolbar, click Save. Notice that the client ID has been generated in the Client ID box. The client application should use this client ID along with the client secret for authentication in MYOB Advanced.