🔐 Authentication

The ManageOSUsers API employs Basic Authentication. To authenticate:

1. Encode your username and password in Base64 format.

2. Include the following header in your HTTP requests:

   Authorization: Basic {Base64EncodedCredentials}
   

Replace {Base64EncodedCredentials} with your actual encoded credentials.

📘 API Endpoints Overview

The API provides endpoints to manage users and groups. Below is a summary of the available operations:

👤 User Management

• Create User

  • Method: POST

  • Endpoint: /ManageOSUsers/CreateUser

  • Description: Creates a new user with specified details.

• Get User by Username

  • Method: GET

  • Endpoint: /ManageOSUsers/GetUserByUsername/{username}

  • Description: Retrieves user information based on the provided username.

• Update User

  • Method: PUT

  • Endpoint: /ManageOSUsers/UpdateUser

  • Description: Updates details of an existing user.

• Delete User

  • Method: DELETE

  • Endpoint: /ManageOSUsers/DeleteUser/{userId}

  • Description: Deletes the user with the specified ID.
    
    

👥 Group Management

• Create Group

  • Method: POST

  • Endpoint: /ManageOSUsers/CreateGroup

  • Description: Creates a new user group.

• Get Group by Name

  • Method: GET

  • Endpoint: /ManageOSUsers/GetGroupByName/{groupName}

  • Description: Retrieves group information based on the provided name.

• Update Group

  • Method: PUT

  • Endpoint: /ManageOSUsers/UpdateGroup

  • Description: Updates details of an existing group.

• Delete Group

  • Method: DELETE

  • Endpoint: /ManageOSUsers/DeleteGroup/{groupId}

  • Description: Deletes the group with the specified ID.
    
    

🛠️ Request and Response Formats

All API requests and responses use the JSON format.

Example: Create User Request

jsonCopyEdit
{
  "Username": "jdoe",
  "Password": "SecurePass123",
  "Email": "jdoe@example.com",
  "FullName": "John Doe",
  "IsActive": true
}

Example: Create User Response

jsonCopyEdit
{
  "UserId": 101,
  "Status": "Success",
  "Message": "User created successfully."
}

⚠️ Error Handling

The API returns standard HTTP status codes to indicate the success or failure of requests:

• 200 OK: Request succeeded.

• 400 Bad Request: The request was invalid or cannot be served.

• 401 Unauthorized: Authentication failed or user does not have permissions.

• 404 Not Found: The requested resource could not be found.

• 500 Internal Server Error: An error occurred on the server.

Error responses include a message detailing the issue.

🔗 Additional Resources

• OutSystems REST API Guide: Consume REST APIs