Skip to content

Admin Panel APIs (1.0.0)

The Admin Panel APIs provide endpoints for managing organizations, users, roles, system configurations, and security features. They also support timestamp-based access controls and geo-fencing to enhance security and compliance.

Download OpenAPI description
Languages
Servers
Mock server
https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/
Production server
https://api.ivalt.com/admin/public/api/

Admin Panel Apis

Admin Panel APIs for organization, user, and role management. Includes system configurations, security controls, timestamps, and geo-fencing features.

Operations

Get All Users of Organization

Request

Fetches all users associated with an organization.

Security
ApiKeyAuth
Path
org_idstringrequired

Path parameter: id

curl -i -X GET \
  'https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/{org_id}/users' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

List of users retrieved successfully

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Get All Users of Organization" }

Get Specific User of Organization

Request

Fetches details of a specific user within an organization.

Security
ApiKeyAuth
Path
orgIdstringrequired

Path parameter: orgId

userIdstringrequired

Path parameter: userId

curl -i -X GET \
  'https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/{orgId}/user/{userId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

User details retrieved successfully

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Get Specific User of Organization" }

Create User for Organization

Request

Creates a new user under the specified organization.

Security
ApiKeyAuth
Path
orgIdstringrequired

Path parameter: orgId

Bodyapplication/jsonrequired

Request payload for user POST.

namestringrequired

Name of post /organization/{orgid}/create/user request.

country_codestringrequired

Country code of post /organization/{orgid}/create/user request.

Example: "+91"
user_codeintegerrequired

User code of post /organization/{orgid}/create/user request.

mobilestringrequired

Mobile of post /organization/{orgid}/create/user request.

Example: "6283974746"
device_tokenstringrequired

Device token of post /organization/{orgid}/create/user request.

imeistringrequired

Imei of post /organization/{orgid}/create/user request.

emailstringrequired

Email of post /organization/{orgid}/create/user request.

Example: "admin@example.com"
platformstringrequired

Platform of post /organization/{orgid}/create/user request.

Example: "android"
is_adminintegerrequired

Is admin of post /organization/{orgid}/create/user request.

curl -i -X POST \
  'https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/{orgId}/create/user' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "bikram",
    "country_code": "+91",
    "user_code": 4775,
    "mobile": "12345678",
    "device_token": "cNZpGXy3ST2Ys3fbN-Rik1:APA91bGjI3MlTcNJU2h94X1k",
    "imei": "ED9F012A-3991-4BF5-83EB-685F56FA57B7",
    "email": "bikramjeet@ivalt.com",
    "platform": "android",
    "is_admin": 1
  }'

Responses

User created successfully

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Create User for Organization" }