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

List All Organizations

Request

Retrieve a list of Organizations. in the Admin Panel Apis domain

Security
ApiKeyAuth
curl -i -X GET \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organizations \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

List of organizations fetched 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": "List All Organizations" }

Make a User Admin of Organization

Request

Create a new Make Admin. in the Admin Panel Apis domain

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Request payload for make-admin POST.

mobile_with_country_codestringrequired

Mobile with country code of post /make-admin request.

Example: "+916283974746"
organization_namestringrequired

Organization name of post /make-admin request.

Example: "Bikram1"
organization_codestringrequired

Organization code of post /make-admin request.

Example: "1123"
has_geo_fencingintegerrequired

Has geo fencing of post /make-admin request.

Example: 1
number_geo_fencingintegerrequired

Number geo fencing of post /make-admin request.

Example: 0
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/make-admin \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mobile_with_country_code": "+916283974746",
    "organization_name": "Bikram1",
    "organization_code": "1123",
    "has_geo_fencing": 1,
    "number_geo_fencing": 0
  }'

Responses

User promoted to admin 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": "Make a User Admin of Organization" }

get-org-api-creds

Request

Retrieve organization API credentials

Security
ApiKeyAuth
Path
org_idstringrequired

Organization ID

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

Responses

Successful operation

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": "Operation completed successfully" }