Users

Managing Access and Permissions: Users and Roles

The 'Users' and 'User Roles' sections of the Babel Licensing Service API are integral components dedicated to managing user-specific data, interactions, and access permissions based on distinct roles. These segments ensure efficient management of user profiles and facilitate role-based authorization, which is crucial for a secure and organized system.

Key functionalities within the 'Users' section include:

1. User Creation: Facilitates the addition of new users, expanding the system's user base.

2. User Information Retrieval: Enables querying of user details for effective management and support.

3. User Update: Allows for updating user profiles, including roles and personal information.

4. User Deletion: Permits the removal of users, maintaining data integrity and compliance.

Through this structured approach to user management and role-based authorization, the Babel Licensing Service API provides a secure, organized, and efficient way to manage system users and their interactions with various components of the service.

Get

Retrieves a list of users.

GET/v1/users

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

usersarray of User (object)

users is the list of users.

totalUsersCountinteger (int32)

total_users_count is the total number of users.

Request

JavaScriptCurl

const response = await fetch('/v1/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "users": [
    {
      "id": "text",
      "userName": "text",
      "email": "text",
      "phoneNumber": "text",
      "title": "text",
      "firstName": "text",
      "lastName": "text",
      "department": "text",
      "birthDate": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "lastDismissMessages": "text",
      "lastLogIn": "text",
      "image": "text",
      "address": "text",
      "postalCode": "text",
      "region": "text",
      "city": "text",
      "country": "text",
      "countryCode": "text",
      "mobile": "text",
      "notes": "text",
      "roles": [
        "text"
      ]
    }
  ]
}

Post

Inserts a new user.

POST/v1/users

Body

application/json

userUser (object)

User represents a user in the system.

passwordstring

password is the password of the user.

Response

200default

Success

Body

application/json

userIdstring

user_id is the ID of the created user.

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "userId": "text",
  "success": false,
  "message": "text"
}

Put

Updates an existing user.

PUT/v1/users

Body

application/json

userUser (object)

User represents a user in the system.

currentPasswordstring

current_password is the current password of the user.

newPasswordstring

new_password is the new password of the user.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/users', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

Delete

Deletes a user by ID.

DELETE/v1/users/{userId}

Path parameters

userId*string

user_id is the ID of the user to be deleted.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/users/{userId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}