Class default

KeyManagerAPI provides api endpoints for manipulating ssh keys

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

addKeys deleteKeys importKeys listKeys

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/key-manager/KeyManagerV1.ts:74

Properties

NAME

NAME: string = "KeyManager"

VERSION

VERSION: number = 1

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "KeyManager"

`Static` VERSION

VERSION: number = 1

Methods

addKeys

addKeys(params: ModifyUserSSHKeys): Promise<ErrorResults>
AddKeys adds new authorised ssh keys for the specified user.
Parameters
- params: ModifyUserSSHKeys
Returns Promise<ErrorResults>
- Defined in api/facades/key-manager/KeyManagerV1.ts:84

deleteKeys

deleteKeys(params: ModifyUserSSHKeys): Promise<ErrorResults>
DeleteKeys deletes the authorised ssh keys for the specified user.
Parameters
- params: ModifyUserSSHKeys
Returns Promise<ErrorResults>
- Defined in api/facades/key-manager/KeyManagerV1.ts:100

importKeys

importKeys(params: ModifyUserSSHKeys): Promise<ErrorResults>
ImportKeys imports new authorised ssh keys from the specified key ids for the specified user.
Parameters
- params: ModifyUserSSHKeys
Returns Promise<ErrorResults>
- Defined in api/facades/key-manager/KeyManagerV1.ts:116

listKeys

listKeys(params: ListSSHKeys): Promise<StringsResults>
ListKeys returns the authorised ssh keys for the specified users.
Parameters
- params: ListSSHKeys
Returns Promise<StringsResults>
- Defined in api/facades/key-manager/KeyManagerV1.ts:132

Generated using TypeDoc