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>'
import requests

url = "https://api.aion.xyz/api/v1/accounts/{accountId}/roles/{roleId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aion.xyz/api/v1/accounts/{accountId}/roles/{roleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aion.xyz/api/v1/accounts/{accountId}/roles/{roleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.aion.xyz/api/v1/accounts/{accountId}/roles/{roleId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.aion.xyz/api/v1/accounts/{accountId}/roles/{roleId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.aion.xyz/api/v1/accounts/{accountId}/roles/{roleId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "account_admin",
  "name": "account_admin",
  "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"
}
{
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request parameters",
"details": [
"accountId must be a valid identifier"
]
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required"
}
}
{
"error": {
"code": "FORBIDDEN",
"message": "Insufficient permissions to access this resource"
}
}
{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}

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"