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 adminRoles API

The adminRoles API from Kiteworks — 4 operation(s) for adminroles.

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

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

This API exposes 5 operations across 4 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.

5 operations 4 paths 7 schemas 1 DELETE3 GET1 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 5

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

adminRoles 5
GET
/rest/adminRoles
List admin roles
3 params → 200490
GET
/rest/adminRoles/{id}
Get an admin role
1 param → 200490
GET
/rest/adminRoles/{id}/users
List users with an admin role
24 params → 200403490
PUT
/rest/adminRoles/{id}/users/{user_id}
Assign an admin role to a user
4 params → 200403490
DELETE
/rest/adminRoles/{id}/users/{user_id}
Remove an admin role from a user
4 params → 204403490

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are User (22 properties), AdminRole (4 properties), MetaData (3 properties), UserAdminRole (2 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
Error
object
2 properties
UserMetadata
object
Class UserMetadata
2 properties
User
object
Class User
22 properties 6 required
UserAdminRole
object
Class UserAdminRole
2 properties 1 required
AdminRole
object
Class AdminRole
4 properties 2 required
MetaData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-adminroles-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks activities API
Kiteworks admin 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
Kiteworks favorites API