Organization configurations
Overview
This set of API calls support the configuration of an organization.
The available API calls are:
- Get OrganizationConfigs for an Organization
- Create or Replace OrganizationConfigs for an Organization
- Update OrganizationConfigs for an Organization
- Delete OrganizationConfigs for an Organization
- Get Available OrganizationConfigs
Get OrganizationConfigs for an Organization
This API call retrieves all the configurations for a given organization.
Endpoint
GET /passportsvc/api/v1/organizations/{orgId}/configs
Request
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
orgId | String | The organization's ID. | Required |
Response
Response codes
| Code | Description |
|---|---|
200 | Success |
404 | Not Found |
Body
{
"applications.limit": "5",
"workspaces.limit": "3",
"usergroups.limit": "30"
}
Create or Replace OrganizationConfigs for an Organization
This API call 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.
Endpoint
PUT /passportsvc/api/v1/organizations/{orgId}/configs
Request
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
orgId | String | The organization's ID. | Required |
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
applications.limit | Number | Max Number of applications allowed in the organizations. | Optional |
workspaces.limit | Number | Max Number of workspaces allowed in the organizations. | Optional |
usergroups.limit | Number | Max Number of usergroups allowed in the organizations. | Optional |
Code example
{
"applications.limit": 1,
"workspaces1.limit": 2,
"usergrouos.limit":30
}
Response
Response codes
| Code | Description |
|---|---|
200 | Created |
404 | Not Found |
{
"applications.limit": "5",
"workspaces.limit": "3",
"usergroups.limit": "30"
}
Update OrganizationConfigs for an Organization
This API call 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.
Endpoint
PATCH /passportsvc/api/v1/organizations/{orgId}/configs
Request
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
orgId | String | The organization's ID. | Required |
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
applications.limit | Number | Max Number of applications allowed in the organizations. | Optional |
workspaces.limit | Number | Max Number of workspaces allowed in the organizations. | Optional |
usergroups.limit | Number | Max Number of usergroups allowed in the organizations. | Optional |
Code example
{
"applications.limit": 1,
"workspaces1.limit": 2
}
Response
Response codes
| Code | Description |
|---|---|
200 | Success |
404 | Not Found |
{
"applications.limit": 1,
"workspaces.limit": 2
}
Delete OrganizationConfigs for an Organization
This API call clears all configurations for a given organization.
Endpoint
DELETE /passportsvc/api/v1/organizations/{orgId}/configs
Request
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
orgId | String | The organization's ID. | Required |
Response
Response codes
| Code | Description |
|---|---|
204 | No Content |
404 | Not Found |
Get Available OrganizationConfigs
This API call retrieves a list of all the configuration parameters available for organizations. Returns a static response, used to provide help information.
Endpoint
GET /passportsvc/api/v1/organizations/configs
Request
Path parameters
None.
Response
Response codes
| Code | Description |
|---|---|
200 | Success |
Body
[
{
"key": "applications.limit",
"displayText": "Max number of applications allowed"
},
{
"key": "workspaces.limit",
"displayText": "Max number of workspaces allowed"
}
]