Secret #

A Secret is an external data, encrypted by CloudForet.

Package : spaceone.api.secret.v1

Secret #

Secret Methods:

create #

Creates a new Secret. When creating the resource, external data is encrypted, and a secret_id is issued for data access by other microservices.

POST /secret/v1/secret/create

{
   "name": "aws-dev",
   "data": "********",
   "secret_type": "CREDENTIALS",
   "schema": "aws_access_key",
   "service_account_id": "sa-123456789012",
   "project_id": "project-123456789012",
   "domain_id": "domain-123456789012"
}

{
   "secret_id": "secret-123456789012",
   "name": "aws-dev",
   "secret_type": "CREDENTIALS",
   "tags": {},
   "schema": "aws_access_key",
   "provider": "aws",
   "service_account_id": "sa-123456789012",
   "project_id": "project-123456789012",
   "domain_id": "domain-123456789012",
   "created_at": "2022-01-01T06:10:14.851Z"
}

update #

Updates a specific Secret. You can make changes in Secret settings, including name andtags.

POST /secret/v1/secret/update

{
   "secret_id": "secret-123456789012",
   "name": "aws-dev2",
   "tags": { "a": "b"},
   "project_id": "project-123456789012",
   "release_project": true,
   "domain_id": "domain-123456789012"
}

{
   "secret_id": "secret-123456789012",
   "name": "aws-dev",
   "secret_type": "CREDENTIALS",
   "tags": {},
   "schema": "aws_access_key",
   "provider": "aws",
   "service_account_id": "sa-123456789012",
   "project_id": "project-123456789012",
   "domain_id": "domain-123456789012",
   "created_at": "2022-01-01T06:10:14.851Z"
}

delete #

Deletes a specific Secret. You must specify the secret_id of the Secret to delete.

POST /secret/v1/secret/delete

{
   "secret_id": "secret-123456789012",
   "domain_id": "domain-123456789012"
}

update_data #

Updates encrypted data of a specific Secret resource. For example, to change the parameter data, external data to encrypt, you can use update_data to create new encrypted data based on the changed data and store it in the Secret resource.

POST /secret/v1/secret/update-data

{
   "secret_id": "secret-123456789012",
    "data": "********",
    "domain_id": "domain-123456789012"
}

get_data #

Gets a specific Secret. Prints detailed information about the Secret, including name, tags, schema, and provider.

POST /secret/v1/secret/get-data

{
   "secret_id": "secret-123456789012",
   "domain_id": "domain-123456789012"
}

get #

Gets a specific Post. You must specify the post_id of the Post to get, and the board_id of the Board where the child Post to get belongs. Prints detailed information about the Post.

POST /secret/v1/secret/get

{
   "secret_id": "secret-123456789012",
   "domain_id": "domain-123456789012"
}

{
   "secret_id": "secret-123456789012",
   "name": "aws-dev",
   "secret_type": "CREDENTIALS",
   "tags": {},
   "schema": "aws_access_key",
   "provider": "aws",
   "service_account_id": "sa-123456789012",
   "project_id": "project-123456789012",
   "domain_id": "domain-123456789012",
   "created_at": "2022-01-01T06:10:14.851Z"
}

list #

Gets a list of all Posts. You can use a query to get a filtered list of Posts.

POST /secret/v1/secret/list

{
   "query": {},
   "domain_id": "domain-123456789012"
}

{
   "results": [
       {
          "secret_id": "secret-123456789012",
          "name": "aws-dev",
          "secret_type": "CREDENTIALS",
          "tags": {},
          "schema": "aws_access_key",
          "provider": "aws",
          "service_account_id": "sa-123456789012",
          "project_id": "project-123456789012",
          "domain_id": "domain-123456789012",
          "created_at": "2022-01-01T06:10:14.851Z"
       },
       {
           "secret_id": "secret-987654321098",
           "name": "plugin-credentials",
           "secret_type": "CREDENTIALS",
           "tags": {},
           "domain_id": "domain-123456789012",
           "created_at": "2022-01-01T02:31:01.709Z"
       }
   ],
   "total_count": 2
}

stat #

POST /secret/v1/secret/stat

Message #

CreateSecretRequest #

• name (string) Required

• data (Struct) Required

• secret_type (SecretType) Required

• domain_id (string) Required

• tags (Struct)

• schema (string)

• service_account_id (string)

• project_id (string)

• trusted_secret_id (string)

  
  

GetSecretRequest #

• secret_id (string) Required

• domain_id (string) Required

• only (string) Repeated

  
  

SecretDataInfo #

• data (Struct) Required

• encrypted (bool) Required

• encrypt_options (Struct) Required

  
  

SecretInfo #

• secret_id (string) Required

• name (string) Required

• secret_type (SecretType) Required

• tags (Struct) Required

• schema (string) Required

• provider (string) Required

• service_account_id (string) Required

• project_id (string) Required

• trusted_secret_id (string) Required

• domain_id (string) Required

• created_at (string) Required

  
  

SecretQuery #

• domain_id (string) Required

• query (Query)

• secret_id (string)

• name (string)

• secret_type (SecretType)

• schema (string)

• provider (string)

• service_account_id (string)

• trusted_secret_id (string)

  
  

SecretRequest #

• secret_id (string) Required

• domain_id (string) Required

  
  

SecretStatQuery #

• query (StatisticsQuery) Required

• domain_id (string) Required

  
  

SecretsInfo #

• results (SecretInfo) Repeated Required

• total_count (int32) Required

  
  

UpdateSecretDataRequest #

• secret_id (string) Required

• data (Struct) Required

• domain_id (string) Required

• schema (string)

  
  

UpdateSecretRequest #

• secret_id (string) Required

• domain_id (string) Required

• name (string)

• tags (Struct)

• project_id (string)

• release_project (bool)