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

# Update Tenant User Group

> Rename a user group of the caller's tenant or change its description. Fields left out keep their value. Its permissions and members are unaffected.

#### Authentication

❌ Organization User (`CustomerEmployee`)\
❌ Delegated User (`EndUser`)\
❌ Service Account

#### Required Permissions

`Tenant:UserGroups:Update`: Always required.


## OpenAPI

````yaml /openapi.yaml put /tenant/user-groups/{userGroupId}
openapi: 3.1.0
info:
  version: 2.0.249
  title: Dfns
servers:
  - url: https://api.dfns.io
    description: Default - Europe
  - url: https://api.uae.dfns.io
    description: UAE
  - url: https://api.dfns.ninja
    description: <Deprecated> Staging
security: []
paths:
  /tenant/user-groups/{userGroupId}:
    put:
      tags:
        - Tenant
      summary: Update Tenant User Group
      description: >-
        Rename a user group of the caller's tenant or change its description.
        Fields left out keep their value. Its permissions and members are
        unaffected.
      operationId: updateTenantUserGroup
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 64
            pattern: ^ug-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
            description: User group id.
          required: true
          description: User group id.
          name: userGroupId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 128
                  pattern: ^[A-Za-z0-9_+.-]+$
                  description: >-
                    Name of the group. Unique within the org or tenant, ignoring
                    case. A deleted group frees its name for reuse.
                description:
                  type:
                    - string
                    - 'null'
                  minLength: 1
                  maxLength: 1024
                  description: Description of the group. Null removes it.
              additionalProperties: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
      security:
        - authenticationToken: []
          userActionSignature: []
components:
  schemas:
    UserGroup:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 64
          pattern: ^ug-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
          description: User group id.
          example: ug-139tf-f58l8-lsbt6dp47lfsdvgh
        orgId:
          type: string
          minLength: 1
          maxLength: 64
          pattern: ^or-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
          description: Organization id.
          example: or-30tnh-itmjs-s235s5ontr3r23h2
        tenantId:
          type: string
          minLength: 1
          maxLength: 64
          pattern: ^acct-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
          description: Tenant id.
          example: acct-24hka-dhili-9hgvdlvr1ohpibp4
        name:
          type: string
          description: Name of the group.
        description:
          type: string
          description: Description of the group.
        memberCount:
          type: integer
          minimum: 0
          description: Number of members.
        dateCreated:
          type: string
          format: date-time
          description: >-
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be
            UTC). Date the group was created.
          example: '2023-04-14T20:41:28.715Z'
        dateUpdated:
          type: string
          format: date-time
          description: >-
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be
            UTC). Date the group was last updated.
          example: '2023-04-14T20:41:28.715Z'
      required:
        - id
        - name
        - memberCount
        - dateCreated
        - dateUpdated
  securitySchemes:
    authenticationToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        **Bearer Token:** Used to authenticate API requests.

        More details how to generate the token: [Authentication
        flows](https://docs.dfns.co/api-reference/auth/login-flows)
    userActionSignature:
      type: apiKey
      in: header
      name: X-DFNS-USERACTION
      description: >-
        **User Action Signature:** Used to sign the change-inducing API
        requests.

        More details how to generate the token: [User Action Signing
        flows](https://docs.dfns.co/api-reference/auth/signing-flows)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.