keyring_secret_update
Sectech
Updates the details of a user created secret.
Only secrets not used (not referenced in configuration) can be updated.
Params
Either new_id or note must be present.
| attribute | description |
|---|---|
old_id*string |
Unique ID of the secret to update |
new_id string; ^[a-zA-Z][a-zA-Z0-9_]{0,127}$ |
New unique ID of the secret. It will be left unchangeg if omitted. |
note string |
User description of the secret. It will be left unchanged if omitted. |
Return
| attribute | description |
|---|---|
secrets* [Secret status] |
An array with the status of the secrets present in the device |
Secret status
| attribute | description |
|---|---|
id* string |
Unique human readable key of the secret |
type* 'pkey_cert'|'cert_single'|'cert_chain'|'dhparam'|'remote_access'|'ssh_private'|'uftp'|'psk'|'openvpn' |
The secret type |
is_empty bool |
Indicates if the secret is empty. If not spcified false is assumed. |
note string |
User description of the secret |
expiry_tstamp unsigned integer |
The secret expiry time if applicable |
is_read_only bool |
Indicates manufacturer provided certificate that the user can not remove or alter. Default value is false |