Guide: how to install a machine credential

A machine credential allows you to transact directly with government online services through SBR-enabled business software.

This guide provides step-by-step instructions for principal authorities and machine credential administrators (as authorised by a principal authority or authorisation administrator) on how to create a new machine credential in Relationship Authorisation Manager (RAM).

When creating a new machine credential to prevent expiry of an existing one, use the same credential name.

Before you start

Before you create a machine credential, you 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:

For detailed instructions see the Installing a browser extension section.

How to install a machine credential

Step 1

Using Chrome or Firefox, go to info.authorisationmanager.gov.au and log in to RAM using your Digital ID, such as myID.

You can select the Continue with Digital ID button or the Login button in the top right-hand corner.

Step 2

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.

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

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

Step 3

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

Screen showing a list of all authorisations for the entity.

Step 4

The Manage credentials page is displayed.

Screen showing the notification that software is required.

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

If you have not yet installed the required browser extension, you'll receive a message that browser extension software is required.

Click Machine credential downloads or see the Installing a browser extension section.

Select, install and enable the browser extension link for your operating system.

Close your browser, then reopen it and follow Steps 1-6.

Step 5

Select Create machine credential.

Screen of Create a machine credential page with create a machine credential button in the top right hand corner.

Step 6

Enter the following information:

Keystore path – this is where the machine credential will be created and stored, the information will be pre-filled but can be changed if required.
Keystore password – choose a password that is at least 10 characters (with no space) including an upper case letter, a lower case letter, a number and a special character. You’ll provide this password within your software either when setting up or authenticating. You should not use your myID password for the ‘Keystore password’.
Verify your keystore password – re-enter your chosen password.
Credential name – create a name that will help you to easily identify the machine credential. If you’re creating a new machine credential to prevent expiry of an existing one, use the same credential name.
Identify the machine credential custodian – this will be pre-filled with your name and cannot be changed.

If you’re creating a new machine credential to prevent expiry of an existing one, a message will display confirming the new credential will share the same permissions. You’ll need to revoke the existing machine credential if it hasn’t expired yet.

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.

The machine credential keystore is generated in Extensible Markup Language (XML). If your software requires the keystore to be stored in an alternative format, you’ll need to follow the guidance provided by your digital service provider to convert and install the keystore.

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

Click Download.

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

Step 7

Once downloaded you will receive a message confirming that the machine credential has been installed.

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

Step 8

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

Screen showing the newly created machine credential listed on the Create a machine credential page.

Installing a browser extension

To create a machine credential, you will need to download and install a browser enabler/extension that is compatible with one of the following operating systems:

Windows
MAC OS
Linux