Create API key

To use the ARDC RAiD Service API, you must first create an API key. API keys can be created in the RAiD User Interface, but for a more robust integration we recommend that you implement a full OpenID Connect authorisation flow.

If you wish to integrate RAiD into your software or platform, please get in touch.

Applicability

This procedure applies to the ARDC RAiD Service User Interface.

Prerequisites

In order to do this, you will need to be an authorised Operator, Service Point Admin, or Service Point User of at least one ARDC RAiD Service Point.

Process

1. Log in to the RAiD User Interface.

2. Open the hamburger menu using the icon on the top right and select Create API key.

3. You will be presented with an API key that you can copy to clipboard.

4. Access the RAiD API using this token.

A RAiD API key/refresh token has the same privileges as the user that created it.

An API key is valid for 5 minutes in Production and 24 hours in Demo. You will need to use the API before this expiry to get a refresh token.