---
title: "Config a user role"
method: PATCH
path: "/user_role/{name}"
tags: ["User"]
---

# Config a user role

`PATCH /user_role/{name}`

## Request

- Base URL: `/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/user_role/{name}`
- Auth: none declared. Required headers: `X-Auth-Token`
- TypeScript: <https://skmtc.dev/neuvector/apis/neuvector-api/docs/user_role/:name/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `name` string, required

## Headers

- `X-Auth-Token` string, required

## Request body

- RESTUserRoleConfigData
  - `config` RESTUserRoleConfig, required
    - `name` string, required
    - `comment` string, required
    - `permissions` RESTRolePermission[], required
      - `id` string, required
      - `read` boolean, required
      - `write` boolean, required

## Response `200`

Success

---

[API](https://skmtc.dev/neuvector/apis/neuvector-api.md) - [All operations](https://skmtc.dev/neuvector/apis/neuvector-api/llms.txt) - [OpenAPI document](https://skmtc.dev/neuvector/apis/neuvector-api/revisions/b8d8d28840b3?raw)