Overview
This set of API calls support the configuration of an application.
The available API calls are:
- Get ApplicationConfigs for an application
- Create or Replace ApplicationConfigs for an application
- Update ApplicationConfigs for an application
- Delete ApplicationConfigs for an application
- Get Available ApplicationConfigs
Get ApplicationConfigs for an application#
This API call retrieves all the configurations for an application.
Endpoint#
GET /passportsvc/api/v1/apps/{appId}/configs Request#
Path parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
appId | String | The application's ID. | Required |
Response#
Response codes#
| Code | Description |
|---|---|
200 | Success |
404 | Not Found |
Body#
{ "usergroups.limit": "5", "workspaces.limit": "3"}Create or Replace ApplicationConfigs for an application#
This API call replaces all configurations. If the configuration does not exist, it will create one. Returns a 400 Bad Request error for an unknown configuration.
Endpoint#
PUT /passportsvc/api/v1/apps/{appId}/configs Request#
Path parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
appId | String | The application's ID. | Required |
Response#
Response codes#
| Code | Description |
|---|---|
200 | Created |
404 | Not Found |
{ "usergroups.limit": "5", "workspaces.limit": "3"}Update ApplicationConfigs for an application#
This API call 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.
Endpoint#
PATCH /passportsvc/api/v1/apps/{appId}/configs Request#
Path parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
appId | String | The application's ID. | Required |
Response#
Response codes#
| Code | Description |
|---|---|
200 | Success |
404 | Not Found |
{ "usergroups.limit": "3", "workspaces.limit": "5"}Delete ApplicationConfigs for an application#
This API call clears all configurations for an application.
Endpoint#
DELETE /passportsvc/api/v1/apps/{appId}/configs Request#
Path parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
appId | String | The application's ID. | Required |
Response#
Response codes#
| Code | Description |
|---|---|
204 | No Content |
404 | Not Found |
Get Available ApplicationConfigs#
Endpoint#
GET /passportsvc/api/v1/apps/configs Request#
Path parameters#
Response#
Response codes#
| Code | Description |
|---|---|
200 | Success |
Body#
[ { "key": "usergroups.limit", "displayText": "Max number of usergroups allowed" }, { "key": "workspaces.limit", "displayText": "Max number of workspaces allowed" }]