Guide: how to install a machine credential

A machine credential allows an entity to interact directly with government online services through SBR-enabled business software.

This guide provides step-by-step instructions on how to create a new machine credential for an entity in Relationship Authorisation Manager (RAM).

Who should use this guide

To create a machine credential in RAM, you must be either a principal authority or a machine credential administrator (MCA).

Principal Authority

A principal authority is a person responsible for a business, either:

a sole trader
an eligible associate listed against the Australian business number (ABN) in the Australian Business Register (ABR)
a primary person (where no individual associates are listed in the ABR) such as a corporate trustee, authorised contact for a government agency or responsible person for an Australian charity.

The principal authority is responsible for the initial set-up of the entity in RAM. A principal authority can complete all activities in this guide.

Machine credential administrator (as assigned by a principal authority or authorisation administrator)

A representative with an MCA role can create machine credentials on behalf of the entity.

To authorise an MCA, create a new authorisation in RAM and select Yes when asked whether you want the user to be an MCA. To make an existing user an MCA, edit their authorisation in RAM.

Before you start

Before you create a machine credential you will need to download and install a browser extension compatible with your device’s operating system. These extensions are for Firefox- and Chrome-based web browsers on the following operating systems:

Detailed instructions on installing the compatible browser extension can be found in the Installing a browser extension section.

How to install a machine credential

Using Chrome or Firefox, go to authorisationmanager.gov.au Select the myGovID login button.

Step 1 – log_in_to_ram.png

step_1_-_login_to_ram.png

Screenshot showing the login screen of the Relationship authorisation manager website. A red box highlights the myGovID login button on the right hand side of the screen.

A code will appear. Open myGovID on your smart device, log in and enter the 4 digit code into the pop-up within the app. Tap Accept.

Step 2 – log_in_with_mygovid code.png

step_2_-_login_with_mygovid_code.png

Screenshot showing an example 4 digit code generated by the myGovID website.

Click View or manage authorisations, machine credentials and cloud software notifications. You will be directed to a view of all the entities you can act for.

Step 3 – ram_home_screen.png

step_3_-_ram_home_screen.png

Screenshot showing the page where manage authorisations can be selected.

Select the entity you would like to create a machine credential for.

Step 4 – select_your_business.png

step_4_-_select_your_business.png

Screen showing an example of where you can select the entities you can act on behalf of.

The entity homepage will be displayed with a list of all the authorisations for the entity. Click the Manage Credentials tab in the toolbar.

Step 5 – select_manage_credentials.png

step_5_-_select_manage_credentials.png

Screen showing a list of all authorisations for the entity.

The Manage credentials page is displayed.

If you’ve already installed the required browser extension, go to the next step.

If you have not yet installed the required browser extension, a message advising that browser extension software is required will appear.

Click Machine credential downloads.

Select the browser extension link for your operating system.

Install and enable the browser extension. Refer to the Installing a browser extension section.

Close your browser, then reopen it and go to authorisationmanager.gov.au to log in again with your myGovID. Then go to the Manage credentials page.

Step 6 – manage_credentials_browser_extension.png

step_6_-_manage_credentials_browser_extension.png

Screen showing the warning message that software is required.

Step 7 – create_machine_credential.png

step_7a_-_create_machine_credential.png

Select Create machine credential and enter the following information:

Keystore path – This will be pre-filled but can be changed if required. This is where the machine credential will be created and stored.
Keystore password – Choose a password. It should include at least 10 characters with no space, an upper case letter, a lower case letter, a number and a punctuation character. You’ll provide this password within your software either when setting up or authenticating. You are not required to use your myGovID password for the ‘Keystore password’
Verify your keystore password.
Credential name – Enter a name for the machine credential. You should create a name which will help you to easily identify the machine credential.
Identify the Machine Credential Custodian – This will be pre-filled with your name and cannot be changed.

When creating a machine credential, you can store it in:

an existing keystore by using the initial keystore path and password
a new keystore by changing the keystore path and password.
a new keystore each time you create one. You will need to change the keystore path each time you create a new machine credential to do this.

Tick the box to confirm you understand and accept the machine credential details.

Click Download.

Step 8 – confirm_and_download.png

step_8_-_confirm_and_download.png

Screen showing fields for the Keystore path, Keystore password and Credential name.

The Credential Installed notification will display when installation is successful.

Click Finish to return to the Manage credentials page.

Step 9 – credential_installed_notification.png

step_9_-_credential_installed_notification.png

Screen showing the message that a machine credential has been installed successfully.

From the Manage credentials page you can create, view, revoke and claim unassigned machine credentials for the entity.

Step 10 – manage_credentials_page.png

step_10_-_manage_credentials_page.png

Screen of 'manage credentials' page showing the newly created machine credential.

Installing a browser extension

To create a machine credential, you will need to download and install a browser enabler/extension that is compatible with your device’s operating system. Choose from the following:

Windows
MAC OS
Linux

Download and install a browser extension for Windows

Use the link: info.authorisationmanager.gov.au/sites/default/files/atobeinstaller_exe.zip and save the file. Go to your Downloads folder and run ‘ATOBEInstaller.exe’.

Step 1 – download_installer_windows.png

step_0_-_download_installer_windows.png

The ATOBE Installer will open. Click I Agree to progress.

Step 2 – agree_to_license_agreement.png

step_1_-_agree_to_license_agreement.png

Screen showing the myGovID licence agreement.

If the following message appears, close any open browsers and click Retry.

Step 3 – retry_error.png

step_2_-_retry_error.png

$Error opening file for writing: C:\Users\User\AppData\Local\ATOBE\atoakmbex.exe. Click Abort to stop the installation, Retry to try again, or Ignore to skip this file.$

Click Close to finalise installation.

Step 4 – finalise_installation.png

step_3_-_finalise_installation.png

Screen showing that the browser extension installation is complete.

You have now successfully installed the browser extension onto your computer.

Click OK. Restart any open browsers or log off and log on again.

Step 5 – successful_installation_notification.png

step_4_-_successful_installation_notification.png

Screen showing success message. You have successfully installed ATOBE 1.0.1. Before using, please restart any open browsers or logoff and on again.

Download and install a browser extension for MAC OS

Use the link: info.authorisationmanager.gov.au/sites/default/files/atobeinstaller_pkg.zip and save the file. Go to your Downloads folder and run ‘ATOBEInstaller.pkg’.

Step 1 – download_installer.png

step_0_-_download_installer.png

Screen showing the ATOBEInstaller.pkg package.

The ATOBE Installer will be made available in the ‘Downloads’ folder. Click on Download to activate.

Step 2 – download_atobe.png

step_1_-_download_atobe.png

Screen showing downloads folder where package will be found after downloading.

The ATOBE Installer will open. Click Continue.

Step 3 – atobe_introduction.png

step_2_-_atobe_introduction.png

Screen showing the introduction of the ATOBE installer process.

The license information will be displayed. Click Continue then Agree to progress.

Step 4 – agree_to_license_agreement.png

step_3_-_agree_to_license_agreement.png

Screen showing the ATOBE licence agreement information.

The destination is automatically selected. Click Install and you will be prompted to enter your computer password to allow installation. Then click Install Software.

Note: You can change the install location if required before clicking Install.

Step 5 – install_and_enter_password.png

step_4_-_install_and_enter_password.png

Screen showing that the user will be prompted to provide user details and password to continue installation.

To finalise installation all applications must be closed. Click Continue Installation. You will be logged out when complete.

Step 6 – finalise_installation.png

step_5_-_finalise_installation.png

Screen showing that to finalise installation, applications will be closed and you will be logged out.

You have now successfully installed the browser extension onto your computer.

Step 7 – successful_installation.png

step_6_-_successful_installation.png

Screen showing that the software installation was sucessful.

You can move the ATOBE Installer to the trash as required and delete.

Step 8 – move_to_trash.png

step_7_-_move_to_trash.png

Screen showing that you can move the ATOBE Installer to the trash as required and delete.

Once the ATOBE has been added you will be prompted to Enable Extension in order for the browser enabler to work.

Step 9 – enable_extension.png

step_8_-_enable_extension.png

Screen showing prompt to enable the extension as part of your browser.

Download and install a browser extension for Linux

Use link: https://info.authorisationmanager.gov.au/sites/default/files/atobeinstaller_nix_sh.zip and click on ‘ATOBEInstaller-nix.sh’.

Step 1 – downloads.png

step_0_-_downloads.png

Ensure that all browser sessions are closed.

Open a terminal window at the download location and run ‘Bash ./ATOBEInstaller-nix.sh’.

Step 2 – bash.png

step_1_-_bash.png

The console output will appear.

Step 3 – console_output.png

step_2_-_console_output.png

The installer checks to see that the dependent library libjansson is present. If it is not, please install it from the relevant repository.

Step 4 – libjansson_library.png

step_3_-_libjansson_library.png

The installed executable is run. Errors will be produced if there are any other dependent libraries missing. Check and install any other missing dependencies.

You have now successfully installed the browser extension onto your computer.