Create or Update a secret value in a user scope

PUT

/user/actions/secrets/{secretname}

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

secretname

required

string

Name of the secret

Request Body

Media typeapplication/json

CreateOrUpdateSecretOption defines the properties of the secret to create or update.

object

data

required

Data of the secret. Special characters will be retained. Line endings will be normalized to LF to match the behaviour of browsers. Encode the data with Base64 if line endings should be retained.

string

Example^generated

{
  "data": "example"
}

Responses

201

Response when creating a secret

Media typeapplication/json

204

Response when updating a secret

Media typeapplication/json

400

APIError is error format response

Media typeapplication/json

APIError is an api error with a message

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

401

APIUnauthorizedError is a unauthorized error response

Media typeapplication/json

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

403

APIForbiddenError is a forbidden error response

Media typeapplication/json

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

404

APINotFound is a not found error response

Media typeapplication/json

object

errors

Array<string>

message

string

url

string

Example^generated

{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}