CorefinityCorefinityDocs
Open the Control PanelControl Panel
Team · 6 of 17

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.

POST/api/roles/attach

Body

rolestringRequired

The slug of the role.

user_idinteger or stringRequired

The id of the team member.

Returns

200 The member with their roles as they are now.

Fields of the 200 answer
dataobjectRequired

A person with a Control Panel account. Ids are sent as strings.

Fields
companyobject or any or null

The user's company, as GET /companies answers it. Null when the account belongs to no company.

company_idstringRequired

The id of the user's company, as a string of digits. An empty string when the account belongs to no company.

emailstringRequired

The address the person is shown with. For somebody invited who has not accepted, the address they were invited at.

idstringRequired

The user's id, as a string of digits.

mobilestring or nullRequired
namestringRequired
rolearray of objectsRequired

The person's roles.

Fields of each item
namestringRequired
permissionsarray of stringsRequired

The keys of the permissions the role grants, such as viewWebsites.

slugstringRequired
messagestringRequired
statusstringRequired

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403forbiddenThe person is not allowed to do this.
403owner_grantOnly an owner or Corefinity staff can make someone an owner. Ask an owner.
403permission_grantYou can give someone a role only if you hold all of its permissions yourself. Ask someone who holds them.
403privileged_targetThat person's account can be changed only by Corefinity. Contact support.
403scope_requiredUse a token with the scope named in scope.
422invalidFix the field named in field; errors says why.
429rate_limitedWait 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
  }'
{
  "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"
}
Try it

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.

Was this helpful?
Open in ClaudeOpen in ChatGPT