Create an organization
POST/api/v1/organizations
Create an organization. admin role is required to create an organization.
Request
Header Parameters
APIKey
- application/json
Body
required
organization request
Possible values: non-empty
and <= 50 characters
name is the name of the organization. Every organization name should be unique. This must be a valid DNS name, and must be between 1 and 50 characters. This is a required field.
Responses
- 201
- 400
- 403
- 404
- 409
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
data
object
createdAt is the creation time of the organization.
id is the unique identifier of the organization.
name is the name of the organization.
orgNamespace is the organization namespace.
owner is the organization owner.
slug is the organization slug.
{
"data": {
"createdAt": "string",
"id": "string",
"name": "string",
"orgNamespace": "string",
"owner": true,
"slug": "string"
},
"id": "string",
"message": "string",
"status": "string"
}
invalid request
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"error_code": "string"
}
user is not authorized to create organization
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"error_code": "string"
}
organization not found
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"error_code": "string"
}
organization already exists
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"error_code": "string"
}
internal server error
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"error_code": "string"
}