> ## Documentation Index
> Fetch the complete documentation index at: https://docs.groundforge.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Role



## OpenAPI

````yaml /openapi/groundforge-openapi-v1.json put /v1/roles/{role_id}
openapi: 3.1.0
info:
  title: GroundForge REST API
  version: 86Y.5p.6v.6aq
  description: >-
    Current GroundForge SaaS administration, Agent, Channel, MCP, governance,
    observability, and LangChain integration endpoints.
servers:
  - url: https://platform.groundforge.ai
    description: GroundForge SaaS
security: []
paths:
  /v1/roles/{role_id}:
    put:
      summary: Update Role
      operationId: update_role_v1_roles__role_id__put
      parameters:
        - name: role_id
          in: path
          required: true
          schema:
            type: string
            title: Role Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoleRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    UpdateRoleRequest:
      properties:
        displayName:
          anyOf:
            - type: string
            - type: 'null'
          title: Displayname
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        assignableTo:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Assignableto
        appliesTo:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Appliesto
        permissions:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Permissions
        status:
          anyOf:
            - $ref: '#/components/schemas/RoleStatus'
            - type: 'null'
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
      type: object
      title: UpdateRoleRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RoleStatus:
      type: string
      enum:
        - active
        - disabled
        - archived
      title: RoleStatus
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OIDC access token for users and CLI clients.
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Scoped service-account API key for external Agents and runtime clients.

````

## Related topics

- [Get Role](/api-reference/endpoints/get-role.md)
- [Delete Role](/api-reference/endpoints/delete-role.md)
- [List Roles](/api-reference/endpoints/list-roles.md)
- [Search Roles](/api-reference/endpoints/search-roles.md)