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

Remove User from Organization

Request

Removes a user from the specified organization.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Request payload for user POST.

org_idstringrequired

Org id of post /organization/remove/user request.

Example: "56"
country_codestringrequired

Country code of post /organization/remove/user request.

Example: "+91"
mobilestringrequired

Mobile of post /organization/remove/user request.

Example: "6283974746"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/remove/user \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "org_id": "56",
    "country_code": "+91",
    "mobile": "6283974746"
  }'

Responses

User removed 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": "Remove User from Organization" }

Create Organization Auth Code

Request

Generates a new authentication code for the given organization.

Security
ApiKeyAuth
Path
org_idstringrequired

Path parameter: id

Bodyapplication/jsonrequired

Request payload for auth-code POST.

client_idstringrequired

Client id of post /organization/{org_id}/create/auth-code request.

Example: "testClient123"
client_secretstringrequired

Client secret of post /organization/{org_id}/create/auth-code request.

Example: "SecretKey123"
curl -i -X POST \
  'https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/{org_id}/create/auth-code' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "client_id": "testClient123",
    "client_secret": "SecretKey123"
  }'

Responses

Auth code 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 Organization Auth Code" }

Update Organization

Request

Updates the details of an organization.

Security
ApiKeyAuth
Path
org_idstringrequired

Path parameter: id

Bodyapplication/jsonrequired

Request payload for update PUT.

namestringrequired

Name of put /organization/{org_id}/update request.

Example: "iVALT"
organization_codestringrequired

Organization code of put /organization/{org_id}/update request.

Example: "iVALT-1002wew"
has_geo_fencingintegerrequired

Has geo fencing of put /organization/{org_id}/update request.

Example: 1
is_activeintegerrequired

Is active of put /organization/{org_id}/update request.

Example: 0
number_geo_fencingintegerrequired

Number geo fencing of put /organization/{org_id}/update request.

Example: 5
curl -i -X PUT \
  'https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/{org_id}/update' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "iVALT",
    "organization_code": "iVALT-1002wew",
    "has_geo_fencing": 1,
    "is_active": 0,
    "number_geo_fencing": 5
  }'

Responses

Organization updated 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": "Update Organization" }