Skip to main content
Version: v4.5

Passport Service Application Configuration

Overview#

With the release of Platform version 4.4, the Passport Service now supports the configuration of multiple parameters for an application. These parameters can be modified by users who have edit access to the application.

Initial configuration parameters#

For each application, first consider these two configuration parameters:

  • usergroups.limit - Sets the maximum number of usergroups that can be created in an application.
  • workspaces.limit - Sets the maximum number of workspaces that can be created in an application.

Sample Configuration Object#

Refer to the configuration file below as an example of setting the configuration parameters usergroups.limit and workspaces.limit.

{  "usergroups.limit": 3,  "workspaces.limit": 3}

New API Calls#

Several new API calls are available to support these new configuration features.

API CallDescriptionPermission required
GET /apps/:id/configs Retrieves all the configurations for an applicationREAD permission for the application.
PUT /apps/:id/configs Replaces all configurations. If the configuration does not exist, it will create one. Returns a 400 Bad Request error for an unknown configuration.EDIT permission for the application
PATCH /apps/:id/configs Updates only the given configuration. If the configuration does not exist, it will create one. Returns a 400 Bad Request error for an unknown configuration.EDIT permission for the application
DELETE /apps/:id/configs Clears all configurations for an application.DELETE permission for the application

API Reference#

To learn more about using these API calls, refer to the Application configurations page in the Passport Service Rest API reference guide.