TrustedSecret

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



TrustedSecret #

TrustedSecret Methods:

MethodRequestResponse
createCreateTrustedSecretRequestTrustedSecretInfo
updateUpdateTrustedSecretRequestTrustedSecretInfo
deleteTrustedSecretRequestEmpty
update_dataUpdateTrustedSecretDataRequestEmpty
get_dataGetTrustedSecretDataRequestTrustedSecretDataInfo
getTrustedSecretRequestTrustedSecretInfo
listTrustedSecretQueryTrustedSecretsInfo
statTrustedSecretStatQueryStruct

create #

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

POST /secret/v1/trusted-secret/create

CreateTrustedSecretRequest

  • name (string) Required

  • data (Struct) Required

  • resource_group (ResourceGroup) Required

  • schema_id (string)

  • tags (Struct)

  • workspace_id (string)

  • trusted_account_id (string)

{
   "name": "Cloudforet Broker Account - Managed",
   "data": "********",
   "schema_id": "aws_access_key",
   "trusted_account_id": "trusted-sa-123456789012",
   "tags": {}
   "resource_group": "DOMAIN"
}

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

{
   "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"
}

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

UpdateTrustedSecretRequest

  • trusted_secret_id (string) Required

  • name (string)

  • tags (Struct)

{
   "trusted_secret_id": "trusted-secret-123456789012",
   "name": "aws-dev2",
   "tags": { "a": "b"}
}

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

{
   "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"
}

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

TrustedSecretRequest

  • trusted_secret_id (string) Required
{
   "trusted_secret_id": "trusted-secret-123456789012"
}

update_data #

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

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

UpdateTrustedSecretDataRequest

  • trusted_secret_id (string) Required

  • schema_id (string) Required

  • data (Struct) Required

{
   "trusted_secret_id": "trusted-secret-12345abcde",
   "data": "********",
}

get_data #

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

GetTrustedSecretDataRequest

  • trusted_secret_id (string) Required

  • domain_id (string) Required

{
   "trusted_secret_id": "ta-123456789012",
   "domain_id": "domain-12345abcde"
}

get #

Get a specific trusted secret’s information.

POST /secret/v1/trusted-secret/get

TrustedSecretRequest

  • trusted_secret_id (string) Required
{
   "trusted_secret_id": "trusted-secret-123456789012"
}

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

{
   "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"
}

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

TrustedSecretQuery

  • query (Query)

  • trusted_secret_id (string)

  • name (string)

  • schema_id (string)

  • provider (string)

  • workspace_id (string)

  • trusted_account_id (string)

{
   "query": {}
}

TrustedSecretsInfo

  • results (TrustedSecretInfo) Repeated Required

  • total_count (int32) Required

{
   "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
}

stat #

POST /secret/v1/trusted-secret/stat



Message #

CreateTrustedSecretRequest #

  • name (string) Required

  • data (Struct) Required

  • resource_group (ResourceGroup) Required

  • schema_id (string)

  • tags (Struct)

  • workspace_id (string)

  • trusted_account_id (string)


GetTrustedSecretDataRequest #

  • trusted_secret_id (string) Required

  • domain_id (string) Required


TrustedSecretDataInfo #

  • encrypted (bool) Required

  • encrypt_options (Struct) Required

  • data (Struct) Required


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


TrustedSecretQuery #

  • query (Query)

  • trusted_secret_id (string)

  • name (string)

  • schema_id (string)

  • provider (string)

  • workspace_id (string)

  • trusted_account_id (string)


TrustedSecretRequest #

  • trusted_secret_id (string) Required


TrustedSecretStatQuery #

  • query (StatisticsQuery) Required

  • domain_id (string) Required


TrustedSecretsInfo #

  • results (TrustedSecretInfo) Repeated Required

  • total_count (int32) Required


UpdateTrustedSecretDataRequest #

  • trusted_secret_id (string) Required

  • schema_id (string) Required

  • data (Struct) Required


UpdateTrustedSecretRequest #

  • trusted_secret_id (string) Required

  • name (string)

  • tags (Struct)


Calendar November 4, 2024
Edit Edit this page