Skip to main content

List All Users

Retrieve all users in the current organization.

GET /user.all

Requires admin privileges.

Authentication

Requires admin authentication.

Example Request

Example Response


Get User

GET /user.one

Retrieve details of a specific user.
string
required
The unique identifier of the user

Authorization

  • Users can access their own information
  • Admins can access any user in their organization

Example Request


Get Current User

GET /user.get

Retrieve the currently authenticated user’s information including API keys.

Example Request

Example Response


Update User

POST /user.update

Update user profile and password.
string
Updated user name
string
Updated email address
string
Profile image URL
string
Current password (required when changing password)
string
New password

Example Request


Remove User

POST /user.remove

Delete a user from the organization.
  • Only admins and owners can delete users
  • Cannot delete the organization owner
  • Admins cannot delete themselves
  • Only owners can delete other admins
string
required
The unique identifier of the user to remove

Example Request


Assign Permissions

POST /user.assignPermissions

Update user permissions and role within the organization.
Only organization owners can assign permissions.
string
required
User ID to update
string
User role: owner, admin, or member
boolean
Permission to create new projects
boolean
Permission to delete projects
boolean
Permission to view audit logs

Example Request


API Key Management

Create API Key

POST /user.createApiKey

Generate a new API key for programmatic access.
string
required
Name for the API key
string
Custom prefix for the API key
number
Expiration time in seconds
object
required
Metadata including organization information
string
required
Organization ID for the API key
boolean
Enable rate limiting for this key
number
Rate limit time window in seconds
number
Maximum requests per time window
number
Total number of requests allowed
number
Number of requests to refill
number
Refill interval in seconds

Example Request

Example Response

Store the API key securely. It will only be shown once during creation.

Delete API Key

POST /user.deleteApiKey

string
required
The unique identifier of the API key to delete

Invitations

Get User Invitations

GET /user.getInvitations

Retrieve pending invitations for the current user.

Example Response

Send Invitation

POST /user.sendInvitation

Send an invitation email to a user.
Admin privileges required. Disabled on Dokploy Cloud.
string
required
The invitation ID to send
string
required
Notification provider ID for sending the email

User Organization Info

Check User Organizations

GET /user.checkUserOrganizations

Check how many organizations a user belongs to.
string
required
The user ID to check

Example Response


Metrics Access

Get Metrics Token

GET /user.getMetricsToken

Retrieve the token and configuration for accessing metrics.

Example Response