POST /api/roles
Create a role

Examples

PUT /api/roles
{
  "role": {
    "name": "newrole"
  }
}
403
{
  "error": {
    "message": "Access denied",
    "details": "Missing one of the required permissions: create_roles",
    "missing_permissions": [
      "create_roles"
    ]
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
role
required

Validations:

  • Must be a Hash
role[name]
required

Validations:

  • Must be a String
role[description]
optional , nil allowed

Role description

Validations:

  • Must be a String
role[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
role[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type