---
title: "Role"
method: PUT
path: "/api/3/roles/{id}"
tags: ["User"]
---

# Role

`PUT /api/3/roles/{id}`

Updates the details of a role.

## Path parameters

- `id` RoleNaturalID, required
  - `id` object

## Request body

- Role — The details of the role.
  - `description` LocalizedMessage, required — The description of the role.
    - `arguments` object[]
    - `defaultValue` string
    - `key` string
  - `id` string, required — The identifier of the role.
  - `links` Link[], required — Hypermedia links to corresponding or related resources.
    - `deprecation` string
    - `href` string — A hypertext reference, which is either a URI (see <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>) or URI template (see <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc6570">RFC 6570</a>).
    - `hreflang` string
    - `media` string
    - `rel` string — The link relation type. This value is one from the <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc5988#section-6.2">Link Relation Type Registry</a> or is the type of resource being linked to.
    - `title` string
    - `type` string
  - `name` LocalizedMessage, required — The description of the role.
    - `arguments` object[]
    - `defaultValue` string
    - `key` string
  - `privileges` string[] — The privileges granted to the role.

## Response `200`

OK

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/rapid7/apis/rapid7-vm-api.md) · [All operations](https://skmtc.net/rapid7/apis/rapid7-vm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapid7/rapid7-vm-api/versions/3a8197c22d71/schema)