Skip to main content

core_users_me_retrieve

GET 

/core/users/me/

Get information about current user

Responses

Schema

    user

    object

    required

    User Serializer for information a user can retrieve about themselves

    pk ID (integer)required
    username stringrequired

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

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

    name stringrequired

    User's display name.

    is_active Active (boolean)required

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

    is_superuser booleanrequired

    groups

    object[]

    required

  • Array [

  • name stringrequired
    pk stringrequired
  • ]

  • email email

    Possible values: <= 254 characters

    avatar stringrequired

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

    uid stringrequired

    settings

    object

    required

    Get user settings with brand and group settings applied

    property name* any

    Get user settings with brand and group settings applied

    type UserTypeEnum (string)

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

    system_permissions string[]required

    Get all system permissions assigned to the user

    original

    object

    User Serializer for information a user can retrieve about themselves

    pk ID (integer)required
    username stringrequired

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

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

    name stringrequired

    User's display name.

    is_active Active (boolean)required

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

    is_superuser booleanrequired

    groups

    object[]

    required

  • Array [

  • name stringrequired
    pk stringrequired
  • ]

  • email email

    Possible values: <= 254 characters

    avatar stringrequired

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

    uid stringrequired

    settings

    object

    required

    Get user settings with brand and group settings applied

    property name* any

    Get user settings with brand and group settings applied

    type UserTypeEnum (string)

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

    system_permissions string[]required

    Get all system permissions assigned to the user

Loading...