core_users_me_retrieve

GET 
/api/v3//core/users/me/

Get information about current user

Responses

200

application/json

Schema

Schema

user

object

required

User Serializer for information a user can retrieve about themselves

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)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

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)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

Example (from schema)

{
  "user": {
    "pk": 0,
    "username": "string",
    "name": "string",
    "is_active": true,
    "is_superuser": true,
    "groups": [
      {
        "name": "string",
        "pk": "string"
      }
    ],
    "email": "[email protected]",
    "avatar": "string",
    "uid": "string",
    "settings": {},
    "type": "internal",
    "system_permissions": [
      "string"
    ]
  },
  "original": {
    "pk": 0,
    "username": "string",
    "name": "string",
    "is_active": true,
    "is_superuser": true,
    "groups": [
      {
        "name": "string",
        "pk": "string"
      }
    ],
    "email": "[email protected]",
    "avatar": "string",
    "uid": "string",
    "settings": {},
    "type": "internal",
    "system_permissions": [
      "string"
    ]
  }
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

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

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '/api/v3/core/users/me/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token