IAM System API Documentation
Overview:
The IAM System API allows you to manage client dashboard users, including creating, updating, and deleting users with specific permissions and roles. Authentication is done using Basic Auth with API_KEY
and API_SECRET
.
Endpoints:
1. Create Client Dashboard User
Endpoint:POST
{{BASE_URL}}v2/client/multi-user
Description: Creates a new user with a specified email, password, role, and permissions.
All endpoints require Basic Authentication with the following headers:
Headers
Content-Type
application/json
Authorization
Basic <Base64Encoded(API_KEY:API_SECRET)>
Request Body
{
"email": "[email protected]",
"password": "Abc123",
"permissions": {
"ignite": true,
"paywallBuilder": true,
"popUpBuilder": true,
"newsLetterBuilder": true,
"meterBannerBuilder": true,
"loginSetting": true,
"manageSubscription": true,
"audienceSegment": true,
"journey": false,
"payments": false,
"taxation": true,
"subscriptionPlan": true,
"manualSubscriptions": true,
"Checkout": true,
"micropayments": true,
"paymentGateway": true,
"notifications": true,
"billing": true,
"documentation": true,
"ga4": true,
"export": true,
"webhooks": true,
"internalUser": true,
"pdfManager": true
},
"role": "ADMIN"
}
Response
201 Created: User created successfully.
2. Update Client Dashboard User Details
Endpoint:PATCH
{{BASE_URL}}v2/client/multi-user/{userId}
Description: Updates an existing user's details, including email, password, role, and permissions.
All endpoints require Basic Authentication with the following headers:
Headers
Content-Type
application/json
Authorization
Basic <Base64Encoded(API_KEY:API_SECRET)>
Request Body: Similar to Create User.
Response
User updated successfully.
Last updated