Skip to main content

core_groups_retrieve

GET 

/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

    pk uuidrequired
    num_pk integerrequired
    name stringrequired
    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

    property name* any
    uid stringrequired
  • ]

  • attributes

    object

    property name* any
    roles uuid[]

    roles_obj

    object[]

    required

  • Array [

  • pk uuidrequired
    name stringrequired

    Possible values: <= 150 characters

  • ]

Loading...