Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Create User

Please read this page before using this resource.

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

  • Mandatory parameters to create a new user include username, password and password_confirmation.

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

    • Editing the “Settings” section “Default Locale” and changing the Language Code to any required Language will set the default language of the newly created user. (Example Request #2)

Please use the request examples as reference.

The request example doesn’t include all the 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.

The Fuse userID is the UID automatically generated by the system on user creation. It cannot be changed. All other user attributes can be changed.

Please refer to the Response Codes page for more information.

EXAMPLE REQUEST #1

Single user with just mandatory parameters.

REQUEST URL EXAMPLE

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

REQUEST BODY

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

EXAMPLE REQUEST #2

Detailed user creation.

REQUEST URL EXAMPLE:

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

REQUEST BODY

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

  • No labels