Documentation

5. Me API Endpoint

Make a GET request to retrieve user information about the current user.

GET /api/v1/me/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
X-API-Time: 0.055s


{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "type": "user",
            "url": "/api/v1/users/1/",
            "related": {
                "admin_of_organizations": "/api/v1/users/1/admin_of_organizations/",
                "organizations": "/api/v1/users/1/organizations/",
                "credentials": "/api/v1/users/1/credentials/",
                "permissions": "/api/v1/users/1/permissions/",
                "activity_stream": "/api/v1/users/1/activity_stream/",
                "projects": "/api/v1/users/1/projects/",
                "teams": "/api/v1/users/1/teams/"
            },
            "created": "2015-08-25T01:00:07.127Z",
            "username": "admin",
            "first_name": "",
            "last_name": "",
            "email": "[email protected]",
            "is_superuser": true,
            "ldap_dn": ""
        }
    ]
}

One result should be returned containing the following fields:

  • id: Database ID for this user. (integer)
  • type: Data type for this user. (multiple choice)
  • user: User
  • url: URL for this user. (string)
  • related: Data structure with URLs of related resources. (object)
  • created: Timestamp when this user was created. (datetime)
  • username: Required. 30 characters or fewer. Letters, numbers and @/./+/-/_ characters (string)
  • first_name: (string)
  • last_name: (string)
  • email: (email)
  • is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
  • password: Write-only field used to change the password. (string)
  • ldap_dn: (string)

Use the primary URL for the user (/api/v1/users/N/) to modify the user.

5.1. Reviewing the Options Endpoint

The Options Endpoint table offers a view of the Options for this endpoint. When viewing the endpoint in the browsable API, clicking the “Options” button gives you the raw JSON for the following:

name Me
description Make a GET request to retrieve user information about the current user.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 1.2
types
0 user
actions
GET
id
type integer
label ID
help_text Database ID for this user.
type
type multiple choice
help_text Data type for this user.
choices
0
0 user
1 User
url
type string
help_text URL for this user.
related
type object
help_text Data structure with URLs of related resources.
created
type datetime
help_text Timestamp when this user was created.
username
type string
label username
help_text Required. 30 characters or fewer. Letters, numbers and @/./+/-/_ characters
first_name
type string
label first name
last_name
type string
label last name
email
type email
label email address
is_superuser
type boolean
label superuser status
help_text Designates that this user has all permissions without explicitly assigning them.
ldap_dn
type string
search_fields
0 username
1 first_name
2 last_name
3 email