Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kiteworks profiles API

The profiles API from Kiteworks — 3 operation(s) for profiles.

Kiteworks profiles API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include profiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.2, at version 28.

Requests are made against the base URL https://your.kiteworks.domain/rest.

4 operations 3 paths 7 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
28
Base URL
https://your.kiteworks.domain/rest
Resource Areas
1

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

profiles 4
POST
/rest/profiles
Add custom profile
2 params body → 200403409422490
GET
/rest/profiles/{id}
Return user type (profile) details
1 param → 200490
PUT
/rest/profiles/{id}
Update profile
1 param body → 200403422490
DELETE
/rest/profiles/{id}/replace/{new_profile}
Delete custom profile and set new profile instead of deleted profile
2 params body → 204403422490

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are FeaturesList (58 properties), FeaturesList.Put (49 properties), UserDemoteOptions.Post (8 properties), Profile (6 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
FeaturesList.Put
object
Class FeaturesList
49 properties
UserDemoteOptions.Post
object
Class UserDemoteOptions
8 properties
Error
object
2 properties
FeaturesList
object
Class FeaturesList
58 properties 7 required
Profile
object
Class Profile
6 properties 5 required
Profile.Post
object
Class Profile
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-profiles-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks activities API
Kiteworks admin API
Kiteworks adminRoles API
Kiteworks advancedForms API
Kiteworks cards API
Kiteworks clientEventLogs API
Kiteworks clients API
Kiteworks comments API
Kiteworks contacts API
Kiteworks devices API
Kiteworks dli API
Kiteworks externalDL API