Skip to main content
API docs by Redocly

Welcome! (0)

Download OpenAPI specification:Download

The Great Owl: contact@cycloid.io URL: https://www.cycloid.io License: Cycloid @copyrights Terms of Service

This is the Cycloid's API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types available within our console.

Cycloid

Operation related to Cycloid's application.

getConfig

Get the Cycloid configuration.

Responses

Response samples

Content type
application/json
{}

getCountries

Get the Cycloid supported countries.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getStatus

Get the status of the Cycloid's services.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getServiceStatus

Get the status of the Cycloid's service. It uses 200 and 500 to also identify the status

path Parameters
service_status_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The canonical of the service you want to get the status from

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getAppVersion

Get the version of the Cycloid's API.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organizations

Operations for organizations.

getEvents

Retrieve the list of events which has been registered on the organization. The events to request can be filtered using Unix timestamps in milliseconds (begin and end timestamps range), the event type and severity; when more than one are applied then they are applied with a logical AND.

  • The Unix timestamps must always be specified, the rest of the filters are not mandatory.
Authorizations:
api_key
path Parameters
organization_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

query Parameters
begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

type
Array of strings
Items Enum: "Cycloid" "AWS" "Monitoring" "Custom"

Specify the types of the events to be requested. The returned events must have one of the specified types.

severity
Array of strings
Items Enum: "info" "warn" "err" "crit"

Specify the severities of the events to be requested. The returned events must have one of the specified severities.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

sendEvent

Send a event on the organization to be registered.

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

A canonical of an organization.

Request Body schema:
required

The information associated with the event to register.

type
required
string
Enum: "Cycloid" "AWS" "Monitoring" "Custom"

The type of the event

title
required
string non-empty

The title of the event.

message
required
string non-empty

The message associated to the event.

icon
string >= 3 characters
severity
required
string
Enum: "info" "warn" "err" "crit"

tThe severity associated to the event.

required
Array of objects (Key and value pair)

The list of tags associated to the event.

color
string [ 3 .. 20 ] characters [a-z]+

The HTML color associated to the event. The valid colors are the ones listed in the CSS 2 specification: https://www.w3.org/TR/CSS2/syndata.html#value-def-color. Only the keyword are accepted, the hexadecimal values are not valid.

Responses

Request samples

Content type
{
  • "type": "Cycloid",
  • "title": "string",
  • "message": "string",
  • "icon": "string",
  • "severity": "info",
  • "tags": [
    ],
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getEventsTags

Retrieve the list of tags and set of values for all the events of the organization.

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getAncestors

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

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getRepoBranches

Return all the branches of repository. If the repository is empty then an empty list will be returned.

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

A canonical of an organization.

query Parameters
credential_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

git_url
required
string^((/|~)[^/]*)+.(\.git)|(([\w\]+@[\w\.]+))(:(/...

Git URL to repository

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

canDo

Checks if the JWT can do the action

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

A canonical of an organization.

Request Body schema:
required

The information of the authorization

action
required
string
entity_canonicals
required
Array of strings

List of the canonicals to the Resource excluding the Organization

Responses

Request samples

Content type
{
  • "action": "string",
  • "entity_canonicals": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getOrgs

Get the organizations that the authenticated user has access.

Authorizations:
api_key
query Parameters
page_index
integer <uint32>
Default: 1

The page number to request. The first page is 1.

page_size
integer <uint32>
Default: 1000

The number of items at most which the response can have.

organization_name
string

Search by the organization's name

organization_created_at
integer <uint64>

Search by organization's creation date

order_by
string

Allows to order the list of items. Example usage: field_name:asc

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createOrg

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

Authorizations:
api_key
Request Body schema:
required

The information of the organization to create.

canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
name
required
string >= 3 characters

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getOrg

Get the information of the organization.

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteOrg

Delete the organization.

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateOrg

Update the information of the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the organization to update.

name
required
string >= 3 characters
quotas
boolean
can_children_create_appearance
boolean
mfa_enabled
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "quotas": true,
  • "can_children_create_appearance": true,
  • "mfa_enabled": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getSummary

Get the summary of the organization

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization teams

Operations for teams which belong to an organization.

getTeams

Get list of teams of the organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

The page number to request. The first page is 1.

page_size
integer <uint32>
Default: 1000

The number of items at most which the response can have.

team_name
string

Search by team's name

team_created_at
integer <uint64>

Search by team's creation date

team_description
string

Search by team's description

member_id
integer <uint32>

Search by entity's owner

order_by
string

Allows to order the list of items. Example usage: field_name:asc

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createTeam

Create a new team in the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the team to create.

canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
name
required
string >= 3 characters
owner
string

User canonical that owns this team. If omitted then the person creating this team will be assigned as owner. When a user is the owner of a team it has all the permissions on it.

roles_canonical
required
Array of strings[^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$]

The roles to be assigned to a team.

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "owner": "string",
  • "roles_canonical": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getTeam

Get the information of a team of the organization.

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

A canonical of an organization.

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a team.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteTeam

Delete a team of the organization.

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

A canonical of an organization.

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a team.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateTeam

Update the information of a team of the organization.

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

A canonical of an organization.

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a team.

Request Body schema:
required

The information of the team to update.

canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
name
required
string >= 3 characters
owner
string

User canonical that owns this team. Only the owner or an organization admin can update this field. When a user is the owner of a team it has all the permission on it.

roles_canonical
required
Array of strings[^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$]

The roles to be re-assigned to a team.

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "owner": "string",
  • "roles_canonical": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization projects

Operations for projects which belong to an organization.

getProjects

Get list of projects of the organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

The page number to request. The first page is 1.

page_size
integer <uint32>
Default: 1000

The number of items at most which the response can have.

project_name
string

Search by project's name

project_created_at
integer <uint64>

Search by project's creation date

project_description
string

Search by project's description

project_config_repository_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Search by project's config repository's canonical

service_catalog_source_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Service Catalog Sources canonical

member_id
integer <uint32>

Search by entity's owner

order_by
string

Allows to order the list of items. Example usage: field_name:asc

favorite
boolean

Flag to retrieve favorite data from the members favorite list.

environment_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A list of environments' canonical to filter from

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createProject

Create a new project with envs and pipelines in the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the project to create and optionally its configuration inputs. If the configuration inputs are not sent the project configuration is not generated and should be generated separately.

canonical
string [ 1 .. 100 ] characters (^[a-z0-9]+(([a-z0-9\-_]+)?[a-z0-9]+)?$)
name
required
string non-empty
service_catalog_ref
required
string

It's the ref of the Service Catalog, like 'cycloidio:stack-magento'

description
string

A description regarding the project to help identify/remember details, implementation, purpose, etc.

owner
string

User canonical that owns this project. If omitted then the person creating this project will be assigned as owner. When a user is the owner of a project it has all the permissions on it.

Array of objects (Create Pipeline) non-empty

Each instance should include passed_config if no inputs are sent on project creation, otherwise it will be inferred internally.

config_repository_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
team_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Is only required when the using Quotas, it'll link the Project to the Team

Array of objects (Forms input)

The variables set within a form with the corresponding environment canonical and use case

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "service_catalog_ref": "string",
  • "description": "string",
  • "owner": "string",
  • "pipelines": [
    ],
  • "config_repository_canonical": "string",
  • "team_canonical": "string",
  • "inputs": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

createEnvironment

Create a new environment with provider, icon and color in a project

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Request Body schema:
required

The canonical of the environment to create and its configuration.

canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:[\da-zA-Z\-._]+[\da-zA-Z]|[\da...
use_case
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
cloud_provider_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
Array of objects (Create Pipeline) non-empty

Each instance should include passed_config if no inputs are sent on environment creation, otherwise it will be inferred internally.

Array of objects (Forms input)

The variables set within a form with the corresponding environment canonical and use case

color
string <= 64 characters
icon
string <= 64 characters

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "use_case": "string",
  • "cloud_provider_canonical": "string",
  • "pipelines": [
    ],
  • "inputs": [
    ],
  • "color": "string",
  • "icon": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteEnvironment

Delete a project environment.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateEnvironment

Update a project environment of the organization.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Request Body schema:
required

The canonical of the environment to update and its configuration.

use_case
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
cloud_provider_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
Array of objects (Forms input)

The variables set within a form with the corresponding environment canonical and use case

color
string <= 64 characters
icon
string <= 64 characters

Responses

Request samples

Content type
{
  • "use_case": "string",
  • "cloud_provider_canonical": "string",
  • "inputs": [
    ],
  • "color": "string",
  • "icon": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getProjectConfig

Fetch the current project's environment's configuration.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

createProjectFavorite

Add a new project in the user favorites list.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

deleteProjectFavorite

Remove a project from the user favorites list.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getProject

Get a project of the organization.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteProject

Delete a project of the organization.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateProject

Update the information of a project of the organization. If the project has some information on the fields which aren't required and they are not sent or set to their default values, which depend of their types, the information will be removed.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Request Body schema:
required

The information of the project to update.

name
required
string non-empty
description
string
Array of objects (NewEnvironment) >= 0 items
service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

It's the ref of the Service Catalog, like 'cycloidio:stack-magento'

owner
string

User canonical that owns this project. Only the owner or an organization admin can update such a field. When a user is the owner of a project it has all the permission on it.

cloud_provider
string
Enum: "aws" "google" "azurerm" "flexibleengine" "openstack"

The cloud provider canonical that this project is using - between the supported ones.

config_repository_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The config_repository_canonical points to new Config Repository the project will be using. If this value is filled and it's different from the current one, the whole project will be migrated to new CR, meaning configuration files will also be moved. If the project didn't have config_repository_canonical set, this action will only attach the project to the CR, it won't create/move any files. In order to be sure everything works, make sure the config_repository_canonical is pointing at the CR with the same git repository that was used during project creation. Although the config_repository_canonical is not marked as required, it's actually required for projects that are already using CR. This field not being required is only for compatibility with older projects, which are not having CR yet.

Array of objects (Forms input)

The variables set within a form with the corresponding environment canonical and use case

updated_at
required
integer <uint64> >= 0

This will be used to assert that the Project is in it's last updated form because if not we could have inconsistencies with the environments. The format is in seconds, basically UNIX format.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "environments": [
    ],
  • "service_catalog_ref": "string",
  • "owner": "string",
  • "cloud_provider": "aws",
  • "config_repository_canonical": "string",
  • "inputs": [
    ],
  • "updated_at": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization members

Operations for members of an organization.

getOrgMembers

Get the members of an organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

The page number to request. The first page is 1.

page_size
integer <uint32>
Default: 1000

The number of items at most which the response can have.

invitation_state
string
Enum: "accepted" "pending" "declined"

Search by Invitation's state

user_given_name
string

Search by the user's given name

user_family_name
string

Search by the user's family name

role_name
string

Search by the role's name

user_canonical
string

Search by the user canonical

user_created_at
integer <uint64>

Search by user creation date

member_created_at
integer <uint64>

Search by member joining date

order_by
string

Allows to order the list of items. Example usage: field_name:asc

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

inviteUserToOrgMember

Invite a user to be a member of the organization.

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

A canonical of an organization.

Request Body schema:
required

The user's member invitation.

email
required
string <email>

Invite user by email

role_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The role of the member.

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "role_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getOrgMember

Get the information of a member of the organization.

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

A canonical of an organization.

member_id
required
integer <uint32>

A member id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateOrgMember

Update member of the organization.

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

A canonical of an organization.

member_id
required
integer <uint32>

A member id

Request Body schema:
required

The member information to be updated.

role_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The role of the member.

Responses

Request samples

Content type
{
  • "role_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

removeOrgMember

Remove a member of the organization.

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

A canonical of an organization.

member_id
required
integer <uint32>

A member id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

resendMemberInvitation

Resend the email containing the verification token to accept the member Invitation.

path Parameters
organization_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

member_id
required
integer <uint32>

A member id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getPendingMemberInvitation

Get the email address used for the pending member invitation

path Parameters
verification_token
required
string >= 5 characters

A token for verifying emails, invitations, etc.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

User

Operations for the authenticated user.

emailVerificationResend

Re-send the verification user's email to the indicated address.

Request Body schema:
required

The email address to re-send the verification email. This endpoint doesn't return any error status code if the email doesn't exist nor it's already verified for avoiding that an attacker could find registered users email address.

email
required
string <email>

Responses

Request samples

Content type
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

emailVerification

Verify that the email address is own by the user.

path Parameters
verification_token
required
string >= 5 characters

A token for verifying emails, invitations, etc.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

emailAuthenticationVerification

Verify that the email address is own by the user.

path Parameters
authentication_token
required
string >= 5 characters

A token for authenticating login vie email

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateUserGuide

Update user's guide progress.

Request Body schema:

The guide's progress JSON schema

object (User guide JSON schema)

The user's guide progress JSON schema

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

login

Authenticate a user and return a new JWT token.

Request Body schema:
required

The user content

[ 2 .. 3 ] properties
email
string <email>
username
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
password
required
string <password> >= 8 characters
organization_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Responses

Request samples

Content type
{
  • "password": "pa$$word",
  • "email": "user@example.com",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getOAuthUser

Used to know if a user from the platform exists on that 'social_type'. If it exists we'll return the JWT 'token', if it does not we'll return the data of that user on the 'user' so it can be confirmed and created

path Parameters
social_type
required
string
Enum: "azuread" "saml2" "google" "github"

The OAuth Social type

query Parameters
oauth_code
required
string

The OAuth code returned form the Social Provider

Responses

Response samples

Content type
application/json
{}

createOAuthUser

Create a user from the OAuth 'social_type'

path Parameters
social_type
required
string
Enum: "azuread" "saml2" "google" "github"

The OAuth Social type

Request Body schema:
required

The user content

given_name
required
string
family_name
string
email
required
string <email>
username
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
picture_url
string <uri>
social_id
required
string
invitation_token
string >= 5 characters

The field is used when a user signup from an invitation to an organization. Giving the token, the created user will be automatically added to the organization.

country_code
string^[A-Z]{2}$

Code of a country the user is from

locale
string
Enum: "en" "fr" "es"

User's preferred language

Responses

Request samples

Content type
{
  • "given_name": "string",
  • "family_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "picture_url": "http://example.com",
  • "social_id": "string",
  • "invitation_token": "string",
  • "country_code": "string",
  • "locale": "en"
}

Response samples

Content type
application/json
{
  • "data": {