---
title: REST API - Create User Request
slug: rm/rest-api-create-user-request
docTags: 
createdAt: 2026-06-09T13:38:46.290Z
---

```bash
/api/v1/users
```

# Description

Creates a user with specific defined properties.

# URL Structure

```bash
[Blueprint_URI]/api/v1/users
```

# Supported Methods

- ****[POST](docId\:Hsi_LzXS8g_RX_ydUdZKg)****

# Request Body

The new artifact must be defined in the body of the request. Read more about how to [define a user in the request body](docId\:edOHcU3eCPkUbFXN5sp_b).

# HTTP Status Codes

- 201: Successfully Created
- 207: Partially Successful
  - Some of the users could not be created. Refer to the codes in the response for the reason for each unsuccessfully added user:
    - 1192: A required value is missing or invalid: username, display name, first name, last name, password.
    - 1193: The user was created, but could not be added to a group.
    - 1194: The assigned Instance Administrator role does not exist.
- 400: Bad Request
  This error can occur for a variety of reasons:
  - At least one URI or request body parameter is invalid, such as one of the [Filter](docId\:Sv9GjVErxCZcgqdn28J7U), Traces, Offset or Limit parameters.
  - A required value has not been provided.
  - If you are submitting a [POST](docId\:Hsi_LzXS8g_RX_ydUdZKg) or [PATCH](docId\:RcjvHRLbY6de-zGKeHxuI) request and have not added the `X-HTTP-Method-Override` parameter to your request header.
- 401: Unauthorized
  - The Blueprint token is missing, invalid or expired.
- 403: Forbidden
  - The applicable permissions are needed. For example, this error can occur when:
    - An Author or Collaborate license is needed for access.
    - Comment permissions are needed on the artifact.
    - Edit permissions are needed on the change summary job.
- 409: Conflict
  - Reason for failure can be found in the response body. Additional information may also be found in the log.

# Examples

## XML Example

**Request URI**

```bash
https://production.blueprintcloud.com/api/v1/users
```

**Request Body**

```xml
<?xml version="1.0" ?><Users xmlns="http://www.blueprintsys.com/blueprint/api/v1">	<User>		<Email>dquade2084@dev.recall.com</Email>		<Department>Devops</Department>		<DisplayName>quaaade</DisplayName>		<Firstname>Douglas</Firstname>		<Lastname>Quade</Lastname>		<Name>dquade</Name>		<Enabled>true</Enabled>		<Password>@Quaaade#1</Password>		<ExpiredPassword>false</ExpiredPassword>		<GroupIds xmlns:i="http://schemas.microsoft.com/2003/10/Serialization/Arrays">			<i:int>8</i:int>		</GroupIds>		<Title>Engineer</Title>	</User></Users>
```

**Response Body**

:::CodeblockTabs
LANGUAGE-PHP-TEMPLATE

```php
<UserAddResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.blueprintsys.com/blueprint/api/v1">	<UserAddResult>		<Message>User has been created successfully</Message>		<ResultCode>201</ResultCode>		<User>			<DisplayName>quaaade</DisplayName>			<Enabled>false</Enabled>			<Firstname>Douglas</Firstname>			<Groups />			<Id>3754</Id>			<Lastname>Quade</Lastname>			<Name>dquade</Name>			<Title>Engineer</Title>		</User>	</UserAddResult></UserAddResults>
```
:::

## JSON Example

**Request URI**

```bash
https://production.blueprintcloud.com/api/v1/users
```

**Request Body**

```json
[	{		"Type": "User",		"Name": "dquade",		"DisplayName": "quaaade",		"Firstname": "Douglas",		"Lastname": "Quade",		"GroupIds": [			"1",			"8",			"12"		],		"Title": "Engineer",		"Department": "Devops",		"Password": "#fR33m4R5",		"Enabled": true,		"Email": "dquade2084@dev.recall.com"	}]
```

**Response Body**

```json
[	{		"User": {		"Type": "User",		"Id": 2084,		"Name": "dquade",		"DisplayName": "quaaade",		"Firstname": "Douglas",		"Lastname": "Quade",		"GroupIds": [			"1",			"8",			"12"		],		"Title": "Engineer",		"Department": "Devops",		"Password": "#fR33m4R5",		"Enabled": true,		"Email": "dquade2084@devops.recall.com"		},		"Message": "User has been created successfully",		"ResultCode": 201	}]
```