UserSecret #

UserSecret is a service that stores and manages credentials. UserSecret is used to store credentials for a specific user.

Package : spaceone.api.user_secret.v1

UserSecret #

UserSecret Methods:

create #

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

POST /secret/v1/user-secret/create

{
   "name": "Cloudforet AWS Dev",
   "data": "********",
   "schema_id": "aws_access_key",
}

{
   "user_secret_id": "user_secret-123456789012",
   "name": "aws-dev",
   "tags": {},
   "schema_id": "aws_access_key",
   "provider": "aws",
   "user_id": "whdalsrnt@gmail.com",
   "domain_id": "domain-123456789012",
   "created_at": "2022-01-01T06:10:14.851Z"
}

update #

Updates a specific user 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/user-secret/update

{
   "user_secret_id": "user-secret-123456789012",
   "name": "aws-dev2",
   "tags": { "a": "b"}
}

{
   "user_secret_id": "user_secret-123456789012",
   "name": "aws-dev",
   "tags": {},
   "schema_id": "aws_access_key",
   "provider": "aws",
   "user_id": "whdalsrnt@gmail.com",
   "domain_id": "domain-123456789012",
   "created_at": "2022-01-01T06:10:14.851Z"
}

delete #

Deletes a specific user secret.

POST /secret/v1/user-secret/delete

{
   "user_secret_id": "user-secret-123456789012"
}

update_data #

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

POST /secret/v1/user-secret/update-data

{
   "user_secret_id": "user-secret-123456789012",
    "data": "********"
}

get_data #

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

{
   "user_secret_id": "user-secret-123456789012",
   "domain_id": "domain-12345abcde"
}

get #

Get a specific user secret’s information.

POST /secret/v1/user-secret/get

{
   "user_secret_id": "user-secret-123456789012"
}

{
   "user_secret_id": "user_secret-123456789012",
   "name": "aws-dev",
   "tags": {},
   "schema_id": "aws_access_key",
   "provider": "aws",
   "user_id": "whdalsrnt@gmail.com",
   "domain_id": "domain-123456789012",
   "created_at": "2022-01-01T06:10:14.851Z"
}

list #

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

POST /secret/v1/user-secret/list

{
   "query": {}
}

{
   "results": [
       {
          "user_secret_id": "user_secret-123456789012",
          "name": "aws-dev",
          "tags": {},
          "schema": "aws_access_key",
          "provider": "aws",
          "user_id": "whdalsrnt@gmail",
          "domain_id": "domain-123456789012",
          "created_at": "2022-01-01T06:10:14.851Z"
       },
       {
           "user_secret_id": "user_secret-987654321098",
           "name": "plugin-credentials",
           "tags": {},
           "user_id": "whdalsrnt@gmail.com",
           "domain_id": "domain-123456789012",
           "created_at": "2022-01-01T02:31:01.709Z"
       }
   ],
   "total_count": 2
}

stat #

POST /secret/v1/user-secret/stat

Message #

CreateUserSecretRequest #

• name (string) Required

• data (Struct) Required

• schema_id (string)

• tags (Struct)

  
  

GetUserSecretDataRequest #

• user_secret_id (string) Required

• domain_id (string) Required

  
  

UpdateUserSecretDataRequest #

• user_secret_id (string) Required

• schema_id (string) Required

• data (Struct) Required

  
  

UpdateUserSecretRequest #

• user_secret_id (string) Required

• name (string)

• tags (Struct)

  
  

UserSecretDataInfo #

• encrypted (bool) Required

• encrypt_options (Struct) Required

• data (Struct) Required

  
  

UserSecretInfo #

• user_secret_id (string) Required

• name (string) Required

• schema_id (string) Required

• provider (string) Required

• tags (Struct) Required

• domain_id (string) Required

• user_id (string) Required

• created_at (string) Required

  
  

UserSecretQuery #

• query (Query)

• user_secret_id (string)

• name (string)

• schema_id (string)

• provider (string)

  
  

UserSecretRequest #

• user_secret_id (string) Required

  
  

UserSecretStatQuery #

• query (StatisticsQuery) Required

• domain_id (string) Required

  
  

UserSecretsInfo #

• results (UserSecretInfo) Repeated Required

• total_count (int32) Required