curl -X GET 'https://api.example.com/roles?ids=role_1,role_2,role_3' \
-H 'Authorization: Bearer YOUR_TOKEN'
const axios = require('axios');
const { data } = await axios.get('https://api.example.com/roles', {
params: { ids: 'role_1,role_2,role_3' },
headers: { 'Authorization': 'Bearer YOUR_TOKEN' },
});
[
{
"id": "role_1",
"name": "Admin",
"description": "Full administrative access",
"scopeId": "scope_123"
},
{
"id": "role_2",
"name": "Editor",
"description": "Can edit content",
"scopeId": "scope_123"
}
]
Roles
Get Roles
Retrieve roles by their IDs
GET
/
roles
curl -X GET 'https://api.example.com/roles?ids=role_1,role_2,role_3' \
-H 'Authorization: Bearer YOUR_TOKEN'
const axios = require('axios');
const { data } = await axios.get('https://api.example.com/roles', {
params: { ids: 'role_1,role_2,role_3' },
headers: { 'Authorization': 'Bearer YOUR_TOKEN' },
});
[
{
"id": "role_1",
"name": "Admin",
"description": "Full administrative access",
"scopeId": "scope_123"
},
{
"id": "role_2",
"name": "Editor",
"description": "Can edit content",
"scopeId": "scope_123"
}
]
Query Parameters
string
Comma-separated list of role IDs to retrieve
Response
Returns an array of role objects.array
curl -X GET 'https://api.example.com/roles?ids=role_1,role_2,role_3' \
-H 'Authorization: Bearer YOUR_TOKEN'
const axios = require('axios');
const { data } = await axios.get('https://api.example.com/roles', {
params: { ids: 'role_1,role_2,role_3' },
headers: { 'Authorization': 'Bearer YOUR_TOKEN' },
});
[
{
"id": "role_1",
"name": "Admin",
"description": "Full administrative access",
"scopeId": "scope_123"
},
{
"id": "role_2",
"name": "Editor",
"description": "Can edit content",
"scopeId": "scope_123"
}
]
Was this page helpful?
⌘I