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

The userSshPublicKeys API from Kiteworks — 7 operation(s) for usersshpublickeys.

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

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

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

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

7 operations 7 paths 9 schemas 1 DELETE2 GET4 POST

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 7

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

userSshPublicKeys 7
POST
/rest/userSshPublicKeys/create
Register an SSH public key for the current user
body → 201401403422490
POST
/rest/userSshPublicKeys/generate
Generate a new SSH public/private key pair
body → 201401403422490
DELETE
/rest/userSshPublicKeys/{id}
Delete an SSH public key
1 param → 204401403490
GET
/rest/userSshPublicKeys
List the current user's SSH public keys
1 param → 200401403490
GET
/rest/admin/users/{id}/userSshPublicKeys
List SSH public keys for a user
1 param → 200401403490
POST
/rest/admin/users/{id}/userSshPublicKeys/create
Create an SSH public key for a user
1 param body → 201401403422490
POST
/rest/admin/users/{id}/userSshPublicKeys/generate
Generate an SSH key pair for a user
1 param body → 201401403422490

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are UserSshPublicKey1 (7 properties), UserSshPublicKey (6 properties), UserSshPublicKeysPostGenerateRequest (2 properties), UserSshPublicKeysPostCreateRequest (2 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
UserSshPublicKeysPostCreateRequest
object
2 properties 2 required
UserSshPublicKeysPostGenerateRequest
object
2 properties 1 required
Error
object
2 properties
AdminUserSshPublicKeyList
object
1 property
UserSshPublicKey
object
6 properties
UserGeneratedSshPublicKeyKey
object
2 properties
UserSshPublicKeyList
object
1 property
UserSshPublicKey1
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-usersshpublickeys-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