Skip to main content
GET
/
api
/
v1
/
accounts
/
{accountId}
/
roles
/
{roleId}
Get a specific role
curl --request GET \
  --url https://api.aion.xyz/api/v1/accounts/{accountId}/roles/{roleId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "account_admin",
  "name": "account_admin",
  "scope": "ACCOUNT",
  "status": "ACTIVE",
  "isCustom": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "accountId": "my-company-account",
  "projectId": "project-alpha",
  "description": "Full administrative access to the account",
  "createdBy": "admin.user"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication

Path Parameters

​
accountId
string
required

The account identifier (external account ID)

Example:

"my-company-account"

​
roleId
string
required

The role identifier (external role ID)

Example:

"account_admin"

Response

Successfully retrieved role

​
id
string
required

Role identifier (external_id from database)

Maximum string length: 50
Example:

"account_admin"

​
name
string
required

Role name

Example:

"account_admin"

​
scope
enum<string>
required

The scope of the role:

  • ACCOUNT: Role applies at the account level (e.g., account_admin)
  • PROJECT: Role applies at the project level (e.g., project_admin, project_reader)
  • RESOURCE: Role applies to specific resources
Available options:
ACCOUNT,
PROJECT,
RESOURCE
​
status
enum<string>
required

The status of the role

Available options:
ACTIVE,
INACTIVE
​
isCustom
boolean
required

Whether this is a custom role (false for system roles like account_admin, project_admin, project_reader)

​
createdAt
string<date-time>
required

Timestamp when the role was created

​
updatedAt
string<date-time>
required

Timestamp when the role was last updated

​
accountId
string

Account identifier (external account ID, null for system roles)

Example:

"my-company-account"

​
projectId
string

Project identifier (external project ID, for project-scoped custom roles)

Example:

"project-alpha"

​
description
string

Role description

Maximum string length: 500
Example:

"Full administrative access to the account"

​
createdBy
string

Creator identifier (external user ID)

Example:

"admin.user"