Secret

A Secret is an external data, encrypted by CluodForet.

Package : spaceone.api.secret.v1

Secret

Secret Methods:

Method	Request	Response
create	CreateSecretRequest	SecretInfo
update	UpdateSecretRequest	SecretInfo
delete	SecretRequest	google.protobuf.Empty
update_data	UpdateSecretDataRequest	google.protobuf.Empty
get_data	SecretRequest	SecretDataInfo
get	GetSecretRequest	SecretInfo
list	SecretQuery	SecretsInfo
stat	SecretStatQuery	google.protobuf.Struct

create

POST /secret/v1/secrets

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

Type	Message
Request	CreateSecretRequest
Response	SecretInfo

Request Example

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

Response Example

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

PUT /secret/v1/secret/{secret_id}

Type	Message
Request	UpdateSecretRequest
Response	SecretInfo

delete

DELETE /secret/v1/secret/{secret_id}

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

Type	Message
Request	SecretRequest
Response	google.protobuf.Empty

Request Example

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

update_data

PUT /secret/v1/secret/{secret_id}/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.

Type	Message
Request	UpdateSecretDataRequest
Response	google.protobuf.Empty

Request Example

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

Response Example

{
    "data": {
        "encrypted_data": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    },
    "encrypted": true,
    "encrypt_options": {
        "encrypted_data_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "encrypt_algorithm": "CloudForet_DEFAULT"
    }
}

get_data

GET /secret/v1/secret/{secret_id}/data

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

Type	Message
Request	SecretRequest
Response	SecretDataInfo

Request Example

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

Response Example

{
    "data": {
        "encrypted_data": "xxxxxxxxxxxxxxxxxx"
    },
    "encrypted": true,
    "encrypt_options": {
        "encrypt_algorithm": "SPACEONE_DEFAULT",
        "encrypted_data_key": "xxxxxx"
    }
}

get

GET /secret/v1/secret/{secret_id}

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.

Type	Message
Request	GetSecretRequest
Response	SecretInfo

Request Example

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

Response Example

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

GET /secret/v1/secrets

POST /secret/v1/secrets/search

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

Type	Message
Request	SecretQuery
Response	SecretsInfo

Request Example

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

Response Example

{
    "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/secrets/stat

Type	Message
Request	SecretStatQuery
Response	google.protobuf.Struct

Message

CreateSecretRequest

Field	Type	Required	Description
name	string	✔
data	google.protobuf.Struct	✔
secret_type	NONE CREDENTIALS	✔
tags	google.protobuf.Struct	✘
schema	string	✘
service_account_id	string	✘
project_id	string	✘
domain_id	string	✔

GetSecretRequest

Field	Type	Required	Description
secret_id	string	✔
domain_id	string	✔
only	list of string	✘

SecretDataInfo

Field	Type	Description
data	google.protobuf.Struct
encrypted	bool
encrypt_options	google.protobuf.Struct

SecretInfo

Field	Type	Description
secret_id	string
name	string
secret_type	NONE CREDENTIALS
secret_groups	google.protobuf.ListValue
tags	google.protobuf.Struct
schema	string
provider	string
service_account_id	string
project_id	string
domain_id	string
created_at	string

SecretQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
secret_id	string	✘
name	string	✘
secret_type	NONE CREDENTIALS	✘
secret_group_id	string	✘
schema	string	✘
provider	string	✘
service_account_id	string	✘
include_secret_group	bool	✘
domain_id	string	✔

SecretRequest

Field	Type	Required	Description
secret_id	string	✔
domain_id	string	✔

SecretStatQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔
domain_id	string	✔

SecretsInfo

Field	Type	Description
results	list of SecretInfo
total_count	int32

UpdateSecretDataRequest

Field	Type	Required	Description
secret_id	string	✔
data	google.protobuf.Struct	✔
domain_id	string	✔
schema	string	✘

UpdateSecretRequest

Field	Type	Required	Description
secret_id	string	✔
name	string	✘
tags	google.protobuf.Struct	✘
project_id	string	✘
domain_id	string	✔
release_project	bool	✘