System Developers FAQs
Does a cloud solution include the SMS? The SMS is the only cloud based software we use.
Yes, it does if you are using a cloud-based Student Management System (SMS) and have shared your Machine-to-Machine credentials with your SMS provider to enable you to use that software.
The My Cloud software service allows education or training providers to:
- notify the government of their cloud-based software provider
- securely transact with the USI Registry System without the need for their own Machine-to-Machine credentials.
What is the USI Developer Kit (DK)?
The USI Developer Kit is provided by the Office of the Student Identifiers Registrar and contains everything that is needed to connect to USI web services, including:
- test environment credentials and org codes
- checksum algorithm
- technical service contract.
You can request a copy of the latest version of the developer kit here.
What is the Technical Service Contract (TSC)?
The TSC is a set of codes that can be consumed by the organisation's Student Management System to use the USI Registry System web services component.
What is a machine credential?
Machine-to-Machine (M2M) credentials are used for system to system web services and installed on the server hosting an education or training provider’s system. M2M credentials identify a business rather than a person. Users of a USI web service enabled Student Management System (SMS) do not need their own individual credential.
M2M credentials are used in third party testing (3PT) and production environments.
The Office of the Student Identifiers Registrar provides credentials for third party testing.
Production credentials are created by the authorised person in the education or training provider through the ATO RAM system. Information on how to create and install machine credentials can be found on the ATO website.
What can I do if my machine credentials are expiring?
Machine credentials expire 2 years from the date of creation. You have two options before the expiry date:
- you can incorporate a machine credential renewal function in your software via a new machine authentication service certificate manager (MAS CM). The information to integrate the renewal feature in your software can be found on the ATO website here.
- If you choose not to implement the renewal function, you and/or your clients will need to create new machine credentials in Relationship Authorisation Manager (RAM) prior to the expiry. If you create a new credential with exactly the same name, you will not be required to update any permissions in ATO Access Manager.
For further help please contact the ATO at DPO@ato.gov.au
What are the end point URL’s for the USI system?
Section 4.2.2 of the USI Technical Services Contract (TSC) identifies the complete range of production URLs.
What is the 3PT machine credential password?
The machine credential case sensitive password for 3PT is: Password1!
Related Links
Where can I get test data?
The ‘Generic USI Test Data 2022’ document within the Developers Kit contains USI test data, including dummy accounts that you can utilise for testing. If you wish to create your own USI test accounts, the kit also contains mock DVS data you can use in the test environment.
Why am I receiving error 3458?
This error code will appear when you attempt to connect using an outdated version of Web Services. If you are a:
System Developer – Please fill out the Software Developer Kit Request Form to request the latest version of the Developer Kit which you will need to upgrade.
Education or Training Providers – Please have your Student Management System developer upgrade their software to Web Services Version 5. In the meantime, organisations can still log in to our Organisation Portal while their software is being upgraded.
Where can I get more support and information?
Additional support and information for system developers can be found here.
If you are still unable to find the information you are looking for, email IT@usi.gov.au for additional support.