Versions Compared

Key

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

...

...

This section includes:

Table of Contents
minLevel1
maxLevel7

Overview

Fuse’s RESTful API

...

includes a Manage Users endpoint, which allows customers to integrate their Fuse instance with

...

a HRISor identity system.

This guide refers to the

...

‘Fuse API Manage Users RESTFUL

...

endpoint’as the

...

‘Manage Users

...

endpoint'for simplicity.

Using the Manage Users endpoint

Take note of the following information before using the

...

Manage Users endpoint:

Communication

The Fuse API uses standard HTTPrequest method/operations.
These are as follows:

Request method

Description

GET

...

Allows you to retrieve a user and their details.

POST

...

Allows you to create a new user

...

.

PUT

...

Allows you to edit

...

and update existing

...

users.

DELETE

...

Allows you to deactivate users.

Info

...

Fuse’s RESTFUL API supports JSON (Java Script Object Notation).

Authorisation

Each Fuse API request requires authorisation. The API authorisation is currently associated with one or more defined admin user

...

accounts on your Fuse instance.

Note

Ensure that these accounts have suitably complex and valid passwords.

Info

See the Authorisation page for how to obtain a valid authentication.

Additional information

API

...

Documentation

Each Fuse instance includes Swagger-based API documentation that lists all the Fuse API endpoints. This is only available to Fuse Admins with access to the Admin panel: https://<instance_name>.fuseuniversal.com/site-admin/api_documentations

API Version

Tip

This documentation is based on the most recent API version 4.

...

4.

All Fuse APIs are versioned. It is recommended that customers always use the latest API version available.

The API version is shown within the endpoint URL for example:
https://<instance_name>.fuseuniversal.com/api/v4.

...

4/manage/users

Note

Whilst Fuse always tries to maintain support for older API versions, this is not always possible. All new functionality is released as a new version.

API key terms

...

Throughout this guide you will see several API related terms To familiarise yourself with these terms, see API key terms.