core_groups_partial_update

PATCH 
/api/v3//core/groups/:group_uuid/

Group Viewset

Request

Path Parameters

group_uuid uuidrequired

A UUID string identifying this Group.

application/json

Body

namestring
Possible values: non-empty
is_superuserboolean
Users added to this group will be superusers.
parentuuidnullable
usersinteger[]
attributes object
property name*any
rolesuuid[]

Responses

200

application/json

Schema

Schema

pkuuidrequired
num_pkintegerrequired
namestringrequired
is_superuserboolean
Users added to this group will be superusers.
parentuuidnullable
parent_namestringnullablerequired
usersinteger[]
users_obj object[]nullablerequired
Array [
pkID (integer)required
usernamestringrequired
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$
namestringrequired
User's display name.
is_activeActive (boolean)
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_logindate-timenullable
emailemail
Possible values: <= 254 characters
attributes object
property name*any
uidstringrequired
]
attributes object
property name*any
rolesuuid[]
roles_obj object[]required
Array [
pkuuidrequired
namestringrequired
Possible values: <= 150 characters
]

Example (auto)

{
  "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-07-29T15:51:28.071Z",
      "email": "user@example.com",
      "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_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

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

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

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

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/core/groups/:group_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"is_superuser\": true,\n  \"parent\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"users\": [\n    0\n  ],\n  \"attributes\": {},\n  \"roles\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ]\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

group_uuid — pathrequired

Body

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