Class default

SecretsAPI is the backend for the Secrets facade.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

createSecrets grantSecret listSecrets removeSecrets revokeSecret updateSecrets

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/secrets/SecretsV2.ts:177

Properties

NAME

NAME: string = "Secrets"

VERSION

VERSION: number = 2

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "Secrets"

`Static` VERSION

VERSION: number = 2

Methods

createSecrets

createSecrets(params: CreateSecretArgs): Promise<StringResults>
CreateSecrets creates new secrets.
Parameters
- params: CreateSecretArgs
Returns Promise<StringResults>
- Defined in api/facades/secrets/SecretsV2.ts:187

grantSecret

grantSecret(params: GrantRevokeUserSecretArg): Promise<ErrorResults>
GrantSecret grants access to a user secret.
Parameters
- params: GrantRevokeUserSecretArg
Returns Promise<ErrorResults>
- Defined in api/facades/secrets/SecretsV2.ts:203

listSecrets

listSecrets(params: ListSecretsArgs): Promise<ListSecretResults>
ListSecrets lists available secrets.
Parameters
- params: ListSecretsArgs
Returns Promise<ListSecretResults>
- Defined in api/facades/secrets/SecretsV2.ts:219

removeSecrets

removeSecrets(params: DeleteSecretArgs): Promise<ErrorResults>
RemoveSecrets remove user secret.
Parameters
- params: DeleteSecretArgs
Returns Promise<ErrorResults>
- Defined in api/facades/secrets/SecretsV2.ts:235

revokeSecret

revokeSecret(params: GrantRevokeUserSecretArg): Promise<ErrorResults>
RevokeSecret revokes access to a user secret.
Parameters
- params: GrantRevokeUserSecretArg
Returns Promise<ErrorResults>
- Defined in api/facades/secrets/SecretsV2.ts:251

updateSecrets

updateSecrets(params: UpdateUserSecretArgs): Promise<ErrorResults>
UpdateSecrets creates new secrets.
Parameters
- params: UpdateUserSecretArgs
Returns Promise<ErrorResults>
- Defined in api/facades/secrets/SecretsV2.ts:267

Generated using TypeDoc