List the roles you may give
Answers the roles you may give somebody in your own company. data is a list with one item: an object whose keys are role slugs and whose values are role names. For each role's permissions, use GET /team/roles.
GET/ api/ roles
Returns
200 The roles you may give, slug to name.
Fields of the 200 answer
dataarray of objects or arraysRequired
One item, an object of role slug to role name. Empty when you may give no role. Up to 1 items.
messagestringRequired
statusstringRequired
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/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/roles');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/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/roles",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"data": [
{
"client-member-full": "Member (Full Access)",
"client-member-limited": "Member (Limited Access)",
"client-owner": "Owner",
"release-managers-0b9c7a52-3f7e-4c1d-9a55-2f6f1f0e8d11": "Release managers"
}
],
"message": "all roles allowed loaded successfully",
"status": "success"
}{
"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?