Get the organizations that the authenticated user has access.
| page_index | integer <uint32> Default: 1 The page number to request. The first page is 1. |
| page_size | integer <uint32> Default: 10 The number of items at most which the response can have. |
List of the organizations which authenticated user has access.
All the custom errors that are generated from the Cycloid API
The response sent when an unexpected error happened, as known as an internal server error.
Create a new organization, making the authenticated user the owner of it.
The information of the organization to create.
| canonical required | string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$ |
| name required | string >= 3 characters |
Organization created. The body contains the information of the new created organization.
The request has a body but it doesn't have a Content-Length header.
All the custom errors that are generated from the Cycloid API
The response sent when an unexpected error happened, as known as an internal server error.
Get the information of the organization.
| organization_canonical required | string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$ A canonical of an organization. |
The information of the organization which has the specified ID.
The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.
The response sent when any of the entities present in the path is not found.
The response sent when an unexpected error happened, as known as an internal server error.
Delete the organization.
| organization_canonical required | string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$ A canonical of an organization. |
Organization has been deleted.
The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.
The response sent when any of the entities present in the path is not found.
The response sent when an unexpected error happened, as known as an internal server error.
Update the information of the organization.
| organization_canonical required | string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$ A canonical of an organization. |
The information of the organization to update.
| canonical required | string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$ |
| name required | string >= 3 characters |
| events | object Contains all the information related with the events of the oganization. When the property is omitted, the data is deleted if any exists before the udpate. The supported backend engines for the events are:
|
Organization updated. The body contains information of the updated organization.
The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.
The response sent when any of the entities present in the path is not found.
The request has a body but it doesn't have a Content-Length header.
All the custom errors that are generated from the Cycloid API
The response sent when an unexpected error happened, as known as an internal server error.
Get all the ancestors between the Organization and the User with the shortest path.
| organization_canonical required | string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$ A canonical of an organization. |
Get all the ancestors between the Organization and the User with the shortest path. 0 index is the parent and n is the searched child
The user cannot be authenticated with the credentials which she/he has used.
The response sent when an unexpected error happened, as known as an internal server error.