The ARDC RAiD service offers a robust member API for machine-to-machine operations to list, mint, and updated RAiDs that belong to you and your organisation. This is distinct to the RAiD federation API, which allows anybody to search and retrieve RAiDs across all RAiD services, not just the ARDC RAiD Service.
The API can be explored using a Swagger interface.
Authenticating to the API
There are two ways to authenticate to the RAiD member API, depending on what you're doing.
API tokens represent you, the signed-in user, and carry your own permissions. Use one for manual testing or one-off scripts where a person logs in. Create an API token via the RAiD User Interface. It's short-lived (5 minutes in Production, 24 hours in Demo) and expires with your session — there's no separate revoke step.
Client credentials represent your service point rather than an individual person. Use them for unattended integrations — a script, pipeline, or system that calls the RAiD member API without anyone logging in. A Service Point Admin can create client credentials for their own service point, and list, rotate, or revoke them at any time.
|
|
API token |
Client credentials |
|---|---|---|
|
Represents |
You, the signed-in user |
Your service point |
|
Created via |
RAiD User Interface (hamburger menu) |
RAiD User Interface (Service Point page) |
|
Typical use |
Manual testing, one-off scripts |
Unattended integrations, scheduled jobs |
|
Lifetime |
Expires with your session (no revoke) |
Active until rotated or revoked |
If you are interested in integrating RAiD into your software, please contact ARDC Services.