Error
A valid request URL is required to generate request examples{
"refresh_token": "refresh_token",
"jwt_token": "jwt_token",
"user": {
"organisation_id": "organisation_id",
"role": null,
"projects": [
{
"role": "Developer",
"project_id": "project_id",
"default_project": true,
"project_name": "project_name"
},
{
"role": "Developer",
"project_id": "project_id",
"default_project": true,
"project_name": "project_name"
}
],
"name": "name",
"organisation": "organisation",
"id": "id",
"email": "email",
"username": "username"
}
}{
"id": "<string>",
"kind": "<string>",
"href": "<string>",
"code": "<string>",
"reason": "<string>",
"operation_id": "<string>",
"details": {}
}{
"id": "<string>",
"kind": "<string>",
"href": "<string>",
"code": "<string>",
"reason": "<string>",
"operation_id": "<string>",
"details": {}
}{
"id": "<string>",
"kind": "<string>",
"href": "<string>",
"code": "<string>",
"reason": "<string>",
"operation_id": "<string>",
"details": {}
}Authentication and users
Create new user
Create a new user
POST
/
api
/
v1
/
user-signup
Error
A valid request URL is required to generate request examples{
"refresh_token": "refresh_token",
"jwt_token": "jwt_token",
"user": {
"organisation_id": "organisation_id",
"role": null,
"projects": [
{
"role": "Developer",
"project_id": "project_id",
"default_project": true,
"project_name": "project_name"
},
{
"role": "Developer",
"project_id": "project_id",
"default_project": true,
"project_name": "project_name"
}
],
"name": "name",
"organisation": "organisation",
"id": "id",
"email": "email",
"username": "username"
}
}{
"id": "<string>",
"kind": "<string>",
"href": "<string>",
"code": "<string>",
"reason": "<string>",
"operation_id": "<string>",
"details": {}
}{
"id": "<string>",
"kind": "<string>",
"href": "<string>",
"code": "<string>",
"reason": "<string>",
"operation_id": "<string>",
"details": {}
}{
"id": "<string>",
"kind": "<string>",
"href": "<string>",
"code": "<string>",
"reason": "<string>",
"operation_id": "<string>",
"details": {}
}Body
application/json
User's name
User's email address
Users desired password
Show child attributes
Show child attributes
Example:
{
"updated_at": "2000-01-23T04:56:07.000Z",
"is_platform": true,
"name": "name",
"domains": [
{ "fqdn": "fqdn", "id": "id" },
{ "fqdn": "fqdn", "id": "id" }
],
"created_at": "2000-01-23T04:56:07.000Z",
"id": "id"
}
Optional invite token for joining an existing organization
Response
User created successfully
Show child attributes
Show child attributes
Example:
{
"organisation_id": "organisation_id",
"role": null,
"projects": [
{
"role": "Developer",
"project_id": "project_id",
"default_project": true,
"project_name": "project_name"
},
{
"role": "Developer",
"project_id": "project_id",
"default_project": true,
"project_name": "project_name"
}
],
"name": "name",
"organisation": "organisation",
"id": "id",
"email": "email",
"username": "username"
}
JWT token for the authenticated user
Refresh token for obtaining new access tokens
⌘I