---
title: "02 User Management - DreamFactory Documentation"
source: "https://wiki.dreamfactory.com/System_Settings/02_User_Management"
canonical_url: "https://wiki.dreamfactory.com/System_Settings/02_User_Management"
converted_at: "2026-04-05T06:14:55.259Z"
format: "markdown"
converted_by: "html-to-md-ai"
---
[]()
	
	
	
	# System Settings/02 User Management

	
		From DreamFactory Wiki
		
		
		
		
		[Jump to navigation](#mw-head)
		[Jump to search](#searchInput)
		**Manage users and admins via the System API with endpoints for creating, updating, and deleting accounts**

## Contents

- [1 User Management](#User_Management)

- [1.1 Get User / Admin Details](#Get_User_/_Admin_Details)

- [1.2 Creating a User / Admin](#Creating_a_User_/_Admin)

- [1.2.1 Without Email Invitation](#Without_Email_Invitation)

- [1.2.2 With Email Invitation](#With_Email_Invitation)

- [1.3 Updating a User / Admin](#Updating_a_User_/_Admin)

- [1.4 Deleting a User / Admin](#Deleting_a_User_/_Admin)

- [1.5 See also](#See_also)

# User Management

Users and Admins can be managed using the `/system/user` and `/system/admin` endpoints respectively.

For the below examples, replace `user` with `admin` when managing admins.

## Get User / Admin Details

**Endpoint:** `GET [https://{url}/api/v2/system/user](https://{url}/api/v2/system/user)`

**Curl Equivalent:**

```
curl -X GET "https://{url}/api/v2/system/user" -H "accept: application/json" \
-H "X-DreamFactory-Session-Token: <session_token>"

```

You can retrieve an individual user / admin's details using the `?ids=<id_number>` parameter. If you don't know the id number off hand, you can filter by any field which you do know, such as an email address by using the filter parameter. For example:

```
https://{url}/api/v2/system/[email protected]

```

## Creating a User / Admin

### Without Email Invitation

**Endpoint:** `POST [https://{url}/api/v2/system/user](https://{url}/api/v2/system/user)`

You will need to provide your session token in a `X-DreamFactory-Session-Token` header.

**Request Body:**

```
{
  "resource": [
    {
      "name": "display_name",           // Required field
      "first_name": "first_name",
      "last_name": "user_last_name",
      "email": "email_address",         // Required field
      "password": "password"
    }
  ]
}

```

**Curl Equivalent:**

```
curl -X POST "https://<url>/api/v2/system/user" \
-H "accept: application/json" -H "Content-Type: application/json" \
-H "X-DreamFactory-Session-Token: <sessionToken>" \
-d "{\"resource\":[{\"name\":\"<display_name>\",\"first_name\":\"<first_name>\",\"last_name\":\"<last_name>\",\"email\":\"<email_address>\",\"password\":\"<password>\"}]}"

```

### With Email Invitation

**Endpoint:** `POST [https://{url}/api/v2/system/user?send_invite=true](https://{url}/api/v2/system/user?send_invite=true)`

**Request Body:**

```
{
  "resource": [
    {
      "name": "display_name",           // Required field
      "first_name": "first_name",
      "last_name": "user_last_name",
      "email": "email_address",         // Required field
    }
  ]
}

```

**Curl Equivalent:**

```
curl -X POST "https://<url>/api/v2/system/user?send_invite=true" \
-H "accept: application/json" -H "Content-Type: application/json" \
-H "X-DreamFactory-Session-Token: <sessionToken>" \
-d "{\"resource\":[{\"name\":\"<userName>\",\"first_name\":\"<firstName>\",\"last_name\":\"<lastName>\",\"email\":\"<emailAddress>\"}]}"

```

## Updating a User / Admin

To update a pre-existing User / Admin, a PATCH request can be made referencing the ID of the user to be changed with the `?ids=<ID>` parameter. You will need to provide your session token in a `X-DreamFactory-Session-Token` header.

**Endpoint:** `PATCH [https://{url}/api/v2/system/user?ids=](https://{url}/api/v2/system/user?ids=)<ID_number>`

**Request Body:**

```
{
  "resource": [
    {
     "field_to_change": "value",
     ...
    }
  ]
}

```

**Curl Equivalent:**

```
curl -X PATCH "https://{url}/api/v2/system/user?ids=<ID_number>" \
-H "accept: application/json" -H "Content-Type: application/json" \
-H "X-DreamFactory-Session-Token: <session_token>" \
-d "{\"resource\":[{\"<field_to_update\":\"value\"}]}"

```

## Deleting a User / Admin

To delete a pre-existing User / Admin, simply send a delete request with the corresponding user ID by using the `?ids=<ID>` parameter.

**Endpoint:** `DELETE [https://{url}/api/v2/system/user?ids=](https://{url}/api/v2/system/user?ids=)<ID_number>`

**Curl Equivalent:**

```
curl -X DELETE "https://{url}/api/v2/system/user?ids=<ID_number>" \
-H "accept: application/json" -H "Content-Type: application/json" \
-H "X-DreamFactory-Session-Token: <session_token>"

```

## See also

- [API Key Management](/System_Settings/05_Api_Key_Management)

- [Using the System APIs](/System_Settings/01_System_Api_Brief)

- [Role Management](/System_Settings/04_Role_Management)

- [Service Management](/System_Settings/03_Service_Management)

Retrieved from "[https://wiki.dreamfactory.com/index.php?title=System_Settings/02_User_Management&oldid=875](https://wiki.dreamfactory.com/index.php?title=System_Settings/02_User_Management&oldid=875)"
		[Categories](/Special:Categories): - [User Management](/Category:User_Management)
- [Admin Api](/Category:Admin_Api)
- [System Api](/Category:System_Api)
- [API](/Category:API)
- [Difficulty Intermediate](/Category:Difficulty_Intermediate)