Create a User in an Organization

POST

/api/v2/organizations/{organization_id}/users

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, optional): The password of the user to add to the organization. If omitted, an unusable password is set.

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

Request Headers:

X-Authorization-Consistency-Token (string, optional): Authorization consistency token for read-after-write consistency. Pass the token received from a previous write operation to ensure this read reflects that write.

Returns:

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

Response Headers:

X-Authorization-Consistency-Token (string): Authorization consistency token returned after a write operation. Pass this in subsequent read requests to ensure read-after-write consistency.

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params

application/json

Required

Examples

Responses

🟢201Created

application/json

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/organizations//users' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "first_name": "string",
    "last_name": "string",
    "email": "[email protected]",
    "password": "string",
    "role": "string"
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "email": "[email protected]",
        "is_staff": true,
        "is_superuser": true,
        "is_active": true,
        "date_joined": "2019-08-24T14:15:22.123Z",
        "first_name": "string",
        "last_name": "string",
        "organization": {
            "id": 0,
            "created_by": "string",
            "modified_by": "string",
            "created_on": "2019-08-24T14:15:22.123Z",
            "modified_on": "2019-08-24T14:15:22.123Z",
            "org_name": "string",
            "domain": "string",
            "description": "string",
            "org_logo_url": "string",
            "org_icon_url": "string",
            "org_logo_url_dark": "string",
            "org_icon_url_dark": "string",
            "is_deleted": true,
            "parent": 0
        }
    }
}

Get all Users in an Organization

Get all Configurations of user's Organization