Skip to content

Secrets

API

Infisical Secrets Resource API.

SecretsV3

Bases: InfisicalAPI

Infisical Secrets v3 API.

Attributes:

Name Type Description
base_uri str

/v3/secrets
Source code in src/infisical/resources/secrets/api.py 
 20
 21
 22
 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
 84
 85
 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
class SecretsV3(InfisicalAPI):
    """Infisical Secrets v3 API.

    Attributes:
        base_uri (str): `/v3/secrets`
    """

    base_uri: Final = "/v3/secrets"

    def __init__(self, client: SyncOrAsyncClient) -> None:
        """Initialize the Infisical Secrets Resource.

        Args:
            client (SyncOrAsyncClient): An initialized [InfisicalClient][src.infisical.clients.clients.] or
                [InfisicalAsyncClient][src.infisical.clients.clients.].
        """
        super().__init__(client=client)

    def create(self, request: CreateSecretRequest) -> Secret:
        """Create a new secret.

        Args:
            request (CreateSecretRequest): The request object containing secret details.
        """
        self.logger.info("Creating secret %s", request.name)
        url = self._format_url(f"/raw/{request.name}")
        _request = self.client.create_request(
            method="post",
            url=url,
            body=request.model_dump(by_alias=True, exclude_none=True),
        )
        return self.client.handle_request(request=_request, expected_responses={"secret": Secret})

    def delete(self, request: DeleteSecretRequest) -> Secret:
        """Delete a secret.

        Args:
            request (DeleteSecretRequest): The request object containing secret ID or name.
        """
        self.logger.info("Deleting secret %s", request.name)
        url = self._format_url(f"/raw/{request.name}")
        _request = self.client.create_request(
            method="delete",
            url=url,
            body=request.model_dump(by_alias=True, exclude_none=True),
        )
        return self.client.handle_request(
            request=_request,
            expected_responses={"secret": Secret, "approval": SecretApprovalResponse},
        )

    def list(self, **params: Unpack[ListSecretsQueryParams]) -> SecretsList:
        """List all secrets.

        This method lists all secrets in the provided `workspaceId` and `environment`, which are required parameters.
        The `secretPath` parameter is optional and can be used to filter the secrets by a specific path. If `recursive`
        is not set to true, which the default is `false`, the list of secrets will be only those in the `secretPath`.

        Args:
            **params: (ListSecretsQueryParams): The query parameters for the request.

        !!! note

            The `viewSecretValue` param is permanently set to `false` to avoid exposing secret values when listing.
            This is by design and is not configurable. If you need to get a secret value, use the `retrieve` method.
        """
        self.logger.info("Listing secrets with params %s", params)
        self.verify_required_params(required_params=["workspaceId", "environment"], params=params)
        # Infisical defaults "viewSecretValue" to true, but we want it to be false because getting a secret value
        # should be an explicit action for a single secret and not the default for listing numerous secrets.
        # Maybe we can change this in the future, but for now, we will set it to false.
        params["viewSecretValue"] = "false"
        url = self._format_url("/raw")
        request = self.client.create_request(method="get", url=url, params=params)
        return self.client.handle_request(request=request, expected_responses={"": SecretsList})

    def retrieve(self, *, name: str, **params: Unpack[RetrieveSecretQueryParams]) -> Secret:
        """Retrieve a secret by Name.

        This method retrieves a secret from the `secretPath` by its `name` in the provided `workspaceId` and
        `environment`, which are required parameters. If the secret is not found in the `secretPath`, it will return a
        404 error.
        """
        self.logger.info("Retrieving secret %s with params %s", name, params)
        self.verify_required_params(required_params=["workspaceId", "environment"], params=params)
        url = self._format_url(f"/raw/{name}")
        request = self.client.create_request(method="get", url=url, params=params)
        return self.client.handle_request(request=request, expected_responses={"secret": Secret})

    def update(self, request: UpdateSecretRequest) -> Secret:
        """Update a secret."""
        self.logger.info("Updating secret %s", request.name)
        url = self._format_url(f"/raw/{request.name}")
        request = self.client.create_request(
            method="patch",
            url=url,
            body=request.model_dump(by_alias=True, exclude_none=True),
        )
        return self.client.handle_request(
            request=request,
            expected_responses={"secret": Secret, "approval": SecretApprovalResponse},
        )

__init__ 

__init__(client: SyncOrAsyncClient) -> None

Initialize the Infisical Secrets Resource.

Parameters:

Name Type Description Default
client SyncOrAsyncClient

An initialized InfisicalClient or InfisicalAsyncClient.

 required
Source code in src/infisical/resources/secrets/api.py 
29
30
31
32
33
34
35
36
def __init__(self, client: SyncOrAsyncClient) -> None:
    """Initialize the Infisical Secrets Resource.

    Args:
        client (SyncOrAsyncClient): An initialized [InfisicalClient][src.infisical.clients.clients.] or
            [InfisicalAsyncClient][src.infisical.clients.clients.].
    """
    super().__init__(client=client)

create 

create(request: CreateSecretRequest) -> Secret

Create a new secret.

Parameters:

Name Type Description Default
request CreateSecretRequest

The request object containing secret details.

 required
Source code in src/infisical/resources/secrets/api.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def create(self, request: CreateSecretRequest) -> Secret:
    """Create a new secret.

    Args:
        request (CreateSecretRequest): The request object containing secret details.
    """
    self.logger.info("Creating secret %s", request.name)
    url = self._format_url(f"/raw/{request.name}")
    _request = self.client.create_request(
        method="post",
        url=url,
        body=request.model_dump(by_alias=True, exclude_none=True),
    )
    return self.client.handle_request(request=_request, expected_responses={"secret": Secret})

delete 

delete(request: DeleteSecretRequest) -> Secret

Delete a secret.

Parameters:

Name Type Description Default
request DeleteSecretRequest

The request object containing secret ID or name.

 required
Source code in src/infisical/resources/secrets/api.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def delete(self, request: DeleteSecretRequest) -> Secret:
    """Delete a secret.

    Args:
        request (DeleteSecretRequest): The request object containing secret ID or name.
    """
    self.logger.info("Deleting secret %s", request.name)
    url = self._format_url(f"/raw/{request.name}")
    _request = self.client.create_request(
        method="delete",
        url=url,
        body=request.model_dump(by_alias=True, exclude_none=True),
    )
    return self.client.handle_request(
        request=_request,
        expected_responses={"secret": Secret, "approval": SecretApprovalResponse},
    )

list 

list(**params: Unpack[ListSecretsQueryParams]) -> SecretsList

List all secrets.

This method lists all secrets in the provided workspaceId and environment, which are required parameters. The secretPath parameter is optional and can be used to filter the secrets by a specific path. If recursive is not set to true, which the default is false, the list of secrets will be only those in the secretPath.

Parameters:

Name Type Description Default
**params Unpack[ListSecretsQueryParams]

(ListSecretsQueryParams): The query parameters for the request.

 {}

Note

The viewSecretValue param is permanently set to false to avoid exposing secret values when listing. This is by design and is not configurable. If you need to get a secret value, use the retrieve method.

Source code in src/infisical/resources/secrets/api.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def list(self, **params: Unpack[ListSecretsQueryParams]) -> SecretsList:
    """List all secrets.

    This method lists all secrets in the provided `workspaceId` and `environment`, which are required parameters.
    The `secretPath` parameter is optional and can be used to filter the secrets by a specific path. If `recursive`
    is not set to true, which the default is `false`, the list of secrets will be only those in the `secretPath`.

    Args:
        **params: (ListSecretsQueryParams): The query parameters for the request.

    !!! note

        The `viewSecretValue` param is permanently set to `false` to avoid exposing secret values when listing.
        This is by design and is not configurable. If you need to get a secret value, use the `retrieve` method.
    """
    self.logger.info("Listing secrets with params %s", params)
    self.verify_required_params(required_params=["workspaceId", "environment"], params=params)
    # Infisical defaults "viewSecretValue" to true, but we want it to be false because getting a secret value
    # should be an explicit action for a single secret and not the default for listing numerous secrets.
    # Maybe we can change this in the future, but for now, we will set it to false.
    params["viewSecretValue"] = "false"
    url = self._format_url("/raw")
    request = self.client.create_request(method="get", url=url, params=params)
    return self.client.handle_request(request=request, expected_responses={"": SecretsList})

retrieve 

retrieve(*, name: str, **params: Unpack[RetrieveSecretQueryParams]) -> Secret

Retrieve a secret by Name.

This method retrieves a secret from the secretPath by its name in the provided workspaceId and environment, which are required parameters. If the secret is not found in the secretPath, it will return a 404 error.

Source code in src/infisical/resources/secrets/api.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def retrieve(self, *, name: str, **params: Unpack[RetrieveSecretQueryParams]) -> Secret:
    """Retrieve a secret by Name.

    This method retrieves a secret from the `secretPath` by its `name` in the provided `workspaceId` and
    `environment`, which are required parameters. If the secret is not found in the `secretPath`, it will return a
    404 error.
    """
    self.logger.info("Retrieving secret %s with params %s", name, params)
    self.verify_required_params(required_params=["workspaceId", "environment"], params=params)
    url = self._format_url(f"/raw/{name}")
    request = self.client.create_request(method="get", url=url, params=params)
    return self.client.handle_request(request=request, expected_responses={"secret": Secret})

update 

update(request: UpdateSecretRequest) -> Secret

Update a secret.

Source code in src/infisical/resources/secrets/api.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
def update(self, request: UpdateSecretRequest) -> Secret:
    """Update a secret."""
    self.logger.info("Updating secret %s", request.name)
    url = self._format_url(f"/raw/{request.name}")
    request = self.client.create_request(
        method="patch",
        url=url,
        body=request.model_dump(by_alias=True, exclude_none=True),
    )
    return self.client.handle_request(
        request=request,
        expected_responses={"secret": Secret, "approval": SecretApprovalResponse},
    )

Secrets

Infisical Secrets Resource.

Attributes:

Name Type Description
v3 SecretsV3

The Infisical Secrets v3 API.
Source code in src/infisical/resources/secrets/api.py 
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
class Secrets:
    """Infisical Secrets Resource.

    Attributes:
        v3 (SecretsV3): The Infisical Secrets v3 API.
    """

    def __init__(self, client: SyncOrAsyncClient) -> None:
        """Initialize the Infisical Secrets Resource.

        Args:
            client (SyncOrAsyncClient): An initialized [InfisicalClient][src.infisical.clients.clients.] or
                [InfisicalAsyncClient][src.infisical.clients.clients.].
        """
        self.v3 = SecretsV3(client=client)

__init__ 

__init__(client: SyncOrAsyncClient) -> None

Initialize the Infisical Secrets Resource.

Parameters:

Name Type Description Default
client SyncOrAsyncClient

An initialized InfisicalClient or InfisicalAsyncClient.

 required
Source code in src/infisical/resources/secrets/api.py 
131
132
133
134
135
136
137
138
def __init__(self, client: SyncOrAsyncClient) -> None:
    """Initialize the Infisical Secrets Resource.

    Args:
        client (SyncOrAsyncClient): An initialized [InfisicalClient][src.infisical.clients.clients.] or
            [InfisicalAsyncClient][src.infisical.clients.clients.].
    """
    self.v3 = SecretsV3(client=client)

Models

Infisical Secrets Resource Models.

ListSecretsQueryParams

Bases: TypedDict

Query parameters for listing secrets.

Other Parameters:

Name Type Description
environment str

The environment name. REQUIRED
expandSecretReferences str

Whether to expand secret references.
offset int

The offset for pagination.
recursive str

Whether to list secrets recursively.
secretPath str

The path to the secret.
viewSecretValue str

Whether to view the secret value.
workspaceId str

The ID of the workspace. REQUIRED
workspaceSlug str

The slug of the workspace.
Source code in src/infisical/resources/secrets/models.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class ListSecretsQueryParams(TypedDict, total=False):
    """Query parameters for listing secrets.

    Other parameters:
        environment (str): The environment name. ***REQUIRED***
        expandSecretReferences (str): Whether to expand secret references.
        offset (int): The offset for pagination.
        recursive (str): Whether to list secrets recursively.
        secretPath (str): The path to the secret.
        viewSecretValue (str): Whether to view the secret value.
        workspaceId (str): The ID of the workspace. ***REQUIRED***
        workspaceSlug (str): The slug of the workspace.
    """

    environment: str
    expandSecretReferences: Literal["true", "false"]
    offset: int
    recursive: Literal["true", "false"]
    secretPath: str
    viewSecretValue: Literal["true", "false"]
    workspaceId: str
    workspaceSlug: str

RetrieveSecretQueryParams

Bases: TypedDict

Query parameters for retrieving a secret.

Other Parameters:

Name Type Description
environment str

The environment name. REQUIRED
expandSecretReferences str

Whether to expand secret references.
include_imports str

Whether to include imports.
secretPath str

The path to the secret.
type SecretType

The type of the secret.
version int

The version of the secret.
viewSecretValue str

Whether to view the secret value.
workspaceId str

The ID of the workspace. REQUIRED
workspaceSlug str

The slug of the workspace.
Source code in src/infisical/resources/secrets/models.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
class RetrieveSecretQueryParams(TypedDict, total=False):
    """Query parameters for retrieving a secret.

    Other parameters:
        environment (str): The environment name. ***REQUIRED***
        expandSecretReferences (str): Whether to expand secret references.
        include_imports (str): Whether to include imports.
        secretPath (str): The path to the secret.
        type (SecretType): The type of the secret.
        version (int): The version of the secret.
        viewSecretValue (str): Whether to view the secret value.
        workspaceId (str): The ID of the workspace. ***REQUIRED***
        workspaceSlug (str): The slug of the workspace.
    """

    environment: str
    expandSecretReferences: Literal["true", "false"]
    include_imports: Literal["true", "false"]
    secretPath: str
    type: SecretType
    version: int
    viewSecretValue: Literal["true", "false"]
    workspaceId: str
    workspaceSlug: str

Metadata

Bases: BaseModel

Metadata model.

Attributes:

Name Type Description
key str

The key of the metadata.
value str

The value of the metadata.
Source code in src/infisical/resources/secrets/models.py 
63
64
65
66
67
68
69
70
71
72
class Metadata(BaseModel):
    """Metadata model.

    Attributes:
        key (str): The key of the metadata.
        value (str): The value of the metadata.
    """

    key: str
    value: str

Tags

Bases: BaseModel

Tags model.

Attributes:

Name Type Description
id str

The ID of the tag.
slug str

The slug of the tag.
color str

The color of the tag.
name str

The name of the tag.
Source code in src/infisical/resources/secrets/models.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
88
class Tags(BaseModel):
    """Tags model.

    Attributes:
        id (str): The ID of the tag.
        slug (str): The slug of the tag.
        color (str): The color of the tag.
        name (str): The name of the tag.
    """

    id: str
    slug: str
    color: str
    name: str

Secret

Bases: BaseModel

Secret model.

Attributes:

Name Type Description
_secret_id str

The ID of the secret.
created_at datetime

The creation date of the secret.
environment str

The environment name.
folder_id str

The ID of the folder.
is_rotated_secret bool | None

Whether the secret is rotated.
rotation_id str | None

The ID of the rotation.
secret_comment str

The comment for the secret.
secret_id str

The ID of the secret.
secret_key str

The key of the secret.
secret_metadata list[Metadata] | None

The metadata of the secret.
secret_path str

The path to the secret.
secret_reminder_note str | None

The reminder note for the secret.
secret_reminder_repeat_days int | None

The number of days to repeat the reminder.
secret_type SecretType

The type of the secret.
secret_value_hidden bool | None

Whether the secret value is hidden.
secret_value str

The value of the secret.
skip_multiline_encoding bool | None

Whether to skip multiline encoding.
tags list[Tags]

The tags associated with the secret.
updated_at datetime

The last updated date of the secret.
user_id str | None

The ID of the user who created or updated the secret.
version int

The version of the secret.
workspace str

The workspace name.
Source code in src/infisical/resources/secrets/models.py 
 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
129
130
131
132
133
134
135
136
137
138
139
140
class Secret(BaseModel):
    """Secret model.

    Attributes:
        _secret_id (str): The ID of the secret.
        created_at (datetime.datetime): The creation date of the secret.
        environment (str): The environment name.
        folder_id (str): The ID of the folder.
        is_rotated_secret (bool | None): Whether the secret is rotated.
        rotation_id (str | None): The ID of the rotation.
        secret_comment (str): The comment for the secret.
        secret_id (str): The ID of the secret.
        secret_key (str): The key of the secret.
        secret_metadata (list[Metadata] | None): The metadata of the secret.
        secret_path (str): The path to the secret.
        secret_reminder_note (str | None): The reminder note for the secret.
        secret_reminder_repeat_days (int | None): The number of days to repeat the reminder.
        secret_type (SecretType): The type of the secret.
        secret_value_hidden (bool | None): Whether the secret value is hidden.
        secret_value (str): The value of the secret.
        skip_multiline_encoding (bool | None): Whether to skip multiline encoding.
        tags (list[Tags]): The tags associated with the secret.
        updated_at (datetime.datetime): The last updated date of the secret.
        user_id (str | None): The ID of the user who created or updated the secret.
        version (int): The version of the secret.
        workspace (str): The workspace name.
    """

    _secret_id: Annotated[str, Field(alias="_id")]
    created_at: Annotated[datetime.datetime, Field(alias="createdAt")]
    environment: Annotated[str, Field()]
    folder_id: Annotated[str, Field(alias="folderId", default="")]
    is_rotated_secret: Annotated[bool | None, Field(alias="isRotatedSecret", default=None)]
    rotation_id: Annotated[str | None, Field(alias="rotationId", default=None)]
    secret_comment: Annotated[str, Field(alias="secretComment")]
    secret_id: Annotated[str, Field(alias="id")]
    secret_key: Annotated[str, Field(alias="secretKey")]
    secret_metadata: Annotated[list[Metadata] | None, Field(alias="secretMetadata", default=None)]
    secret_path: Annotated[str, Field(alias="secretPath", default="")]
    secret_reminder_note: Annotated[str | None, Field(alias="secretReminderNote", default=None)]
    secret_reminder_repeat_days: Annotated[int | None, Field(alias="secretReminderRepeatDays", default=None)]
    secret_type: Annotated[SecretType, Field(alias="type")]
    secret_value_hidden: Annotated[bool | None, Field(alias="secretValueHidden", default=None)]
    secret_value: Annotated[str, Field(alias="secretValue")]
    skip_multiline_encoding: Annotated[bool | None, Field(alias="skipMultilineEncoding", default=None)]
    tags: Annotated[list[Tags], Field(alias="tags", default_factory=list)]
    updated_at: Annotated[datetime.datetime, Field(alias="updatedAt")]
    user_id: Annotated[str | None, Field(alias="userId", default=None)]
    version: Annotated[int, Field()]
    workspace: Annotated[str, Field()]

SecretsList

Bases: BaseModel

List of secrets model.

Attributes:

Name Type Description
secrets list[Secret]

The list of secrets.
imports list[dict]

The list of imports.
Source code in src/infisical/resources/secrets/models.py 
143
144
145
146
147
148
149
150
151
152
class SecretsList(BaseModel):
    """List of secrets model.

    Attributes:
        secrets (list[Secret]): The list of secrets.
        imports (list[dict]): The list of imports.
    """

    imports: Annotated[list[dict], Field(default_factory=list)]
    secrets: Annotated[list[Secret], Field()]

CreateSecretRequest

Bases: InfisicalResourceRequest

Create secret request model.

Attributes:

Name Type Description
metadata dict[str, str] | None

The metadata of the secret.
name str

The name of the secret.
secret_comment str

The comment for the secret.
secret_metadata list[Metadata] | None

The metadata of the secret.
secret_path str

The path to the secret.
secret_reminder_note str | None

The reminder note for the secret.
secret_reminder_repeat_days int | None

The number of days to repeat the reminder.
secret_type SecretType

The type of the secret.
secret_value str

The value of the secret.
skip_multiline_encoding bool | None

Whether to skip multiline encoding.
tag_ids list[str] | None

The IDs of the tags associated with the secret.
workspace_id str

The ID of the workspace.
environment str

The environment name.
Source code in src/infisical/resources/secrets/models.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
class CreateSecretRequest(InfisicalResourceRequest):
    """Create secret request model.

    Attributes:
        metadata (dict[str, str] | None): The metadata of the secret.
        name (str): The name of the secret.
        secret_comment (str): The comment for the secret.
        secret_metadata (list[Metadata] | None): The metadata of the secret.
        secret_path (str): The path to the secret.
        secret_reminder_note (str | None): The reminder note for the secret.
        secret_reminder_repeat_days (int | None): The number of days to repeat the reminder.
        secret_type (SecretType): The type of the secret.
        secret_value (str): The value of the secret.
        skip_multiline_encoding (bool | None): Whether to skip multiline encoding.
        tag_ids (list[str] | None): The IDs of the tags associated with the secret.
        workspace_id (str): The ID of the workspace.
        environment (str): The environment name.
    """

    name: Annotated[str, Field(exclude=True)]
    secret_comment: Annotated[str, Field(alias="secretComment", default="")]
    secret_metadata: Annotated[list[Metadata] | None, Field(alias="secretMetadata", default=None)]
    secret_path: Annotated[str, Field(alias="secretPath", default="/")]
    secret_reminder_note: Annotated[str | None, Field(alias="secretReminderNote", default=None, max_length=1024)]
    secret_reminder_repeat_days: Annotated[int | None, Field(alias="secretReminderRepeatDays", default=None)]
    secret_type: Annotated[SecretType, Field(alias="type", default="shared")]
    secret_value: Annotated[str, Field(alias="secretValue")]
    skip_multiline_encoding: Annotated[bool | None, Field(alias="skipMultilineEncoding", default=None)]
    tag_ids: Annotated[list[str] | None, Field(alias="tagIds", default=None)]

UpdateSecretRequest

Bases: InfisicalResourceRequest

Update secret request model.

Attributes:

Name Type Description
metadata dict[str, str] | None

The metadata of the secret.
name str

The name of the secret.
new_secret_name str | None

The new name of the secret.
secret_comment str | None

The comment for the secret.
secret_metadata list[Metadata] | None

The metadata of the secret.
secret_path str

The path to the secret.
secret_reminder_note str | None

The reminder note for the secret.
secret_reminder_recipients list[str] | None

The recipients of the reminder.
secret_reminder_repeat_days int | None

The number of days to repeat the reminder.
secret_type SecretType

The type of the secret.
secret_value str | None

The value of the secret.
skip_multiline_encoding bool | None

Whether to skip multiline encoding.
tag_ids list[str] | None

The IDs of the tags associated with the secret.
workspace_id str

The ID of the workspace.
environment str

The environment name.
Source code in src/infisical/resources/secrets/models.py 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
class UpdateSecretRequest(InfisicalResourceRequest):
    """Update secret request model.

    Attributes:
        metadata (dict[str, str] | None): The metadata of the secret.
        name (str): The name of the secret.
        new_secret_name (str | None): The new name of the secret.
        secret_comment (str | None): The comment for the secret.
        secret_metadata (list[Metadata] | None): The metadata of the secret.
        secret_path (str): The path to the secret.
        secret_reminder_note (str | None): The reminder note for the secret.
        secret_reminder_recipients (list[str] | None): The recipients of the reminder.
        secret_reminder_repeat_days (int | None): The number of days to repeat the reminder.
        secret_type (SecretType): The type of the secret.
        secret_value (str | None): The value of the secret.
        skip_multiline_encoding (bool | None): Whether to skip multiline encoding.
        tag_ids (list[str] | None): The IDs of the tags associated with the secret.
        workspace_id (str): The ID of the workspace.
        environment (str): The environment name.
    """

    metadata: Annotated[dict[str, str] | None, Field(alias="metadata", default=None)]
    name: Annotated[str, Field(exclude=True)]
    new_secret_name: Annotated[str | None, Field(alias="newSecretName", default=None, min_length=1)]
    secret_comment: Annotated[str | None, Field(alias="secretComment", default=None)]
    secret_metadata: Annotated[list[Metadata] | None, Field(alias="secretMetadata", default=None)]
    secret_path: Annotated[str, Field(alias="secretPath", default="/")]
    secret_reminder_note: Annotated[str | None, Field(alias="secretReminderNote", default=None, max_length=1024)]
    secret_reminder_recipients: Annotated[list[str] | None, Field(alias="secretReminderRecipients", default=None)]
    secret_reminder_repeat_days: Annotated[int | None, Field(alias="secretReminderRepeatDays", default=None)]
    secret_type: Annotated[SecretType, Field(alias="type", default="shared")]
    secret_value: Annotated[str | None, Field(alias="secretValue", default=None)]
    skip_multiline_encoding: Annotated[bool | None, Field(alias="skipMultilineEncoding", default=None)]
    tag_ids: Annotated[list[str] | None, Field(alias="tagIds", default=None)]

DeleteSecretRequest

Bases: InfisicalResourceRequest

Create secret request model.

Attributes:

Name Type Description
name str

The name of the secret.
secret_path str

The path to the secret.
secret_type SecretType

The type of the secret.
workspace_id str

The ID of the workspace.
environment str

The environment name.
Source code in src/infisical/resources/secrets/models.py 
222
223
224
225
226
227
228
229
230
231
232
233
234
235
class DeleteSecretRequest(InfisicalResourceRequest):
    """Create secret request model.

    Attributes:
        name (str): The name of the secret.
        secret_path (str): The path to the secret.
        secret_type (SecretType): The type of the secret.
        workspace_id (str): The ID of the workspace.
        environment (str): The environment name.
    """

    name: Annotated[str, Field(exclude=True)]
    secret_path: Annotated[str, Field(alias="secretPath", default="/")]
    secret_type: Annotated[SecretType, Field(alias="type", default="shared")]

SecretApprovalResponse

Bases: BaseModel

Secret approval response model.

Attributes:

Name Type Description
approval_id str

The ID of the approval.
bypass_reason str | None

The reason for bypassing the approval.
committer_user_id str

The ID of the user who committed the change.
conflicts Any

The conflicts associated with the approval.
created_at datetime

The creation date of the approval.
folder_id str

The ID of the folder.
has_merged bool

Whether the approval has been merged.
is_replicated bool | None

Whether the approval is replicated.
policy_id str

The ID of the policy.
slug str

The slug of the approval.
status_changed_by_user_id str | None

The ID of the user who changed the status.
status str

The status of the approval.
updated_at datetime

The last updated date of the approval.
Source code in src/infisical/resources/secrets/models.py 
238
239
240
241
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
class SecretApprovalResponse(BaseModel):
    """Secret approval response model.

    Attributes:
        approval_id (str): The ID of the approval.
        bypass_reason (str | None): The reason for bypassing the approval.
        committer_user_id (str): The ID of the user who committed the change.
        conflicts (Any): The conflicts associated with the approval.
        created_at (datetime.datetime): The creation date of the approval.
        folder_id (str): The ID of the folder.
        has_merged (bool): Whether the approval has been merged.
        is_replicated (bool | None): Whether the approval is replicated.
        policy_id (str): The ID of the policy.
        slug (str): The slug of the approval.
        status_changed_by_user_id (str | None): The ID of the user who changed the status.
        status (str): The status of the approval.
        updated_at (datetime.datetime): The last updated date of the approval.
    """

    approval_id: Annotated[str, Field(alias="id")]
    bypass_reason: Annotated[str | None, Field(alias="bypassReason", default=None)]
    committer_user_id: Annotated[str, Field(alias="committerUserId")]
    conflicts: Annotated[Any, Field(alias="type", default=None)]
    created_at: Annotated[datetime.datetime, Field(alias="createdAt")]
    folder_id: Annotated[str, Field(alias="folderId")]
    has_merged: Annotated[bool, Field(alias="hasMerged", default=False)]
    is_replicated: Annotated[bool | None, Field(alias="isReplicated", default=None)]
    policy_id: Annotated[str, Field(alias="policyId")]
    slug: Annotated[str, Field(alias="slug")]
    status_changed_by_user_id: Annotated[str | None, Field(alias="statusChangedByUserId", default=None)]
    status: Annotated[str, Field()]
    updated_at: Annotated[datetime.datetime, Field(alias="updatedAt")]