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

Authorizations

Query parameters

selectstringoptional

filterstringoptional

sortstringoptional

takeinteger · int32optional

skipinteger · int32optional

rolesstringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/users' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

{
  "success": true,
  "code": 1,
  "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",
      "rank": 1,
      "image": "text",
      "address": "text",
      "postalCode": "text",
      "region": "text",
      "city": "text",
      "country": "text",
      "countryCode": "text",
      "mobile": "text",
      "notes": "text",
      "customerId": 1,
      "roles": [
        "text"
      ]
    }
  ],
  "totalUsersCount": 1
}

Success

Post

Inserts a new user.

post

Authorizations

Body

userobjectoptional

User represents a user in the system.

passwordstringoptional

password is the password of the user.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/users' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "user": {
      "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",
      "rank": 1,
      "image": "text",
      "address": "text",
      "postalCode": "text",
      "region": "text",
      "city": "text",
      "country": "text",
      "countryCode": "text",
      "mobile": "text",
      "notes": "text",
      "customerId": 1,
      "roles": [
        "text"
      ]
    },
    "password": "text"
  }'

application/json

200

default

200

{
  "userId": "text",
  "success": true,
  "code": 1,
  "message": "text"
}

Success

Put

Updates an existing user.

put

Authorizations

Body

userobjectoptional

User represents a user in the system.

currentPasswordstringoptional

current_password is the current password of the user.

newPasswordstringoptional

new_password is the new password of the user.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/users' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "user": {
      "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",
      "rank": 1,
      "image": "text",
      "address": "text",
      "postalCode": "text",
      "region": "text",
      "city": "text",
      "country": "text",
      "countryCode": "text",
      "mobile": "text",
      "notes": "text",
      "customerId": 1,
      "roles": [
        "text"
      ]
    },
    "currentPassword": "text",
    "newPassword": "text"
  }'

application/json

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text"
}

Success

Delete

Deletes a user by ID.

delete

Authorizations

Path parameters

userIdstringrequired

user_id is the ID of the user to be deleted.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/users/{userId}' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text"
}

Success