kitter (1.0.0)

Download OpenAPI specification:Download

kitter REST API specification

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:

authorization

query Parameters

name	string Domain name

Responses

Response samples

200
401

Content type

application/json

{"domains": [{"domain": "string",
"enable_anonymous": true,
"id": "string",
"origins": ["string"
],
"parent": "string",
"services": {"callcontrol": ["string"
],
"contacts": ["string"
],
"datapipe": ["string"
],
"filesharing": ["string"
],
"filetransfer": ["string"
],
"forms": ["string"
],
"login": ["string"
],
"meetings": ["string"
],
"oauth2client": ["string"
],
"presence": ["string"
],
"remotelog": ["string"
],
"usersettings": ["string"
],
"usersgroup": ["string"
],
"xmpp": ["string"
]
}
}
]
}

Create a Domain

Authorizations:

authorization

Request Body schema: application/json

The Domain creation request

object (DomainStruct)

The definition of a domain

Responses

Request samples

Payload

Content type

application/json

{"domain": {"domain": "string",
"enable_anonymous": true,
"id": "string",
"origins": ["string"
],
"parent": "string",
"services": {"callcontrol": ["string"
],
"contacts": ["string"
],
"datapipe": ["string"
],
"filesharing": ["string"
],
"filetransfer": ["string"
],
"forms": ["string"
],
"login": ["string"
],
"meetings": ["string"
],
"oauth2client": ["string"
],
"presence": ["string"
],
"remotelog": ["string"
],
"usersettings": ["string"
],
"usersgroup": ["string"
],
"xmpp": ["string"
]
}
}
}

Response samples

201
400
401
409

Content type

application/json

{"domain": {"domain": "string",
"enable_anonymous": true,
"id": "string",
"origins": ["string"
],
"parent": "string",
"services": {"callcontrol": ["string"
],
"contacts": ["string"
],
"datapipe": ["string"
],
"filesharing": ["string"
],
"filetransfer": ["string"
],
"forms": ["string"
],
"login": ["string"
],
"meetings": ["string"
],
"oauth2client": ["string"
],
"presence": ["string"
],
"remotelog": ["string"
],
"usersettings": ["string"
],
"usersgroup": ["string"
],
"xmpp": ["string"
]
}
}
}

Deletes a Domain

Authorizations:

authorization

path Parameters

id

required

string

Domain ID

Responses

Response samples

401
404

Content type

application/json

{"error": "string"
}

Updates a Domain

Authorizations:

authorization

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

Payload

Content type

application/json

{"domain": "string",
"enable_anonymous": true,
"origins": ["string"
],
"parent": "string",
"services": {"callcontrol": ["string"
],
"contacts": ["string"
],
"datapipe": ["string"
],
"filesharing": ["string"
],
"filetransfer": ["string"
],
"forms": ["string"
],
"login": ["string"
],
"meetings": ["string"
],
"oauth2client": ["string"
],
"presence": ["string"
],
"remotelog": ["string"
],
"usersettings": ["string"
],
"usersgroup": ["string"
],
"xmpp": ["string"
]
}
}

Response samples

200
400
401
404
409

Content type

application/json

{"domain": {"domain": "string",
"enable_anonymous": true,
"id": "string",
"origins": ["string"
],
"parent": "string",
"services": {"callcontrol": ["string"
],
"contacts": ["string"
],
"datapipe": ["string"
],
"filesharing": ["string"
],
"filetransfer": ["string"
],
"forms": ["string"
],
"login": ["string"
],
"meetings": ["string"
],
"oauth2client": ["string"
],
"presence": ["string"
],
"remotelog": ["string"
],
"usersettings": ["string"
],
"usersgroup": ["string"
],
"xmpp": ["string"
]
}
}
}

users

Logouts all users of a domain

Logouts all users of a domain. This operation can take several seconds to be completed if the domain has a large number of users.

Authorizations:

authorization

path Parameters

id

required

string

Domain ID

Responses

Response samples

401

Content type

application/json

{"error": "string"
}

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:

authorization

query Parameters

email	string Filter by Email. To perform an exact search, send `exact=true` parameter.
username	string Filter by username. To perform an exact search, send `exact=true` parameter.
exact	boolean Default: false Exact search when querying by username and/or email
phone_number	string Filter by phone number. It performs always an exact search.
domain	string Filter by domain name. It performs always an exact search.

Responses

Response samples

200
400
401

Content type

application/json

{"users": [{"attributes": {"capabilities": ["string"
],
"domain": "string",
"phone_number": "string",
"sip_mapping": {"password": "string",
"username": "string"
}
},
"email": "string",
"enabled": true,
"first_name": "string",
"id": "string",
"last_name": "string",
"username": "string"
}
]
}

Provision a User

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

Authorizations:

authorization

Request Body schema: application/json

The User creation request

object (CreateUserStruct)

The definition of a user

Responses

Request samples

Payload

Content type

application/json

{"user": {"attributes": {"capabilities": ["string"
],
"domain": "string",
"phone_number": "string",
"sip_mapping": {"password": "string",
"username": "string"
}
},
"email": "string",
"enabled": true,
"first_name": "string",
"id": "string",
"last_name": "string",
"username": "string",
"credentials": {"password": "string",
"temporary": true
}
}
}

Response samples

201
400
401
409

Content type

application/json

{"user": {"attributes": {"capabilities": ["string"
],
"domain": "string",
"phone_number": "string",
"sip_mapping": {"password": "string",
"username": "string"
}
},
"email": "string",
"enabled": true,
"first_name": "string",
"id": "string",
"last_name": "string",
"username": "string"
}
}

Logouts all users of the realm

Authorizations:

authorization

Responses

Response samples

401

Content type

application/json

{"error": "string"
}

Finds a user by domain and username

Authorizations:

authorization

path Parameters

domain required	string
username required	string

Responses

Response samples

200
401
404

Content type

application/json

{"attributes": {"capabilities": ["string"
],
"domain": "string",
"phone_number": "string",
"sip_mapping": {"password": "string",
"username": "string"
}
},
"email": "string",
"enabled": true,
"first_name": "string",
"id": "string",
"last_name": "string",
"username": "string"
}

Deletes a User

Authorizations:

authorization

path Parameters

id

required

string

A user ID

Responses

Response samples

401
404

Content type

application/json

{"error": "string"
}

Updates a User

Authorizations:

authorization

path Parameters

id

required

string

A user ID

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 User's username
	object (UserAttributesStruct) Definition of user's credentials

Responses

Request samples

Payload

Content type

application/json

{"attributes": {"capabilities": ["string"
],
"domain": "string",
"phone_number": "string",
"sip_mapping": {"password": "string",
"username": "string"
}
},
"email": "string",
"enabled": true,
"first_name": "string",
"id": "string",
"last_name": "string",
"username": "string",
"credentials": {"password": "string",
"temporary": true
}
}

Response samples

200
400
401
404
409

Content type

application/json

{"user": {"attributes": {"capabilities": ["string"
],
"domain": "string",
"phone_number": "string",
"sip_mapping": {"password": "string",
"username": "string"
}
},
"email": "string",
"enabled": true,
"first_name": "string",
"id": "string",
"last_name": "string",
"username": "string"
}
}

Logouts a user

Authorizations:

authorization

path Parameters

id

required

string

A user ID

Responses

Response samples

401
404

Content type

application/json

{"error": "string"
}

logout

Logouts all users of a domain

Logouts all users of a domain. This operation can take several seconds to be completed if the domain has a large number of users.

Authorizations:

authorization

path Parameters

id

required

string

Domain ID

Responses

Response samples

401

Content type

application/json

{"error": "string"
}

Logouts all users of the realm

Authorizations:

authorization

Responses

Response samples

401

Content type

application/json

{"error": "string"
}

Logouts a user

Authorizations:

authorization

path Parameters

id

required

string

A user ID

Responses

Response samples

401
404

Content type

application/json

{"error": "string"
}