Plugin Settings

Bulk update plugin settings

PATCH
http://localhost:3000/api/plugins/{pluginId}/settings

Body

application/json
pluginIdstringrequired

Plugin ID

pluginTenantIdstring

Plugin Tenant ID

settingsArray<string>required

Array of setting updates

Example
[
  {
    "key": "api_key",
    "value": "new_value"
  }
]

Parameters

pluginIdstring<uuid>requiredpath

Plugin ID

Response

200OKArray<PluginSetting>

Plugin settings updated successfully

Response fields application/json
Array<PluginSetting>
Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
keystringrequired

Setting key/name

valuestringrequired

Setting value string

isRequiredbooleanrequired

Whether the setting is required

isEncryptedbooleanrequired

Whether the setting is encrypted/sensitive

descriptionstring

Setting description/help text

ordernumber

Display order for UI

validationRulesstring

Validation rules (JSON string)

dataTypestringstringnumberbooleanjsonfilerequired

Data type of the setting

defaultValuestring

Default value for the setting

pluginIdstringrequired

Plugin ID

pluginPlugin_1

Plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
thirdPartyIdstring
firstNamestring
lastNamestring
emailstring
phoneNumberstring
usernamestring
timeZonestring
timeFormatstring1224
hashstring
refreshTokenstring
imageUrlstring
preferredLanguagestringenbgherufreszhdeptitnlplar
preferredComponentLayoutstringCARDS_GRIDTABLE
uiPreferencesobject
codestring
codeExpireAtstring<date-time>
emailVerifiedAtstring<date-time>
lastLoginAtstring<date-time>
emailTokenstring
roleIdstring
imageIdstring
defaultTeamIdstring
lastTeamIdstring
defaultOrganizationIdstring
lastOrganizationIdstring
uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

pluginTenantIdstring

Plugin tenant ID for tenant-specific settings

pluginTenantPluginTenant_1

Plugin tenant

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
pluginIdstringrequired

Plugin ID

enabledbooleanrequired

Whether the plugin is enabled for this tenant

scopestringtenantorganizationuserrequired

Scope of the plugin (USER, ORGANIZATION, TENANT)

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
100
maxActiveUsersnumber

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

Example
50
currentInstallationsnumber0

Current number of installations

Example
25
currentActiveUsersnumber0

Current number of active users

Example
15
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
  }
}
approvedAtstring<date-time>

Timestamp when the plugin was approved for this tenant

isDataCompliantbooleantrue

Whether plugin data handling complies with tenant data policies

complianceCertificationsArray<string>

List of compliance certifications applicable to this tenant

Example
[
  "SOC2",
  "GDPR",
  "HIPAA"
]
approvedByIdstring

ID of the user who approved the plugin

pluginPlugin_1required

The plugin this configuration applies to

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
thirdPartyIdstring
firstNamestring
lastNamestring
emailstring
phoneNumberstring
usernamestring
timeZonestring
timeFormatstring1224
hashstring
refreshTokenstring
imageUrlstring
preferredLanguagestringenbgherufreszhdeptitnlplar
preferredComponentLayoutstringCARDS_GRIDTABLE
uiPreferencesobject
codestring
codeExpireAtstring<date-time>
emailVerifiedAtstring<date-time>
lastLoginAtstring<date-time>
emailTokenstring
roleIdstring
imageIdstring
defaultTeamIdstring
lastTeamIdstring
defaultOrganizationIdstring
lastOrganizationIdstring
uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

approvedByUser

User who approved the plugin for this tenant

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
thirdPartyIdstring
firstNamestring
lastNamestring
emailstring
phoneNumberstring
usernamestring
timeZonestring
timeFormatstring1224
hashstring
refreshTokenstring
imageUrlstring
preferredLanguagestringenbgherufreszhdeptitnlplar
preferredComponentLayoutstringCARDS_GRIDTABLE
uiPreferencesobject
codestring
codeExpireAtstring<date-time>
emailVerifiedAtstring<date-time>
lastLoginAtstring<date-time>
emailTokenstring
roleIdstring
imageIdstring
defaultTeamIdstring
lastTeamIdstring
defaultOrganizationIdstring
lastOrganizationIdstring
settingsArray<PluginSetting>

Plugin settings specific to this tenant

Same fields as PluginSetting

subscriptionsArray<PluginSubscription_1>

Active subscriptions for this plugin tenant

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
statusstringactivecancelledexpiredtrialpast_duesuspendedpendingrequired

Subscription status

scopestringtenantorganizationuserrequired

Subscription scope

startDatestring<date-time>required

Start date of subscription

endDatestring<date-time>

End date of subscription

trialEndDatestring<date-time>

Trial end date

autoRenewbooleanrequired

Whether auto-renewal is enabled

cancelledAtstring<date-time>

Cancellation date

cancellationReasonstring

Cancellation reason

metadataobject

Subscription metadata for additional data

externalSubscriptionIdstring

External subscription ID from payment provider

pluginIdstringrequired

Plugin ID

pluginTenantIdstringrequired

Plugin Tenant ID

planIdstring

Subscription plan ID

subscriberIdstring

Subscriber user ID for user-specific subscriptions

parentIdstring

Parent subscription ID for hierarchical subscriptions

parentPluginSubscription_1

Parent subscription (for subscriptions created through assignment)

Show child attributes
PluginSubscription_1
childrenArray<PluginSubscription_1>

Child subscriptions (user subscriptions created through assignment)

Same fields as pluginTenant.subscriptions

billingsArray<string>

Plugin billings for this subscription

allowedRolesArray<Role>

Roles explicitly allowed to access this plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
namestringSUPER_ADMINADMINDATA_ENTRYEMPLOYEECANDIDATEMANAGERVIEWERINTERVIEWERrequired
isSystembooleanfalse
allowedUsersArray<User>

Users explicitly allowed to access this plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
thirdPartyIdstring
firstNamestring
lastNamestring
emailstring
phoneNumberstring
usernamestring
timeZonestring
timeFormatstring1224
hashstring
refreshTokenstring
imageUrlstring
preferredLanguagestringenbgherufreszhdeptitnlplar
preferredComponentLayoutstringCARDS_GRIDTABLE
uiPreferencesobject
codestring
codeExpireAtstring<date-time>
emailVerifiedAtstring<date-time>
lastLoginAtstring<date-time>
emailTokenstring
roleIdstring
imageIdstring
defaultTeamIdstring
lastTeamIdstring
defaultOrganizationIdstring
lastOrganizationIdstring
deniedUsersArray<User>

Users explicitly denied access to this plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
thirdPartyIdstring
firstNamestring
lastNamestring
emailstring
phoneNumberstring
usernamestring
timeZonestring
timeFormatstring1224
hashstring
refreshTokenstring
imageUrlstring
preferredLanguagestringenbgherufreszhdeptitnlplar
preferredComponentLayoutstringCARDS_GRIDTABLE
uiPreferencesobject
codestring
codeExpireAtstring<date-time>
emailVerifiedAtstring<date-time>
lastLoginAtstring<date-time>
emailTokenstring
roleIdstring
imageIdstring
defaultTeamIdstring
lastTeamIdstring
defaultOrganizationIdstring
lastOrganizationIdstring
categoryIdstring

Plugin category ID for default category settings

categoryPluginCategory

Plugin category

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
namestringrequired

Category name

descriptionstring

Category description

slugstringrequired

Category slug for URL-friendly identification

colorstring

Category color for UI representation

iconstring

Category icon identifier

ordernumberrequired

Display order for sorting

metadataobject

Category metadata (JSON object)

parentIdstring

Parent category ID

parentPluginCategory

Parent category

Show child attributes
PluginCategory
childrenArray<PluginCategory>

Child categories

pluginsArray<string>

Plugins in this category

settingsArray<string>

Default settings for plugins in this category

updatedByUser

User who last updated this setting

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
thirdPartyIdstring
firstNamestring
lastNamestring
emailstring
phoneNumberstring
usernamestring
timeZonestring
timeFormatstring1224
hashstring
refreshTokenstring
imageUrlstring
preferredLanguagestringenbgherufreszhdeptitnlplar
preferredComponentLayoutstringCARDS_GRIDTABLE
uiPreferencesobject
codestring
codeExpireAtstring<date-time>
emailVerifiedAtstring<date-time>
lastLoginAtstring<date-time>
emailTokenstring
roleIdstring
imageIdstring
defaultTeamIdstring
lastTeamIdstring
defaultOrganizationIdstring
lastOrganizationIdstring
updatedByIdstring

ID of the user who last updated this setting

Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey
Stack OverflowWebsiteDemo
↑↓ navigate↵ selectesc close