Versions Compared

Key

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

Create

User

user

Please read this page before using this resourceguide.

Create new user with an HTTP POST request.

Resource URL:

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

Request

Request

Header Parameters

header parameters

Authorisation is required.

Request

Parameters

parameters

Mandatory parameters used to create a new user

include

are: username, password and password_confirmation.

  • Mandatory parameters as well as all the optional parameters are described in the User Profile Fields

    reference

    guide.

  • Editing the

    “Settings”

    Settings section

    “Default Locale”

    Default Locale and changing the Language Code to any required

    Language will set

    language sets the default language of the newly created user. (Example can be seen in Request #2).

Info

Please use Use the request examples as a reference.

Note

The request example doesn’t does not include all the possible parameters.

Response

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

Note

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

Info

Please refer Refer to the Response Codes page guide for more information.

EXAMPLE REQUEST #1

Single user with just only mandatory parameters.

REQUEST

Request URL

EXAMPLE

example

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

REQUEST BODY

Request body

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

EXAMPLE REQUEST #2

Detailed A detailed user creation.

REQUEST

Request URL

EXAMPLE:

example

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

REQUEST BODY

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"
            }
        }
    ]
}