core_groups_update

PUT 
/api/v3//core/groups/:group_uuid/

Group Viewset

Request

Path Parameters

group_uuid uuidrequired

A UUID string identifying this Group.

application/json

Body

required

name stringrequired

Possible values: non-empty and <= 80 characters

is_superuser boolean

Users added to this group will be superusers.

parent uuidnullable
users integer[]

attributes

object
roles uuid[]

Responses

200

application/json

Schema

Schema

pk uuidrequired
num_pk integerrequired
name stringrequired

Possible values: <= 80 characters

is_superuser boolean

Users added to this group will be superusers.

parent uuidnullable
parent_name stringnullablerequired
users integer[]

users_obj

object[]

nullable

required

Array [

pk ID (integer)required

username stringrequired

Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

name stringrequired

User's display name.

is_active Active (boolean)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

last_login date-timenullable

email email

Possible values: <= 254 characters

attributes

object

uid stringrequired

]

attributes

object
roles uuid[]

roles_obj

object[]

required

Array [

pk uuidrequired

name stringrequired

Possible values: <= 150 characters

]

Example (from schema)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "num_pk": 0,
  "name": "string",
  "is_superuser": true,
  "parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "parent_name": "string",
  "users": [
    0
  ],
  "users_obj": [
    {
      "pk": 0,
      "username": "string",
      "name": "string",
      "is_active": true,
      "last_login": "2024-09-27T14:26:18.074Z",
      "email": "[email protected]",
      "attributes": {},
      "uid": "string"
    }
  ],
  "attributes": {},
  "roles": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "roles_obj": [
    {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    }
  ]
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT '/api/v3/core/groups/:group_uuid/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "is_superuser": true,
  "parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "users": [
    0
  ],
  "attributes": {},
  "roles": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

group_uuid — pathrequired

Body required

{
  "name": "string",
  "is_superuser": true,
  "parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "users": [
    0
  ],
  "attributes": {},
  "roles": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}