Skip to main content

core_groups_retrieve

GET 
/api/v3//core/groups/:group_uuid/

Group Viewset

Request​

Path Parameters

    group_uuid uuidrequired

    A UUID string identifying this Group.

Query Parameters

    include_users boolean
    Default value: true

Responses​

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

  • ]

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/core/groups/:group_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired
— query