Me

Get Current User Endpoint

get

Get the currently authenticated user.

Args: user: Authenticated user

Returns: The currently authenticated user.

Authorizations

Responses

application/json

objectOptional

User model for displaying user information.

get

HTTPcURLJavaScriptPython

GET /users/me HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{
  "name": "text",
  "avatar_url": "text",
  "company": "text",
  "job_title": "text",
  "metadata": {},
  "password": "text",
  "password_expired": true,
  "email": "[e-mail]",
  "oauth_provider": "text",
  "oauth_id": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_active": true,
  "is_superuser": true
}

Update Current User Endpoint

patch

Update the currently authenticated user.

Args: user_update: User update user: Authenticated user user_manager: User manager

Returns: The updated user.

Raises: ValueError: If the user is internal.

Authorizations

Body

User model for performing user updates.

namestring · min: 1 · max: 50Optional

avatar_urlstringOptional

companystring · min: 1 · max: 50Optional

job_titlestring · min: 1 · max: 50Optional

metadataobjectOptionalDefault: {}

passwordstringOptional

password_expiredbooleanOptional

is_activebooleanOptional

is_superuserbooleanOptional

Responses

application/json

objectOptional

User model for displaying user information.

application/json

patch

HTTPcURLJavaScriptPython

PATCH /users/me HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "name": "text",
  "avatar_url": "text",
  "company": "text",
  "job_title": "text",
  "metadata": {},
  "password": "text",
  "password_expired": true,
  "is_active": true,
  "is_superuser": true
}

{
  "name": "text",
  "avatar_url": "text",
  "company": "text",
  "job_title": "text",
  "metadata": {},
  "password": "text",
  "password_expired": true,
  "email": "[e-mail]",
  "oauth_provider": "text",
  "oauth_id": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_active": true,
  "is_superuser": true
}