Skip to content

CRUD

delete_secret(identifier, project=None, entity_id=None, delete_all_versions=False, **kwargs)

Delete object from backend.

Parameters:

Name Type Description Default
identifier str

Entity key (store://...) or entity name.

 required
project str

Project name.

 None
entity_id str

Entity ID.

 None
delete_all_versions bool

Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.

 False
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
dict

Response from backend.

Examples:

If delete_all_versions is False:

>>> obj = delete_secret("store://my-secret-key")

Otherwise:

>>> obj = delete_secret("my-secret-name"
>>>                     project="my-project",
>>>                     delete_all_versions=True)
Source code in digitalhub_core/entities/secret/crud.py 
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
def delete_secret(
    identifier: str,
    project: str | None = None,
    entity_id: str | None = None,
    delete_all_versions: bool = False,
    **kwargs,
) -> dict:
    """
    Delete object from backend.

    Parameters
    ----------
    identifier : str
        Entity key (store://...) or entity name.
    project : str
        Project name.
    entity_id : str
        Entity ID.
    delete_all_versions : bool
        Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    dict
        Response from backend.

    Examples
    --------
    If delete_all_versions is False:
    >>> obj = delete_secret("store://my-secret-key")

    Otherwise:
    >>> obj = delete_secret("my-secret-name"
    >>>                     project="my-project",
    >>>                     delete_all_versions=True)
    """
    return delete_entity_api_ctx(
        identifier=identifier,
        entity_type=ENTITY_TYPE,
        project=project,
        entity_id=entity_id,
        delete_all_versions=delete_all_versions,
        **kwargs,
    )

get_secret(identifier, project=None, entity_id=None, **kwargs)

Get object from backend.

Parameters:

Name Type Description Default
identifier str

Entity key (store://...) or entity name.

 required
project str

Project name.

 None
entity_id str

Entity ID.

 None
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
Secret

Object instance.

Examples:

Using entity key:

>>> obj = get_secret("store://my-secret-key")

Using entity name:

>>> obj = get_secret("my-secret-name"
>>>                  project="my-project",
>>>                  entity_id="my-secret-id")
Source code in digitalhub_core/entities/secret/crud.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def get_secret(
    identifier: str,
    project: str | None = None,
    entity_id: str | None = None,
    **kwargs,
) -> Secret:
    """
    Get object from backend.

    Parameters
    ----------
    identifier : str
        Entity key (store://...) or entity name.
    project : str
        Project name.
    entity_id : str
        Entity ID.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    Secret
        Object instance.

    Examples
    --------
    Using entity key:
    >>> obj = get_secret("store://my-secret-key")

    Using entity name:
    >>> obj = get_secret("my-secret-name"
    >>>                  project="my-project",
    >>>                  entity_id="my-secret-id")
    """
    obj = read_entity_api_ctx(
        identifier,
        ENTITY_TYPE,
        project=project,
        entity_id=entity_id,
        **kwargs,
    )
    return secret_from_dict(obj)

get_secret_versions(identifier, project=None, **kwargs)

Get object versions from backend.

Parameters:

Name Type Description Default
identifier str

Entity key (store://...) or entity name.

 required
project str

Project name.

 None
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
list[Secret]

List of object instances.

Examples:

Using entity key:

>>> objs = get_secret_versions("store://my-secret-key")

Using entity name:

>>> objs = get_secret_versions("my-secret-name",
>>>                            project="my-project")
Source code in digitalhub_core/entities/secret/crud.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
def get_secret_versions(
    identifier: str,
    project: str | None = None,
    **kwargs,
) -> list[Secret]:
    """
    Get object versions from backend.

    Parameters
    ----------
    identifier : str
        Entity key (store://...) or entity name.
    project : str
        Project name.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    list[Secret]
        List of object instances.

    Examples
    --------
    Using entity key:
    >>> objs = get_secret_versions("store://my-secret-key")

    Using entity name:
    >>> objs = get_secret_versions("my-secret-name",
    >>>                            project="my-project")
    """
    obj = read_entity_api_ctx_versions(
        identifier,
        entity_type=ENTITY_TYPE,
        project=project,
        **kwargs,
    )
    return [secret_from_dict(o) for o in obj]

import_secret(file)

Import object from a YAML file.

Parameters:

Name Type Description Default
file str

Path to YAML file.

 required

Returns:

Type Description
Secret

Object instance.

Examples:

>>> obj = import_secret("my-secret.yaml")
Source code in digitalhub_core/entities/secret/crud.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
def import_secret(file: str) -> Secret:
    """
    Import object from a YAML file.

    Parameters
    ----------
    file : str
        Path to YAML file.

    Returns
    -------
    Secret
        Object instance.

    Examples
    --------
    >>> obj = import_secret("my-secret.yaml")
    """
    obj: dict = read_yaml(file)
    return secret_from_dict(obj)

list_secrets(project, **kwargs)

List all latest version objects from backend.

Parameters:

Name Type Description Default
project str

Project name.

 required
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
list[Secret]

List of object instances.

Examples:

>>> objs = list_secrets(project="my-project")
Source code in digitalhub_core/entities/secret/crud.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
def list_secrets(project: str, **kwargs) -> list[Secret]:
    """
    List all latest version objects from backend.

    Parameters
    ----------
    project : str
        Project name.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    list[Secret]
        List of object instances.

    Examples
    --------
    >>> objs = list_secrets(project="my-project")
    """
    objs = list_entity_api_ctx(
        project=project,
        entity_type=ENTITY_TYPE,
        **kwargs,
    )
    return [secret_from_dict(obj) for obj in objs]

new_secret(project, name, uuid=None, description=None, labels=None, embedded=True, secret_value=None, **kwargs)

Create a new object.

Parameters:

Name Type Description Default
project str

Project name.

 required
name str

Object name.

 required
uuid str

ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).

 None
description str

Description of the object (human readable).

 None
labels list[str]

List of labels.

 None
embedded bool

Flag to determine if object spec must be embedded in project spec.

 True
secret_value str

Value of the secret.

 None
**kwargs dict

Spec keyword arguments.

 {}

Returns:

Type Description
Secret

Object instance.

Examples:

>>> obj = new_secret(project="my-project",
>>>                  name="my-secret",
>>>                  secret_value="my-secret-value")
Source code in digitalhub_core/entities/secret/crud.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def new_secret(
    project: str,
    name: str,
    uuid: str | None = None,
    description: str | None = None,
    labels: list[str] | None = None,
    embedded: bool = True,
    secret_value: str | None = None,
    **kwargs,
) -> Secret:
    """
    Create a new object.

    Parameters
    ----------
    project : str
        Project name.
    name : str
        Object name.
    uuid : str
        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
    description : str
        Description of the object (human readable).
    labels : list[str]
        List of labels.
    embedded : bool
        Flag to determine if object spec must be embedded in project spec.
    secret_value : str
        Value of the secret.
    **kwargs : dict
        Spec keyword arguments.

    Returns
    -------
    Secret
        Object instance.

    Examples
    --------
    >>> obj = new_secret(project="my-project",
    >>>                  name="my-secret",
    >>>                  secret_value="my-secret-value")
    """
    check_context(project)

    if secret_value is None:
        raise ValueError("secret_value must be provided.")

    obj = secret_from_parameters(
        project=project,
        name=name,
        kind="secret",
        uuid=uuid,
        description=description,
        labels=labels,
        embedded=embedded,
        **kwargs,
    )
    obj.save()
    obj.set_secret_value(value=secret_value)
    return obj

update_secret(entity)

Update object. Note that object spec are immutable.

Parameters:

Name Type Description Default
entity Secret

Object to update.

 required

Returns:

Type Description
Secret

Entity updated.

Examples:

>>> obj = update_secret(obj)
Source code in digitalhub_core/entities/secret/crud.py 
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
def update_secret(entity: Secret) -> Secret:
    """
    Update object. Note that object spec are immutable.

    Parameters
    ----------
    entity : Secret
        Object to update.

    Returns
    -------
    Secret
        Entity updated.

    Examples
    --------
    >>> obj = update_secret(obj)
    """
    return entity.save(update=True)