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 »

Overview

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

Please consider following things whilst using the Manage Users Endpoint and resources:

  • Admin Account - auth_token must be associated with a user with Admin privileges. 

  • API User Password - Note that if the password changes on the account, the auth_token will also change. 

  • Key Fields - All email addresses and usernames must be unique as these are key fields.

  • Case-Sensitive - 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 settings of your Fuse instance. It will error if not.

  • Password / Password Confirmation - are mandatory fields for user creation, even if SSO is used. These credentials are to support the local login option. Therefore it is strongly recommended that customers utilise password randomization logic so each user has a unique password based on their recommended password policy and the configured Fuse password controls.

  • Cannot set Manager or Reportee as part of a create user POST call as the userID will not be available until after the user is created - use separate call to associate managers

  • Custom Profile Fields - Remember that whilst Settings options will be standard for all customers, the fields listed below 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 Wiki on that instance:

    • https://<instance_name>.fuseuniversal.com/site-admin/api_documentations

  • Settings - Most of the configuration type settings can be configured at the instance level so are generally not required to be set at the user level via API. For 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 drop-down field options are referenced by unique codes. These need to match the codes for the options. Check the codes via \custom_options endpoint.

  • Custom Drop/Down Fields - If Custom drop/down fields are used then these need to be referenced by a unique code generated by Fuse when each is created.

    • To check what drop/down fields are configured and their corresponding codes to reference:

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

      • Do an API lookup GET via the /custom_options endpoint .

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

  • No labels