Organizations
An organization is a global logical grouping of environments, distributions, platforms and applications. Users may have access to an organization if they are added to at least one of organization’s groups. Settings may be associated to an organization, in particular for template rendering.
Representation
The following elements are defined as part of an organization representation:
- name: The name of the organization. Cannot be null. Must be unique ComodIT-wide.
- description: A human friendly description of the organization.
- version: A version number managed by the system. This field is read-only and is incremented on each change made to the resource.
- environments: The name of the environments defined in this organization. This field is read-only.
- groups: The list of groups of this organization. This field is read-only.
- settings: A list of settings defined for this organization. This field is read-only.
- access: Access credentials that may be used during a [gPXE provisioning][gPXE]. This field is read-only.
Example
{
"name": "Guardis Test",
"description": "Test Guardis Organization",
"version": 1,
"environments": [
"Test Environment"
],
"groups": [
"users",
"admin"
],
"settings": [],
"access": {
"accessKey": "E83AE640B07211E18D8A5BD37F000001",
"secretKey": "hJBWUAnbuN2O0ogxJ5PXBXJwo1BMU5dl"
}
}
Methods
Collection
/organizations
- GET: returns all the organizations the authenticated user has access to (i.e. the user is in at least one group of each organization).
- POST: adds a new organization. Initially, organization’s creator is part of ‘admin’ group.
Entity
/organizations/{org_name}
- GET: returns an existing organization.
- PUT: updates an existing organization (read-only fields are ignored).
- DELETE: deletes an organization.
Other
List hosts
/organizations/{org_name}/hosts
- GET: returns the list of hosts in this organization.
Access credentials
/organizations/{org_name}/access
- GET: returns access data (see representation).
- POST: resets access data; only secretKey field is updated.
Audit
/organizations/{org_name}/audit
- GET: provides all audit logs for this organization.
Sub-collections
2016 © ComodIT. All Rights Reserved. Privacy Policy | Terms of Service
