Create a User in an Organization

This endpoint allows you to add a user to an organization. Enables onboarding of team members into the organization by providing essential user details such as email, password, name, and role.
Assigns the user a designated role within the organization, which may define their access level and permissions.

Path Parameters:

organization_id (int): The ID of the organization to add the user to.

Request Body:

first_name (str): The first name of the user to add to the organization.

last_name (str): The last name of the user to add to the organization.

email (str): The email of the user to add to the organization.

password (str): The password of the user to add to the organization.

role (str): The role of the user to add to the organization. (global admin, application admin, user)

Returns:

A response containing the user that was added to the organization.

Current Version:

2.0.0

curl --location --request POST '/api/v2/organizations//users' \ --header 'Content-Type: application/json' \ --data-raw '{ "first_name": "string", "last_name": "string", "email": "user@example.com", "password": "string", "role": "string" }'

{ "success": true, "message": "string", "data": { "id": 0, "email": "user@example.com", "is_staff": true, "is_superuser": true, "is_active": true, "date_joined": "2019-08-24T14:15:22Z", "first_name": "string", "last_name": "string", "organization": { "id": 0, "org_name": "string", "domain": "string", "description": "string", "org_logo_url": "string", "org_icon_url": "string", "is_deleted": true, "created_by": "string", "created_on": "2019-08-24T14:15:22Z", "modified_by": "string", "modified_on": "2019-08-24T14:15:22Z" } } }

Request

Path Params

organization_id

integer

required

The ID of the organization

Body Params application/json

first_name

string

required

First name of the user to be added to the organization

last_name

string

required

Last name of the user to be added to the organization

string <email>

required

Email of the user to be added to the organization

password

string

required

Password of the user to be added to the organization

role

string

required

Role of the user to be added to the organization. (global admin, application admin, user)

Examples

Responses

🟢201Created

application/json

Body

success

boolean

required

message

string

required

data

object (OrganizationUserListPostResponseSerializer_V2)

required

integer

read-onlyrequired

string <email>

Email address

optional

<= 254 characters

is_staff

boolean

Staff status

optional

Designates whether the user can log into this admin site.

is_superuser

boolean

Superuser status

optional

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean

Active

optional

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

date_joined

string <date-time>

optional

first_name

string | null

optional

<= 30 characters

last_name

string | null

optional

<= 30 characters

organization

object (OrganizationUserListPost_OrganizationSerializer_V2)

required

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error