Create a new organization
POST/api/v1/organizations
Create a new organization. admin role is required to create an organization.
Request
Header Parameters
X-API-KEY stringrequired
API Key
- application/json
Body
required
Organization Request
name stringrequired
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 string
createdAt is the creation time of the organization.
id string
id is the unique identifier of the organization.
name string
name is the name of the organization.
orgNamespace string
orgNamespace is the organization namespace.
owner boolean
owner is the organization owner.
slug string
slug is the organization slug.
id string
message string
status string
{
"data": {
"createdAt": "string",
"id": "string",
"name": "string",
"orgNamespace": "string",
"owner": true,
"slug": "string"
},
"id": "string",
"message": "string",
"status": "string"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
error string
error_code string
{
"error": "string",
"error_code": "string"
}
User is not authorized to create organization
- application/json
- Schema
- Example (from schema)
Schema
error string
error_code string
{
"error": "string",
"error_code": "string"
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
error string
error_code string
{
"error": "string",
"error_code": "string"
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
error string
error_code string
{
"error": "string",
"error_code": "string"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
error string
error_code string
{
"error": "string",
"error_code": "string"
}
Loading...