Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Latest commit

 

History

History
169 lines (97 loc) · 3.67 KB

_modules_keys_.keys.md

File metadata and controls

169 lines (97 loc) · 3.67 KB
Raw

do-wrapper

Globals / "modules/keys" / Keys

Class: Keys

Hierarchy

Index

Constructors

Methods

Constructors

constructor

+ new Keys(pageSize: number, requestHelper: RequestHelper): Keys

Overrides BaseModule.constructor

Defined in modules/keys.ts:11

Parameters:

Name Type
pageSize number
requestHelper RequestHelper

Returns: Keys

Methods

add

▸ add(addKeyRequest: AddKeyRequest): Promise<any>

Defined in modules/keys.ts:65

Add a new SSH Key to an account

Parameters:

Name Type Description
addKeyRequest AddKeyRequest the configuration of the SSH Key

Returns: Promise<any>

Promise

delete

▸ delete(identifier: string): Promise<any>

Defined in modules/keys.ts:98

Delete an SSH Key

Parameters:

Name Type Description
identifier string the ID or Fingerprint of the SSH Key you wish to delete

Returns: Promise<any>

Promise

getAll

▸ getAll(tagName: string, includeAll?: boolean, page?: number, pageSize?: number): Promise<any>

Defined in modules/keys.ts:25

Get all SSH Keys

Parameters:

Name Type Default value
tagName string -
includeAll boolean false
page number 1
pageSize number this.pageSize

Returns: Promise<any>

Promise

getByFingerprint

▸ getByFingerprint(fingerprint: string): Promise<any>

Defined in modules/keys.ts:54

Get a specific SSH Key using its fingerprint

Parameters:

Name Type Description
fingerprint string the fingerprint of the SSH Key to retrieve

Returns: Promise<any>

Promise

getById

▸ getById(keyId: number): Promise<any>

Defined in modules/keys.ts:43

Get a specific SSH Key using its identifier

Parameters:

Name Type Description
keyId number the identifier of the SSH Key

Returns: Promise<any>

Promise

rename

▸ rename(identifier: string, newName: string): Promise<any>

Defined in modules/keys.ts:81

Rename an SSH Key

Parameters:

Name Type Description
identifier string the ID or Fingerprint of the SSH Key to rename
newName string the new name to set on the SSH Key

Returns: Promise<any>

Promise