User Group

The User Group API allows you to manage user groups within your organization. User groups help organize users and manage permissions efficiently.

Overview

This API provides endpoints to:

• Create new user groups
• Update existing user groups
• Retrieve user group details
• List user groups with pagination and filtering
• Delete user groups

Authentication

All endpoints require authentication using the ONLIVESITE authentication scheme. Include the Authorization header in your requests:

Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

The signature is calculated based on your credentials and the request parameters. Refer to the Authentication section for details on how to generate the signature.

Base URL

https://openapi.onlive.site/api/v1/user-groups

Common Parameters

When listing user groups, you can use the following query parameters:

Parameter	Type	Required	Description
page	number	No	Page number for pagination (default: 1)
limit	number	No	Number of items per page (default: 20)
search	string	No	Search groups by name or description
organizationId	string	No	Filter groups by organization ID

Response Format

All responses are in JSON format and include:

• HTTP status code indicating success or failure
• Response body containing the requested data
• Error messages when applicable

Rate Limiting

The API implements rate limiting to ensure stability. Each API key has a quota of:

• 1000 requests per minute for read operations
• 100 requests per minute for write operations

Error Handling

The API uses standard HTTP response codes:

• 2xx: Success
• 4xx: Client errors (invalid input, authentication issues)
• 5xx: Server errors

Error responses include a message explaining what went wrong.