CAcardda
Company role

Create a company role

Creates a new custom role for the company with an optional set of permissions (passed as an array of permission ids).

post/v1/companies/{company_id}/company_roles

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/companies/{company_id}/company_roles
  • Auth
    HTTP bearer

Path parameters

company_idstring uuid required

The UUID of the company the nested resource belongs to.

Parameters

#/paths/~1v1~1users/get/parameters/0 (unresolved $ref)

Request body

namestring required
descriptionstring
permissionsstring[]

Ids of the permissions to grant to the role.

Example request

{
  "name": "Finance"
}

Response

The created company role.

idstring uuid required
company_idstring uuid required
namestring required
descriptionstring nullable
created_atstring date-time
updated_atstring date-time

Example response

{
  "name": "Finance",
  "permissions": [
    {
      "name": "cards_view"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.