List roles and their permissions
Answers your company's custom roles and the standard roles for your kind of company, by name, each with the permissions it gives and whether you may give it to somebody.
GET/ api/ team/ roles
Returns
200 The roles.
Fields of the 200 answer
dataobjectRequired
Fields
rolesarray of objectsRequired
Fields of each item
assignablebooleanRequired
Whether you may give this role to somebody in your company.
custombooleanRequired
True for a role your company made; false for a standard role.
idintegerRequired
At least 1.
namestringRequired
permissionsarray of stringsRequired
The slugs of the permissions the role gives.
slugstringRequired
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | scope_required | Use a token with the scope named in scope. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/team/roles \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/team/roles');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/team/roles', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/team/roles",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"data": {
"roles": [
{
"assignable": true,
"custom": false,
"id": 3012,
"name": "Member (Full Access)",
"permissions": [
"viewWebsites",
"viewDeployments",
"viewTickets",
"createTickets"
],
"slug": "client-member-full"
},
{
"assignable": true,
"custom": true,
"id": 3107,
"name": "Release managers",
"permissions": [
"viewUsers"
],
"slug": "release-managers-0b9c7a52-3f7e-4c1d-9a55-2f6f1f0e8d11"
}
]
}
}{
"message": "Unauthenticated."
}{
"code": "scope_required",
"message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
"reason": "scope_required",
"scope": "destructive"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?