Admin and User Operations

User Management & Role-Based Access

The Floating Server has two types of users:

1

Administrators

• Manage the server.

• Activate or deactivate licenses by adding or removing them from the Floating Server.

• Manage users who can register (check out) licenses.

2

Management Users

• Managed by administrators.

• Can register/unregister to licenses added to the Floating Server.

• Can send license and feature consumption data back to the server, usually via a client application.

Authentication:

• By default, both admin and user actions require authentication.

• If DisableUserAuth is set to false in the configuration file, only admin actions require authentication; users can perform actions without logging in.

User Setup

• Admin adds each user to the server.

• Admin sets an initial password and shares it with the user.

• On first login, the user must change their password via:

POST /api/v5/auth/change-password

For a complete list of API calls for admins and users, refer to the Swagger documentation.

Administrator Actions

Authentication required: Yes

1

User Management

• Login: POST /api/v5/auth/login

• Add user: POST /api/v5/auth/add-user

• Remove user: POST /api/v5/auth/remove-user

2

Administrators — License Operations

Online Licenses

• Add license: POST /api/v5/license

• Remove license: DELETE /api/v5/license/{id}

Offline Licenses

• Generate offline activation request: POST /api/v5/license/offline/activation/generate

• Upload and activate license file: POST /api/v5/license/offline/activation/upload

• Generate offline deactivation request: POST /api/v5/license/offline/deactivation/generate

Air-Gapped Licenses

• Generate activation code: POST /api/v5/license/airgap/generate

• Upload license file & confirmation code: POST /api/v5/license/airgap/activate

• Generate deactivation code: POST /api/v5/license/airgap/deactivate

• Deactivate using confirmation code: POST /api/v5/license/airgap/activate

Bundle Management

• Add bundle: POST /api/v5/bundle

• Remove bundle: DELETE /api/v5/bundle/{code}

Admins can also perform all actions that users are allowed to do.

User Actions

Authentication required:

• Register/unregister to licenses:

POST /api/v5/license/{id}/user/register POST /api/v5/license/{id}/user/unregister

• Register/release features:

POST /api/v5/license/{id}/feature/register POST /api/v5/license/{id}/feature/release

• Add license or feature consumption:

POST /api/v5/license/{id}/consumption/add POST /api/v5/license/{id}/consumption/feature/add

JWT Authentication

• Obtain a JWT token:

POST /api/v5/auth/login

• Include the JWT in the Authorization header for all authenticated requests:

Authorization: Bearer

Example Floating License Flow

1

Create user

Admin creates a user.

2

Initial password change

User logs in and changes their password.

3

Obtain JWT

User logs in again to obtain a JWT.

4

Add license

Admin adds the license: POST /api/v5/license

5

Register license

User registers to the license: POST /api/v5/license/{id}/register