Skip to main content

core_users_list

GET 
/core/users/

User Viewset

Request​

Query Parameters

    attributes string

    Attributes

    email string
    groups_by_name string[]
    groups_by_pk uuid[]
    include_groups boolean

    Default value: true

    is_active boolean
    is_superuser boolean
    name string
    ordering string

    Which field to use when ordering the results.

    page integer

    A page number within the paginated result set.

    page_size integer

    Number of results to return per page.

    path string
    path_startswith string
    search string

    A search term.

    type string[]

    Possible values: [external, internal, internal_service_account, service_account]

    username string
    uuid uuid

Responses​

Schema

    pagination

    object

    required

    next numberrequired
    previous numberrequired
    count numberrequired
    current numberrequired
    total_pages numberrequired
    start_index numberrequired
    end_index numberrequired

    results

    object[]

    required

  • Array [

    • pk ID (integer)required
    username stringrequired

    Possible values: <= 150 characters

    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
    is_superuser booleanrequired
    groups uuid[]

    groups_obj

    object[]

    nullable

    required

  • Array [

    • pk uuidrequired
    num_pk integerrequired

    Get a numerical, int32 ID for the group

    name stringrequired

    Possible values: <= 80 characters

    is_superuser boolean

    Users added to this group will be superusers.

    parent uuidnullable
    parent_name stringnullablerequired

    attributes

    object

  • ]

    • email email

    Possible values: <= 254 characters

    avatar stringrequired

    User's avatar, either a http/https URL or a data URI

    attributes

    object

    uid stringrequired
    path string
    type UserTypeEnum (string)

    Possible values: [internal, external, service_account, internal_service_account]

    uuid uuidrequired

  • ]

Loading...