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 Geo Fencing of Organization

Request

Retrieve all geo fences for the organization

Security
ApiKeyAuth
Path
org_idintegerrequired

Org Id provided via path.

Example: 32
curl -i -X GET \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/32/geo-fences \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Geo fences 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 Geo Fencing of Organization" }

Get Specific Geo Fencing of Organization

Request

Retrieve details of a specific geo fence by ID

Security
ApiKeyAuth
Path
org_idintegerrequired

Org Id provided via path.

Example: 32
idintegerrequired

Id provided via path.

Example: 32
curl -i -X GET \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/32/geo-fence/32 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Geo fence 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 Geo Fencing of Organization" }

Create Geo Fencing for Organization

Request

Create a new geo fence for the organization

Security
ApiKeyAuth
Path
org_idintegerrequired

Org Id provided via path.

Example: 32
Bodyapplication/jsonrequired

Request payload for geo-fence POST.

namestringrequired

Name of post /organization/{org_id}/create/geo-fence request.

Example: "Amritsar"
latitudenumberrequired

Latitude of post /organization/{org_id}/create/geo-fence request.

Example: 31.634
longitudenumberrequired

Longitude of post /organization/{org_id}/create/geo-fence request.

Example: 74.8723
radiusintegerrequired

Radius of post /organization/{org_id}/create/geo-fence request.

Example: 50
is_activeintegerrequired

Is active of post /organization/{org_id}/create/geo-fence request.

Example: 1
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/32/create/geo-fence \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Amritsar",
    "latitude": 31.634,
    "longitude": 74.8723,
    "radius": 50,
    "is_active": 1
  }'

Responses

Geo fence 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 Geo Fencing for Organization" }