Cycloid.io (0)

Download OpenAPI specification:Download

Authentication

api_key

The API authorization is done with JWT tokens

Security scheme type: API Key
Header parameter name: Authorization

Organizations

Operations for organizations.

getOrgs

Get the organizations that the authenticated user has access.

Authorizations:
query Parameters
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.

Responses

200

List of the organizations which authenticated user has access.

422

All the custom errors that are generated from the Cycloid API

default

The response sent when an unexpected error happened, as known as an internal server error.

get /organizations
https://http-api-stoplight.cycloid.io/organizations

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "data":
    [
    ],
  • "pagination":
    {
    }
}

createOrg

Create a new organization, making the authenticated user the owner of it.

Authorizations:
Request Body schema: application/vnd.cycloid.io.v1+json

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

Responses

200

Organization created. The body contains the information of the new created organization.

411

The request has a body but it doesn't have a Content-Length header.

422

All the custom errors that are generated from the Cycloid API

default

The response sent when an unexpected error happened, as known as an internal server error.

post /organizations
https://http-api-stoplight.cycloid.io/organizations

Request samples

Content type
application/vnd.cycloid.io.v1+json
Copy
Expand all Collapse all
{
  • "canonical": "string",
  • "name": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

getOrg

Get the information of the organization.

Authorizations:
path Parameters
organization_canonical
required
string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

Responses

200

The information of the organization which has the specified ID.

403

The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.

404

The response sent when any of the entities present in the path is not found.

default

The response sent when an unexpected error happened, as known as an internal server error.

get /organizations/{organization_canonical}
https://http-api-stoplight.cycloid.io/organizations/{organization_canonical}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

deleteOrg

Delete the organization.

Authorizations:
path Parameters
organization_canonical
required
string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

Responses

204

Organization has been deleted.

403

The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.

404

The response sent when any of the entities present in the path is not found.

default

The response sent when an unexpected error happened, as known as an internal server error.

delete /organizations/{organization_canonical}
https://http-api-stoplight.cycloid.io/organizations/{organization_canonical}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "errors":
    [
    ]
}

updateOrg

Update the information of the organization.

Authorizations:
path Parameters
organization_canonical
required
string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

Request Body schema: application/vnd.cycloid.io.v1+json

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:

  • AWS_CLOUD_WATCH_LOGS

Responses

200

Organization updated. The body contains information of the updated organization.

403

The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.

404

The response sent when any of the entities present in the path is not found.

411

The request has a body but it doesn't have a Content-Length header.

422

All the custom errors that are generated from the Cycloid API

default

The response sent when an unexpected error happened, as known as an internal server error.

put /organizations/{organization_canonical}
https://http-api-stoplight.cycloid.io/organizations/{organization_canonical}

Request samples

Content type
application/vnd.cycloid.io.v1+json
Copy
Expand all Collapse all
{
  • "canonical": "string",
  • "name": "string",
  • "events":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

getOrgAncestors

Get all the ancestors between the Organization and the User with the shortest path.

Authorizations:
path Parameters
organization_canonical
required
string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

Responses

200

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