System Administrator API

Tenant Management API

The System Tenant API bundle is used to perform tenant management operations. To use these APIs, you must have:

• A valid System Admin API key

• A valid System Tenant ID

The following operations can be performed:

• Create Tenant: Use this API to create a new tenant.

  URL: /SystemTenant/V1/Tenants/{systemTenantId}

  Parameters

  Parameter	Description
  systemTenantId	System Admin Tenant ID. Generate it using the SetupTenant Utility.
  tenantName	Name of the tenant.
  idpClientSecret	Tenant IDP client secret.
  tenantType	Tenant type. Specify whether the tenant is for IDPV usage or SWS.
  isExportKeys	Configure HSM in Export mode or Clone mode. Set true for Export mode.
  isSksMode	Configure the tenant in SKS mode.
  isAutoCardCreationEnabled	Enable automatic smart card creation. If a user does not have a smart card, one will be created at login.
  isAutoRefreshSigningKeyEnabled	Enable automatic refresh of signing keys. Updates keys automatically if changed at the IDP end.
  isOfflineFallbackEnabled	Enable offline smart card fallback feature.
  isAutoOfflineBundleDownloadEnabled	Enable automatic offline bundle download.
  X-IDPrimeVirtual-IsIdpClientSecretEncrypted	Set true to encrypt the tenant secret using the System Tenant public key.
  idpConfigFilePath	Path to the IDP configuration file.
  tokenPolicies	Token policies for the tenant.
  swsConfigFilePath	Path to the SWS configuration file.

• Update Tenant: Use this API to update existing tenant details.

  URL: /SystemTenant/V1/Tenants/{systemTenantId}

• List Tenants: Use this API to retrieve a list of configured tenants.

  URL: /SystemTenant/V1/Tenants/{systemTenantId}/TenantList

  Sample Response

  {
  
      "tenantListForAdmin": [
      {
      "tenantId": "string",
      "tenantName": "string",
      "tenantType": "string",
      "idpProvider": "string",
      "tenantStatus": "string"
  }
  ]
  }
  

• Get Tenant Details: Use the following APIs to retrieve tenant details.

  • Basic Tenant Details

    URL: /SystemTenant/V1/Tenants/{tenantId}

  • Complete Tenant Configuration

    URL: /SystemTenant/V{version}/Tenants/{tenantId}/ClientConfig

  Note

  These two APIs are publicly accessible and do not require authentication.

User Statistics API

The User Statistics APIs provide statistical details about users. The following filters are available:

• Active Users: Retrieves a list of active users.

  URL: /IDPrimeVirtual/V1/Tenants/{tenantId}/statistics/activeUsers

• Not Logged-In Users: Retrieves a list of users who have not logged in for a while.

  URL: /IDPrimeVirtual/V1/Tenants/{tenantId}/statistics/notLoggedInUser

• User Data: Retrieves detailed user information.

  URL: /IDPrimeVirtual/V1/Tenants/{tenantId}/statistics/data