Skip to main content

Methods

List the secret groups associated with a user along with the associated secrets for each group. Filtered with the options passed in the query fields. Note: This method does not return the secret values of the associatedSecrets in the response. A separate API call to /v1/secrets/{id} should be made to fetch the associated secret value.

Parameters

typing.Optional[int]
Number of items per page
typing.Optional[int]
Number of items to skip
typing.Optional[str]
Fqn of secret group.
Search query - filters by secret group names that contain the search string

Returns

SyncPager[SecretGroup, ListSecretGroupResponse]
🔗 ListSecretGroupResponseReturns all the secret groups associated with a user along with the associated secrets for each group.

Usage

Creates a secret group with secrets in it. A secret version for each of the created secret is created with version number as 1. The returned secret group does not have any secret values in the associatedSecrets field. A separate API call to /v1/secrets/{id} should be made to fetch the associated secret value.

Parameters

str
required
Name of the secret group.
str
required
Id of the provider integration.
typing.Sequence[SecretInput]
required
🔗 SecretInputThe secrets to be associated with the secret group

Returns

GetSecretGroupResponse
🔗 GetSecretGroupResponseReturns the created secret group without the associated secrets.

Usage

Creates a new secret group or updates an existing one based on the provided manifest.

Parameters

SecretGroupManifest
required
🔗 SecretGroupManifestSecret Group Manifest
typing.Optional[bool]
Validate the manifest and collaborators without persisting or updating authorizations and secret groups

Returns

GetSecretGroupResponse
🔗 GetSecretGroupResponseSecret group created or updated successfully.

Usage

Get Secret Group by id. This method does not return the secret values of the associatedSecrets in the response. A separate API call to /v1/secrets/{id} should be made to fetch the associated secret value.

Parameters

str
required
Secret Id of the secret group.

Returns

GetSecretGroupResponse
🔗 GetSecretGroupResponseReturns the Secret Group associated with provided id

Usage

Updates the secrets in a secret group with new values. A new secret version is created for every secret that has a modified value and any omitted secrets are deleted. The returned updated secret group does not have any secret values in the associatedSecrets field. A separate API call to /v1/secrets/{id} should be made to fetch the associated secret value.

Parameters

str
required
Secret Id of the secret group.
typing.Sequence[UpdateSecretInput]
required

Returns

GetSecretGroupResponse
🔗 GetSecretGroupResponseReturns the updated secret group without associated secrets.

Usage

Deletes the secret group, its associated secrets and secret versions of those secrets.

Parameters

str
required
Secret Id of the secret group.

Returns

DeleteSecretGroupResponse
🔗 DeleteSecretGroupResponseDeletes Secret Group.

Usage

Get Secret Group by FQN.

Parameters

str
required
FQN of the secret group

Returns

GetSecretGroupResponse
🔗 GetSecretGroupResponseSecret group details

Usage