> For the complete documentation index, see [llms.txt](https://cloudforet.gitbook.io/cloudforet-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cloudforet.gitbook.io/cloudforet-apis/content/en/secret/v1/trustedsecret.md).

# TrustedSecret

Trusted secret is a resource that stores and manages credentials. Trusted secret is merged with linked secret and used to access data in other microservices.

> **Package : spaceone.api.secret.v1**

\ <br>

## TrustedSecret

**TrustedSecret Methods:**

| Method                                                                                                                            | Request                                                                                                                                                            | Response                                                                                                                                         |
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#create)            | [CreateTrustedSecretRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#createtrustedsecretrequest)         | [TrustedSecretInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretinfo)         |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#update)            | [UpdateTrustedSecretRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#updatetrustedsecretrequest)         | [TrustedSecretInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretinfo)         |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#delete)            | [TrustedSecretRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretrequest)                     | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#empty)                                 |
| [**update\_data**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#update_data) | [UpdateTrustedSecretDataRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#updatetrustedsecretdatarequest) | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#empty)                                 |
| [**get\_data**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#get_data)       | [GetTrustedSecretDataRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#gettrustedsecretdatarequest)       | [TrustedSecretDataInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretdatainfo) |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#get)                  | [TrustedSecretRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretrequest)                     | [TrustedSecretInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretinfo)         |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#list)                | [TrustedSecretQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretquery)                         | [TrustedSecretsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretsinfo)       |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#stat)                | [TrustedSecretStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretstatquery)                 | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#struct)                               |

<br>

### create

Create a new trusted secret. Created trusted secret is encrypted and stored securely.

> **POST** /secret/v1/trusted-secret/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

[CreateTrustedSecretRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#createtrustedsecretrequest)

* **name** (string) `Required`
* **data** (Struct) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **schema\_id** (string)
* **tags** (Struct)
* **workspace\_id** (string)
* **trusted\_account\_id** (string)

{{< highlight json >}} { "name": "Cloudforet Broker Account - Managed", "data": "\*\*\*\*\*\*\*\*", "schema\_id": "aws\_access\_key", "trusted\_account\_id": "trusted-sa-123456789012", "tags": {} "resource\_group": "DOMAIN" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[TrustedSecretInfo](#TRUSTEDSECRETINFO)

* **trusted\_secret\_id** (string) `Required`
* **name** (string) `Required`
* **schema\_id** (string) `Required`
* **tags** (Struct) `Required`
* **provider** (string) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`

{{< highlight json >}} { "trusted\_secret\_id": "trusted-secret-123456789012", "name": "aws-dev", "tags": {}, "schema": "aws\_access\_key", "provider": "aws", "resource\_group": "DOMAIN", "trusted\_account\_id": "ta-123456789012", "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T06:10:14.851Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update

Updates a specific trusted secret's information. You can only change the 'name' and 'tags', and to change the data you must use the update\_data API.

> **POST** /secret/v1/trusted-secret/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

[UpdateTrustedSecretRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#updatetrustedsecretrequest)

* **trusted\_secret\_id** (string) `Required`
* **name** (string)
* **tags** (Struct)

{{< highlight json >}} { "trusted\_secret\_id": "trusted-secret-123456789012", "name": "aws-dev2", "tags": { "a": "b"} } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[TrustedSecretInfo](#TRUSTEDSECRETINFO)

* **trusted\_secret\_id** (string) `Required`
* **name** (string) `Required`
* **schema\_id** (string) `Required`
* **tags** (Struct) `Required`
* **provider** (string) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`

{{< highlight json >}} { "trusted\_secret\_id": "trusted-secret-123456789012", "name": "aws-dev", "tags": {}, "schema": "aws\_access\_key", "provider": "aws", "resource\_group": "DOMAIN", "trusted\_account\_id": "ta-123456789012", "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T06:10:14.851Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### delete

Deletes a specific trusted secret. If a trusted secret is attached to a Secret, it cannot be deleted.

> **POST** /secret/v1/trusted-secret/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

[TrustedSecretRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretrequest)

* **trusted\_secret\_id** (string) `Required`

{{< highlight json >}} { "trusted\_secret\_id": "trusted-secret-123456789012" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update\_data

Updates a specific trusted secret's data. Updated trusted secret is encrypted and stored securely.

> **POST** /secret/v1/trusted-secret/update-data

{{< tabs " update\_data " >}}

{{< tab "Request Example" >}}

[UpdateTrustedSecretDataRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#updatetrustedsecretdatarequest)

* **trusted\_secret\_id** (string) `Required`
* **schema\_id** (string) `Required`
* **data** (Struct) `Required`

{{< highlight json >}} { "trusted\_secret\_id": "trusted-secret-12345abcde", "data": "\*\*\*\*\*\*\*\*", } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get\_data

Get a specific secret's data. This API is for internal system use only.

{{< tabs " get\_data " >}}

{{< tab "Request Example" >}}

[GetTrustedSecretDataRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#gettrustedsecretdatarequest)

* **trusted\_secret\_id** (string) `Required`
* **domain\_id** (string) `Required`

{{< highlight json >}} { "trusted\_secret\_id": "ta-123456789012", "domain\_id": "domain-12345abcde" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get

Get a specific trusted secret's information.

> **POST** /secret/v1/trusted-secret/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

[TrustedSecretRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretrequest)

* **trusted\_secret\_id** (string) `Required`

{{< highlight json >}} { "trusted\_secret\_id": "trusted-secret-123456789012" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[TrustedSecretInfo](#TRUSTEDSECRETINFO)

* **trusted\_secret\_id** (string) `Required`
* **name** (string) `Required`
* **schema\_id** (string) `Required`
* **tags** (Struct) `Required`
* **provider** (string) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`

{{< highlight json >}} { "trusted\_secret\_id": "trusted-secret-123456789012", "name": "aws-dev", "tags": {}, "schema": "aws\_access\_key", "provider": "aws", "resource\_group": "DOMAIN", "trusted\_account\_id": "ta-123456789012", "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T06:10:14.851Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### list

Queries a list of trusted secrets. You can use a query to get a filtered list of trusted secrets.

> **POST** /secret/v1/trusted-secret/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

[TrustedSecretQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/secret/v1/TrustedSecret/README.md#trustedsecretquery)

* **query** (Query)
* **trusted\_secret\_id** (string)
* **name** (string)
* **schema\_id** (string)
* **provider** (string)
* **workspace\_id** (string)
* **trusted\_account\_id** (string)

{{< highlight json >}} { "query": {} } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[TrustedSecretsInfo](#TRUSTEDSECRETSINFO)

* **results** (TrustedSecretInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

{{< highlight json >}} { "results": \[ { "trusted\_secret\_id": "trusted-secret-12345abcde", "name": "Cloudforet Broker Account - Managed", "schema\_id": "aws-secret-access-key", "tags": {"foo": "bar"}, "provider": "aws", "resource\_group": "DOMAIN", "trusted\_account\_id": "ta-12345abcde", "domain\_id": "domain-12345abcde", "created\_at": "2022-01-01T06:10:14Z" }, { "trusted\_secret\_id": "trusted-secret-56789abcde", "name": "Customer Broker Account", "schema\_id": "aws-secret-access-key", "provider": "aws", "resource\_group": "WORKSPACE", "trusted\_account\_id": "ta-56789abcde", "domain\_id": "domain-12345abcde", "workspace\_id": "workspace-12345abcde", "created\_at": "2023-11-04T00:00:00Z" } ], "total\_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### stat

> **POST** /secret/v1/trusted-secret/stat

\ <br>

## Message

### CreateTrustedSecretRequest

* **name** (string) `Required`
* **data** (Struct) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **schema\_id** (string)
* **tags** (Struct)
* **workspace\_id** (string)
* **trusted\_account\_id** (string)

  <br>

### GetTrustedSecretDataRequest

* **trusted\_secret\_id** (string) `Required`
* **domain\_id** (string) `Required`

  <br>

### TrustedSecretDataInfo

* **encrypted** (bool) `Required`
* **encrypt\_options** (Struct) `Required`
* **data** (Struct) `Required`

  <br>

### TrustedSecretInfo

* **trusted\_secret\_id** (string) `Required`
* **name** (string) `Required`
* **schema\_id** (string) `Required`
* **tags** (Struct) `Required`
* **provider** (string) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **trusted\_account\_id** (string) `Required`
* **created\_at** (string) `Required`

  <br>

### TrustedSecretQuery

* **query** (Query)
* **trusted\_secret\_id** (string)
* **name** (string)
* **schema\_id** (string)
* **provider** (string)
* **workspace\_id** (string)
* **trusted\_account\_id** (string)

  <br>

### TrustedSecretRequest

* **trusted\_secret\_id** (string) `Required`

  <br>

### TrustedSecretStatQuery

* **query** (StatisticsQuery) `Required`
* **domain\_id** (string) `Required`

  <br>

### TrustedSecretsInfo

* **results** (TrustedSecretInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

  <br>

### UpdateTrustedSecretDataRequest

* **trusted\_secret\_id** (string) `Required`
* **schema\_id** (string) `Required`
* **data** (Struct) `Required`

  <br>

### UpdateTrustedSecretRequest

* **trusted\_secret\_id** (string) `Required`
* **name** (string)
* **tags** (Struct)

  <br>