Create a new user | Unleash Documentation

Creates a new user with the given root role.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Request

createUserSchema

rootRoleinteger or enumRequired

The role to assign to the user. Can be either the role's ID or its unique name.

usernamestringOptional

The user's username. Must be provided if email is not provided.

emailstringOptional

The user's email address. Must be provided if username is not provided.

namestringOptional

The user’s name (not the user’s username).

passwordstringOptional

Password for the user

sendEmailbooleanOptional

Whether to send a welcome email with a login link to the user or not. Defaults to true.

Response headers

locationstring or null

The location of the newly created resource.

Response

The resource was successfully created.

idinteger

The user id

namestring or null

Name of the user

emailstring or null

Email of the user

usernamestring or null

A unique username for the user

imageUrlstring or null

URL used for the user profile image

inviteLinkstring or null

If the user is actively inviting other users, this is the link that can be shared with other users

loginAttemptsinteger or null>=0

How many unsuccessful attempts at logging in has the user made

emailSentboolean or null

Is the welcome email sent to the user or not

rootRoleinteger or enum or null

Which root role this user is assigned. Usually a numeric role ID, but can be a string when returning newly created user with an explicit string role.

seenAtstring or nullformat: "date-time"

The last time this user logged in

createdAtstring or nullformat: "date-time"

The user was created at this time

accountTypeenum or null

A user is either an actual User or a Service Account

Allowed values:

permissionslist of strings or null

Deprecated

scimIdstring or null

The SCIM ID of the user, only present if managed by SCIM

seatTypestring or null

The seat type of this user

activeSessionsinteger or null

Count of active browser sessions for this user

deletedSessionsdouble or null

Experimental. The number of deleted browser sessions after last login

1	import requests
2
3	url = "https://app.unleash-instance.example.com/api/admin/user-admin"
4
5	payload = { "rootRole": "Admin" }
6	headers = {
7	"Authorization": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"id": 123,
3	"name": "User",
4	"email": "user@example.com",
5	"username": "hunter",
6	"imageUrl": "https://example.com/242x200.png",
7	"inviteLink": "http://localhost:4242/invite-link/some-secret",
8	"loginAttempts": 3,
9	"emailSent": false,
10	"rootRole": "Admin",
11	"seenAt": "2023-06-30T11:42:00.345Z",
12	"createdAt": "2023-06-30T11:41:00.123Z",
13	"accountType": "User",
14	"permissions": [
15	"string"
16	],
17	"scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
18	"seatType": "Regular",
19	"activeSessions": 2,
20	"deletedSessions": 1
21	}

Authentication

Request

Response headers

Response

Errors