Plugin Tenant Management

Update Plugin Tenant

PUT

http://localhost:3000/api/plugin-tenants/{id}

Updates an existing plugin tenant configuration

curl -X PUT 'http://localhost:3000/api/plugin-tenants/string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "pluginId": "string",
  "enabled": true,
  "scope": "tenant",
  "tenantId": "string",
  "organizationId": "string",
  "autoInstall": false,
  "requiresApproval": true,
  "isMandatory": false,
  "maxInstallations": 100,
  "maxActiveUsers": 50,
  "tenantConfiguration": {
    "branding": {
      "logo": "tenant-logo.png",
      "theme": "blue"
    },
    "features": {
      "advancedReporting": true
    },
    "limits": {
      "dailyUsage": 1000
    }
  },
  "preferences": {
    "defaultSettings": {
      "autoSave": true,
      "notifications": false
    },
    "uiCustomizations": {
      "hideAdvancedOptions": true
    }
  },
  "isDataCompliant": true,
  "complianceCertifications": [
    "SOC2",
    "GDPR",
    "HIPAA"
  ],
  "allowedRoleIds": [
    "string"
  ],
  "allowedUserIds": [
    "string"
  ],
  "deniedUserIds": [
    "string"
  ],
  "allowedRoles": [
    {}
  ],
  "allowedUsers": [
    {}
  ],
  "deniedUsers": [
    {}
  ]
}'

const body = `{
  "pluginId": "string",
  "enabled": true,
  "scope": "tenant",
  "tenantId": "string",
  "organizationId": "string",
  "autoInstall": false,
  "requiresApproval": true,
  "isMandatory": false,
  "maxInstallations": 100,
  "maxActiveUsers": 50,
  "tenantConfiguration": {
    "branding": {
      "logo": "tenant-logo.png",
      "theme": "blue"
    },
    "features": {
      "advancedReporting": true
    },
    "limits": {
      "dailyUsage": 1000
    }
  },
  "preferences": {
    "defaultSettings": {
      "autoSave": true,
      "notifications": false
    },
    "uiCustomizations": {
      "hideAdvancedOptions": true
    }
  },
  "isDataCompliant": true,
  "complianceCertifications": [
    "SOC2",
    "GDPR",
    "HIPAA"
  ],
  "allowedRoleIds": [
    "string"
  ],
  "allowedUserIds": [
    "string"
  ],
  "deniedUserIds": [
    "string"
  ],
  "allowedRoles": [
    {}
  ],
  "allowedUsers": [
    {}
  ],
  "deniedUsers": [
    {}
  ]
}`;

const response = await fetch('http://localhost:3000/api/plugin-tenants/string', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "pluginId": "string",
  "enabled": true,
  "scope": "tenant",
  "tenantId": "string",
  "organizationId": "string",
  "autoInstall": false,
  "requiresApproval": true,
  "isMandatory": false,
  "maxInstallations": 100,
  "maxActiveUsers": 50,
  "tenantConfiguration": {
    "branding": {
      "logo": "tenant-logo.png",
      "theme": "blue"
    },
    "features": {
      "advancedReporting": true
    },
    "limits": {
      "dailyUsage": 1000
    }
  },
  "preferences": {
    "defaultSettings": {
      "autoSave": true,
      "notifications": false
    },
    "uiCustomizations": {
      "hideAdvancedOptions": true
    }
  },
  "isDataCompliant": true,
  "complianceCertifications": [
    "SOC2",
    "GDPR",
    "HIPAA"
  ],
  "allowedRoleIds": [
    "string"
  ],
  "allowedUserIds": [
    "string"
  ],
  "deniedUserIds": [
    "string"
  ],
  "allowedRoles": [
    {}
  ],
  "allowedUsers": [
    {}
  ],
  "deniedUsers": [
    {}
  ]
}'''

response = requests.put(
    'http://localhost:3000/api/plugin-tenants/string',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "pluginId": "string",
  "enabled": true,
  "scope": "tenant",
  "tenantId": "string",
  "organizationId": "string",
  "autoInstall": false,
  "requiresApproval": true,
  "isMandatory": false,
  "maxInstallations": 100,
  "maxActiveUsers": 50,
  "tenantConfiguration": {
    "branding": {
      "logo": "tenant-logo.png",
      "theme": "blue"
    },
    "features": {
      "advancedReporting": true
    },
    "limits": {
      "dailyUsage": 1000
    }
  },
  "preferences": {
    "defaultSettings": {
      "autoSave": true,
      "notifications": false
    },
    "uiCustomizations": {
      "hideAdvancedOptions": true
    }
  },
  "isDataCompliant": true,
  "complianceCertifications": [
    "SOC2",
    "GDPR",
    "HIPAA"
  ],
  "allowedRoleIds": [
    "string"
  ],
  "allowedUserIds": [
    "string"
  ],
  "deniedUserIds": [
    "string"
  ],
  "allowedRoles": [
    {}
  ],
  "allowedUsers": [
    {}
  ],
  "deniedUsers": [
    {}
  ]
}

200

{}

Body

application/json

pluginIdstring

Plugin ID

enabledbooleantrue

Whether the plugin is enabled for this tenant

scopestringtenantorganizationuser

Scope of the plugin (USER, ORGANIZATION, TENANT)

tenantIdstring

Tenant ID

organizationIdstring

Organization ID

autoInstallbooleanfalse

Whether plugin can be installed automatically without user action

requiresApprovalbooleantrue

Whether plugin requires admin approval before installation

isMandatorybooleanfalse

Whether plugin is mandatory for all users in scope

maxInstallationsnumber

Maximum number of installations allowed (-1 for unlimited, null for no limit)

Example

maxActiveUsersnumber

Maximum number of active users allowed (-1 for unlimited, null for no limit)

Example

tenantConfigurationobject

Tenant-specific plugin configuration overrides

Example

{
  "branding": {
    "logo": "tenant-logo.png",
    "theme": "blue"
  },
  "features": {
    "advancedReporting": true
  },
  "limits": {
    "dailyUsage": 1000
  }
}

preferencesobject

Plugin preferences and UI customizations for this tenant

Example

{
  "defaultSettings": {
    "autoSave": true,
    "notifications": false
  },
  "uiCustomizations": {
    "hideAdvancedOptions": true
  }
}

isDataCompliantbooleantrue

Whether plugin data handling complies with tenant data policies

complianceCertificationsArray<string>

List of compliance certifications applicable to this tenant

Example

[
  "SOC2",
  "GDPR",
  "HIPAA"
]

allowedRoleIdsArray<string>

Array of role IDs explicitly allowed to access this plugin

allowedUserIdsArray<string>

Array of user IDs explicitly allowed to access this plugin

deniedUserIdsArray<string>

Array of user IDs explicitly denied access to this plugin

allowedRolesArray<object>

Array of roles explicitly allowed to access this plugin

allowedUsersArray<object>

Array of users explicitly allowed to access this plugin

deniedUsersArray<object>

Array of users explicitly denied access to this plugin

Parameters

idstringrequiredpath

Plugin Tenant ID

Response

200OKobject

Plugin tenant updated successfully

Response fields application/json

object

404Not Found

Plugin tenant not found

Stack Overflow Website Demo