---
title: "Put Roles"
method: PUT
path: "/api/configs/role"
tags: ["Config API"]
---

# Put Roles

`PUT /api/configs/role`

## Request

- The document declares no server URL.
- Auth: none declared

Reject role writes because role definitions are ConfigMap-owned.

## Headers

- `x-osmo-user` string, nullable

## Request body

- PutRolesRequest: Request body for updating a test with history tracking metadata.
  - `description` string, nullable
  - `tags` string[], nullable
  - `configs` RoleInput[], required
    - `name` string, required
    - `description` string, required
    - `policies` RolePolicy[], required
      - `effect` 'Allow' | 'Deny': Effect of a policy statement: Allow or Deny. Deny takes precedence over Allow.
      - `actions` string[], required
      - `resources` string[]
    - `immutable` boolean
    - `sync_mode` 'force' | 'import' | 'ignore': Sync mode for role assignments. - FORCE: Add from matching IDP claims and remove the IDP-derived assignment on the next human request without a matching claim. - IMPORT: Add from matching IDP claims and retain the assignment (default). - IGNORE: Never synchronize this role from IDP claims; manage it manually.
    - `external_roles` string[], nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

## Changes

- **2026-08-03** `b9d312a13f5d`: 2 info
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status
- **2026-04-08** `a8157dc3279d`: 4 breaking, 2 warning, 10 info
  - request property `configs/items/policies/items/effect` was restricted to a list of enum values
  - request property `configs/items/sync_mode` was restricted to a list of enum values
  - the `configs/items/policies/items/effect` request property type changed from no type to `string`
  - the `configs/items/sync_mode` request property type changed from no type to `string`
  - …12 more
- **2026-02-27** `3b4b243276b5`: 1 breaking, 3 warning, 4 info
  - the `configs/items/policies/items/actions/items/` request property type changed from `object` to `string`
  - removed the request property `configs/items/policies/items/actions/items/base`
  - removed the request property `configs/items/policies/items/actions/items/method`
  - removed the request property `configs/items/policies/items/actions/items/path`
  - …4 more

[Operation history](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/changes/api/configs/role/put.md)

---

[API](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api.md) - [All operations](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/revisions/845585a71dbb?raw)