Secret Groups

On this page

Methods

Methods

list

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

limit

typing.Optional[int]

Number of items per page

offset

typing.Optional[int]

Number of items to skip

fqn

typing.Optional[str]

Fqn of secret group.

typing.Optional[str]

Search query - filters by secret group names that contain the search string

Returns

Returns all the secret groups associated with a user along with the associated secrets for each group.Type Details: SecretGroup

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.list(
    limit=10,
    offset=10,
    fqn="value",
    search="value",
)

# Iterate through results
for item in response:
    print(item.name)

# Or paginate page by page
for page in response.iter_pages():
    for item in page:
        print(item.name)

create

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

name

str

required

Name of the secret group.

integration_id

str

required

Id of the provider integration.

secrets

typing.Sequence[SecretInput]

required

The secrets to be associated with the secret groupType Details: SecretInput

Returns

GetSecretGroupResponse

Returns the created secret group without the associated secrets.Type Details: GetSecretGroupResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.create(
    name="value",
    integration_id="value",
    secrets="value",
)

get

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

Returns the Secret Group associated with provided idType Details: GetSecretGroupResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.get(
    id="id_value",
)

update

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.

secrets

typing.Sequence[UpdateSecretInput]

required

No descriptionType Details: UpdateSecretInput

Returns

GetSecretGroupResponse

Returns the updated secret group without associated secrets.Type Details: GetSecretGroupResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.update(
    id="id_value",
    secrets="value",
)

delete

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

Parameters

str

required

Secret Id of the secret group.

Returns

DeleteSecretGroupResponse

Deletes Secret Group.Type Details: DeleteSecretGroupResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.delete(
    id="id_value",
)

TrueFoundry SDK

Clusters

Workspaces

MLRepos

Applications

Jobs

Models

Artifacts

Prompts

Secrets

Model Deployments

Users

Teams

Personal Access Tokens

Virtual Accounts

Logs

Audit Logs

Apply

Secret Groups

Methods

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

TrueFoundry SDK

Clusters

Workspaces

MLRepos

Applications

Jobs

Models

Artifacts

Prompts

Secret Groups

Secrets

Model Deployments

Users

Teams

Personal Access Tokens

Virtual Accounts

Logs

Audit Logs

Apply

​Methods

Methods