PUT /api/roles/:id
Update a role

Examples

PUT /api/roles/18
{
  "role": {
    "location_ids": [
      255093256
    ],
    "organization_ids": [
      447626438
    ]
  }
}
200
{
  "builtin": 0,
  "cloned_from_id": null,
  "name": "New Role",
  "id": 18,
  "description": null,
  "origin": null,
  "filters": [
    {
      "id": 1062414301
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

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
id
required

Validations:

  • Must be a String
role
required

Validations:

  • Must be a Hash
role[name]
optional

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