Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Please read this page before using this guide

Create new user with an HTTP POST request.

Resource URL:

https://<instance_name>.fuseuniversal.com/api/v4.3/manage/users

Request

Request header parameters

Authorisation is required.

Request parameters

The mandatory parameters required to create a new user are: username, password and password_confirmation.

  • Mandatory parameters as well as all the optional parameters are described in the User profile fields guide.

  • Editing the Settings section Default Locale and changing the language code to for any required language, sets the default language of the newly created user. (Example can be seen in Request #2).

Info

Use the request examples on this page as a reference.

Note

The request example does not include all possible parameters.

Response

The response for this API endpoint contains the user registration that was created. Security-sensitive fields may not be returned in the response.

Note

The Fuse userID user ID is the UID automatically generated by the system when a user is created. This cannot be changed. All other user attributes can be changed.

Info

Refer to the Response codes guide for more information.

Example request #1

Create a single user with only mandatory parameters.

Request URL example

https://<instance_name>.fuseuniversal.com/api/v4.3/manage/users?auth_token=<valid_auth_token>

Request body

Code Block
languagejson
{
    "users": [
        {
            "username": "testuser1",
            "password": "Password1234!",
            "password_confirmation": "Password1234!"
        }
    ]
}

Example request #2

A detailed user creation.

Request URL example

https://<instance_name>.fuseuniversal.com/api/v4.3/manage/users?auth_token=<valid_auth_token>

Request body

Code Block
languagejson
{
    "users": [
        {
            "username": "testuser1",
            "password_confirmation": "Password1234!",
            "password": "Password1234!",
            "display_name": "Testuser1",
            "public_name": null,
            "given_name": null,
            "family_name": null,
            "email": "test.user1@fuseuniversal.com",
            "accessibility_enabled": false,
            "accessibility_theme": "theme_v1",
            "manager_ids": [],
            "profile": {
                "First Name": "test",
                "Last Name": "user1",
                "UID 18": "77777777",
                "Owner Name": null,
                "Owner ID 18": null,
                "Functional Role": "12981",
                "All Active Campaigns": null,
                "Start Date": "2020-10-07",
                "Tenure": null,
                "Org Consultant": null,
                "Active/Deactivated Flag": "12970"
            },
            "settings": {
                "default_locale": "en-UK"
            }
        }
    ]
}