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 Multiple User

Please read this page before using this resource.

Create new user with HTTP POST request, similar to adding a single user but rather listing multiple users in an array.

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.

Please use the request example as reference.

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

Settings and Profile options will vary depending on the requirement.

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

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!",
            "email": "testuser1@net.com",
            "role": "user",
            "profile": {
                "FirstName": "test1",
                "LastName": "user1"
            },
            "plain_text_emails": true,
            "hidden_from_leaderboard": true,
            "accessibility_enabled": false,
            "accessibility_theme": "theme_v1",
            "settings": {
                "default_locale": "en",
                "instant_emails": true,
                "send_instant_for_comment": true,
                "send_instant_for_share": true,
                "send_instant_for_like": true,
                "send_instant_for_revision": true,
                "digest_emails": "on",
                "notification_block_in_digest": true
            }
        },
        {
            "username": "testuser2",
            "password_confirmation": "Password1234@",
            "password": "Password1234@",
            "email": "testuser2@net.com",
            "role": "user",
            "profile": {
                "FirstName": "test2",
                "LastName": "user2"
            },
            "plain_text_emails": true,
            "hidden_from_leaderboard": true,
            "accessibility_enabled": false,
            "accessibility_theme": "theme_v1",
            "settings": {
                "default_locale": "en",
                "instant_emails": true,
                "send_instant_for_comment": true,
                "send_instant_for_share": true,
                "send_instant_for_like": true,
                "send_instant_for_revision": true,
                "digest_emails": "on",
                "notification_block_in_digest": true
            }
        },
        {
            "username": "testuser3",
            "password_confirmation": "Password1234#",
            "password": "Password1234#",
            "email": "testuser3@net.com",
            "role": "user",
            "profile": {
                "FirstName": "test3",
                "LastName": "user3"
            },
            "plain_text_emails": true,
            "hidden_from_leaderboard": true,
            "accessibility_enabled": false,
            "accessibility_theme": "theme_v1",
            "settings": {
                "default_locale": "en",
                "instant_emails": true,
                "send_instant_for_comment": true,
                "send_instant_for_share": true,
                "send_instant_for_like": true,
                "send_instant_for_revision": true,
                "digest_emails": "on",
                "notification_block_in_digest": true
            }
        }
    ]
}
  • No labels