Manage Users endpoint examples

Owned by James Goodwin
Last updated: Jan 17, 2023
2 min read

The examples included in this section are based on common provisioning and administration flows.

Before using the examples for the Manage Users endpoint, take note of the following points:

Admin accounts

Theauth_token must be associated with a user with admin privileges. 

API user passwords

If the password changes on the account, the auth_token also changes. 

Key fields

All email addresses and usernames must be unique as these are key fields.

Field name case-sensitity

Fuse field names are case-sensitive. If a field does not update or you are getting a bad response, check that the field name being sent within the request matches the field name on Fuse exactly.

Duplicates

If you are creating a new user and the username or email already exists on that Fuse instance, you will receive an error, even if the existing account is deactivated.

Passwords

Ensure that the password and password_confirmation being specified when creating a user, meets the minimum password rules in the Fuse instance. If your password does not meet these rules, an error occurs.

Password / Password confirmation

The password and password_confirmation fields are mandatory when creating a user, even when SSO is enabled. These credentials are to support the local login option. Therefore it is strongly recommended that customers utilise password randomisation logic, so that each user has a unique password based on their recommended password policy and the configured Fuse password controls.

Unable to assign a manager/reportee during user creation

If you cannot assign a manager or reportee when creating a user using a POST request, because the user ID is not available until after the user has been created, use a separate API call to assign managers/reportees.

Custom profile fields

Remember that whilst the Settings options will be standard for all customers, the fields listed below the user’s Profile will be specific and unique for each customer. To see what custom profile options are configured for a Fuse instance, refer to the API documentation on that instance:
https://<instance_name>.fuseuniversal.com/site-admin/api_documentations

Configuration type settings

Most of the configuration type settings can be configured at instance level, so are generally not required to be set at the user level using the API.
Example:

"accessibility_enabled": false,"accessibility_theme": "theme_v1", "plain_text_emails": false, "default_locale": "en-GB", "notify_when_shared_with_me": true, "notify_when_shared_with_my_community": true, "notify_when_commented_my_content": true, "notify_when_commented_followed_content": true, "notify_when_liked_my_content": true, "send_email_for_all_enabled_notifications": true, "daily_digest_enabled": false, "weekly_digest_enabled": false, "chat_digest_enabled": false, "instant_emails": false, "send_instant_for_comment": false, "send_instant_for_share": false, "send_instant_for_like": false, "send_instant_for_revision": false, "digest_emails": "Off", "notification_block_in_digest": false

Custom code for a custom field/dropdown does not match codes on server

Fuse dropdown field options are referenced by unique codes. These must match the codes for the options. You can check the codes using the custom_options API endpoint.

Custom dropdown fields

If custom drop/down fields are used, they must reference a unique code generated by Fuse when each is created.

  • To check which drop/down fields are configured and their corresponding codes, do one of the following:

    • See the Profile Custom Options screen in the Admin panel: https://<instance_name>.fuseuniversal.com/manage/profile_fields

    • Perform an API lookup using the GET /custom_options endpoint .

The custom option codes are unique between Fuse instances. If a custom option is not being updated, check that the correct code is being used.

Â