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

# Set Functional Rights

> Set all functional rights for the given role.

Functional rights not specified here will be removed from the role. 
<para />## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps.



## OpenAPI

````yaml /openapi/rest/openapi-v3-Role.json put /api/v1/Role/{roleId}/FunctionRight
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - Role
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Role/{roleId}/FunctionRight:
    put:
      tags:
        - Role
      summary: Set Functional Rights
      description: "Set all functional rights for the given role.\n\nFunctional rights not specified here will be removed from the role. \r\n<para />## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps."
      operationId: v1RoleEntity_SetFunctionalRights
      parameters:
        - name: roleId
          in: path
          description: The role id to set the functional rights for
          required: true
          schema:
            type: integer
            format: int32
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
                format: int32
          text/json:
            schema:
              type: array
              items:
                type: integer
                format: int32
          application/xml:
            schema:
              type: array
              items:
                type: integer
                format: int32
          text/xml:
            schema:
              type: array
              items:
                type: integer
                format: int32
          application/x-www-form-urlencoded:
            schema:
              type: array
              items:
                type: integer
                format: int32
          application/json-patch+json:
            schema:
              type: array
              items:
                type: integer
                format: int32
          application/merge-patch+json:
            schema:
              type: array
              items:
                type: integer
                format: int32
        description: >-
          An array of functional rights ids to set for this role. Rights not
          included here are removed from the role.
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components: {}

````

## Related topics

- [Set Functional Rights](/en/api/reference/restful/agent/user_agent/set-functional-rights.md)
- [SuperOffice.WebApi.Data.User SetFunctionalRightsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_SetFunctionalRightsRequest.md)
- [NSUserAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSUserAgent.md)
- [SuperOffice.WebApi.Agents.IUserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IUserAgent.md)
- [SuperOffice.WebApi.Agents.UserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.UserAgent.md)
- [Get Functional Rights](/en/api/reference/restful/rest/role/get-functional-rights.md)
