Give a team member a role
Adds a role to a member, beside the roles they already hold. You can give only a role whose permissions you hold yourself; an owner is exempt for standard roles.
Body
The slug of the role.
The id of the team member.
Returns
200 The member with their roles as they are now.
Fields of the 200 answer
A person with a Control Panel account. Ids are sent as strings.
Fields
The user's company, as GET /companies answers it. Null when the account belongs to no company.
The id of the user's company, as a string of digits. An empty string when the account belongs to no company.
The address the person is shown with. For somebody invited who has not accepted, the address they were invited at.
The user's id, as a string of digits.
The person's roles.
Fields of each item
The keys of the permissions the role grants, such as viewWebsites.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | forbidden | The person is not allowed to do this. |
403 | owner_grant | Only an owner or Corefinity staff can make someone an owner. Ask an owner. |
403 | permission_grant | You can give someone a role only if you hold all of its permissions yourself. Ask someone who holds them. |
403 | privileged_target | That person's account can be changed only by Corefinity. Contact support. |
403 | scope_required | Use a token with the scope named in scope. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/roles/attach \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"role": "client-member-limited",
"user_id": 2042
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/roles/attach', [
'role' => 'client-member-limited',
'user_id' => 2042,
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/roles/attach', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
role: 'client-member-limited',
user_id: 2042,
}),
});
// 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.post(
"https://manage.corefinity.com/api/roles/attach",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"role": "client-member-limited",
"user_id": 2042,
},
)
data = res.json() if res.content else None{
"data": {
"company_id": "1204",
"email": "[email protected]",
"id": "2042",
"mobile": null,
"name": "Tom Harbour",
"role": [
{
"name": "Member (Full Access)",
"permissions": [
"viewWebsites",
"viewDeployments",
"viewTickets",
"createTickets"
],
"slug": "client-member-full"
},
{
"name": "Member (Limited Access)",
"permissions": [
"viewWebsites",
"viewTickets",
"createTickets"
],
"slug": "client-member-limited"
}
]
},
"message": "User attached to role.",
"status": "success"
}{
"message": "Unauthenticated."
}{
"code": "forbidden",
"message": "You are not allowed to attach roles.",
"reason": "forbidden",
"status": "error"
}{
"code": "invalid",
"errors": {
"user": [
"This user is already attached to this role."
]
},
"field": "user",
"message": "This user is already attached to this role.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.