Class Secrets

Index

Constructors

Methods

create delete edit info list

Constructors

constructor

new Secrets(params: GenericModuleParams): Secrets
Parameters
- params: GenericModuleParams
Returns Secrets
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:75

Methods

create

create(secretObj: SecretsCreate): Promise<{ id: string }>
Creates a new secret in the profile with the specified key and value.
Parameters
- secretObj: SecretsCreate
Returns Promise<{ id: string }>
See
https://help.tago.io/portal/en/kb/articles/secrets#Creating_a_Secret Creating a Secret
Example
If receive an error "Authorization Denied", check policy Secrets / Create in Access Management.
```
const result = await Resources.secrets.create({
  key: "API_KEY",
  value: "my-secret-value"
});
console.log(result); // { id: 'secret-id-132 }
```
- Defined in modules/Resources/Secrets.ts:77

delete

delete(secretID: string): Promise<string>
Permanently removes a secret from the profile.
Parameters
- secretID: string
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/articles/secrets Secrets
Example
If receive an error "Authorization Denied", check policy Secrets / delete in Access Management.
```
const result = await Resources.secrets.delete("secret-id-123");
console.log(result); // Successfully Removed
```
- Defined in modules/Resources/Secrets.ts:128

edit

edit(secretID: string, secretObj: SecretsEdit): Promise<string>
Modifies the properties of an existing secret.
Parameters
- secretID: string
- secretObj: SecretsEdit
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/articles/secrets Secrets
Example
If receive an error "Authorization Denied", check policy Secrets / Edit in Access Management.
```
const result = await Resources.secrets.edit("secret-id-123", {
  value: "new-secret-value",
  tags: [{ key: "type", value: "user" }]
});
console.log(result); // Successfully Updated
```
- Defined in modules/Resources/Secrets.ts:104

info

info(secretID: string): Promise<SecretsInfo>
Retrieves detailed information about a specific secret using its ID.
Parameters
- secretID: string
Returns Promise<SecretsInfo>
See
https://help.tago.io/portal/en/kb/articles/secrets Secrets
Example
If receive an error "Authorization Denied", check policy Secrets / Access in Access Management.
```
const secretInfo = await Resources.secrets.info("secret-id-123");
console.log(secretInfo); // { id: 'secret-id-123', key: 'API_KEY' }
```
- Defined in modules/Resources/Secrets.ts:51

list

list(queryObj?: SecretsQuery): Promise<SecretsInfo[]>
Retrieves a paginated list of all secrets stored in the profile with filtering and sorting options.
Parameters
- OptionalqueryObj: SecretsQuery
Returns Promise<SecretsInfo[]>
See
https://help.tago.io/portal/en/kb/articles/secrets Secrets
Example
If receive an error "Authorization Denied", check policy Secrets / Access in Access Management.
```
const result = await Resources.secrets.list({
  page: 1,
  fields: ["id", "key"],
  amount: 20
});
console.log(result); // [ { id: 'secret-id-123', key: 'API_KEY' } ]
```
- Defined in modules/Resources/Secrets.ts:23