Skip to content
API References
/
Admin Portal API
/
/
Organization Auth0 API Cr...

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
Admin_Apis.json
Admin_Apis.yaml
Overview
URL
https://ivalt.com/support
IVALT Support
support@ivalt.com
License
Proprietary and Confidential
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

Create Organization

Request

Create a new organization

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Request payload for create POST.

namestringrequired

Name of post /organization/create request.

organization_codestringrequired

Organization code of post /organization/create request.

Example: "ivalt-labs"
has_geo_fencingintegerrequired

Has geo fencing of post /organization/create request.

Example: 1
number_geo_fencingintegerrequired

Number geo fencing of post /organization/create request.

Example: 5
is_activeintegerrequired

Is active of post /organization/create request.

Example: 1
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/create \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "local testing",
    "organization_code": "test",
    "has_geo_fencing": 0,
    "number_geo_fencing": 5,
    "is_active": 0
  }'

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"
}

Organization Auth0 API Credentials

Request

Save Auth0 API credentials for an organization

Security
ApiKeyAuth
Path
org_idintegerrequired

Org Id provided via path.

Example: 32
Bodyapplication/jsonrequired

Request payload for auth0-api-cred POST.

domainstringrequired

Domain of post /organization/{org_id}/auth0-api-creds request.

client_idstringrequired

Client id of post /organization/{org_id}/auth0-api-creds request.

client_secretstringrequired

Client secret of post /organization/{org_id}/auth0-api-creds request.

grant_typestringrequired

Grant type of post /organization/{org_id}/auth0-api-creds request.

audiencestringrequired

Audience of post /organization/{org_id}/auth0-api-creds request.

curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/32/auth0-api-creds \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "domain": "check",
    "client_id": "test",
    "client_secret": "secret",
    "grant_type": "client_credentials",
    "audience": "https://example.com"
  }'

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"
}

Create Onboarding Organization

Request

Create an onboarding organization

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Request payload for onboarding POST.

organization_namestringrequired

Organization name of post /organization/create/onboarding request.

organization_codestringrequired

Organization code of post /organization/create/onboarding request.

Example: "ivalt-labs"
curl -i -X POST \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/create/onboarding \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "organization_name": "Testing",
    "organization_code": "test"
  }'

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"
}