kitter (1.0.0)

Download OpenAPI specification:Download

kitter REST API specification

Authentication

authorization

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

domains

Lists all the provisioned domains.

Returns the list of domains already provisioned into the system. If a parameter is given, the list is filtered to those domains matching the parameter.

Authorizations:
query Parameters
name
string

Domain name

Responses

Response samples

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

Create a Domain

Authorizations:
Request Body schema: application/json

The Domain creation request

object (DomainStruct)

The definition of a domain

Responses

Request samples

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

Response samples

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

Deletes a Domain

Authorizations:
path Parameters
id
required
string

Domain ID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Updates a Domain

Authorizations:
path Parameters
id
required
string

Domain ID

Request Body schema: application/json

The Domain update request

domain
string

Domain name

enable_anonymous
boolean

Are anonymous users supported?

origins
Array of strings

List of valid origins

parent
string

Parent domain name

object (DomainServicesStruct)

The configuration of the domain's enabled sevices

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "enable_anonymous": true,
  • "origins": [
    ],
  • "parent": "string",
  • "services": {
    }
}

Response samples

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

users

Lists all the provisioned users.

Returns the list of users already provisioned into the system. If a parameter is given, the list is filtered to those users matching the parameter.

Authorizations:
query Parameters
phone_number
string

Phone number

domain
string

Domain name

email
string

Email

username
string

Username

Responses

Response samples

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

Provision a User

If given, related SIP Mapping will be provisioned as well.

Authorizations:
Request Body schema: application/json

The User creation request

object (CreateUserStruct)

The definition of a user

Responses

Request samples

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

Response samples

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

Deletes a User

Authorizations:
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Updates a User

Authorizations:
path Parameters
id
required
string
Request Body schema: application/json

The User data to modify

object (UserAttributesPatchStruct)

Definition of user's attributes patch

email
string

User's email

enabled
boolean
Default: true

Whether the user is enabled or not

first_name
string

User's first name

id
string

User's ID

last_name
string

User's last name

username
string

Desired user's name

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "email": "string",
  • "enabled": true,
  • "first_name": "string",
  • "id": "string",
  • "last_name": "string",
  • "username": "string"
}

Response samples

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

healthChecker

Check liveness

Check liveness status for a service

Responses

Check readiness

Check readiness status for a service

Responses