Skip to main content
Version: v5.2

Passport Service Organization Configuration

Overview​

With the release of Platform version 4.5, the Passport Service now supports the configuration of multiple parameters for an organization. These parameters can be modified by a platform manager who has edit access to the organization.

Initial configuration parameters​

For each organization, consider these two configuration parameters:

  • applications.limit - Sets the maximum number of applications that can be created in an organization.
  • workspaces.limit - Sets the maximum number of workspaces that can be created in an organization.
  • usergroups.limit - Sets the maximum number of user groups that can be created in an organization.

Sample Configuration Object​

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

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

New API Calls​

Several new API calls are available to support the configuration of an organization.

API CallDescriptionPermission required
GET /organizations/configs Retrieves a list of all the configuration parameters available for organizations. Returns a static response, used to provide help information.READ permission for the organization.
GET /organizations/:id/configs Retrieves all the configurations for a given organization.READ permission for the organization.
PUT /organizations/:id/configs Replaces all configurations for a given organization. If the configuration does not exist, it will create one. Returns a 400 Bad Request error for an unknown configuration.EDIT permission for the organization.
PATCH /orgnanizations/:id/configs Updates only the given configuration for an organization. If the configuration does not exist, it will create one. Returns a 400 Bad Request error for an unknown configuration.EDIT permission for the organization.
DELETE /organizations/:id/configs Clears all configurations for a given organization.DELETE permission for the application

API Reference​

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