Skip to main content

Update keypair access

Update keypair access commands begin with:

smctl keypair update-access

or

smctl kp update-access

Flags

The update keypair access command supports these flags:

tabel 1. Flags for updating keypair access

Shortcut

Flag

Description

--groups string

Group IDs for keypair. 

Format:

--groups="<value>"

--operation string

Overwrites the keypair access with the provided input. 

Format:

--operation="<value>"

--operation add

Used to add to the existing user or groups.

--operation remove

Used to remove the specified inputs from users or groups.

--restricted

Restricted or open. The default is restricted.

--users string

User IDs for keypair. 

Format:

--users="<value>"

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for update-access.


Examples

Description: Update keypair access for the provided keypair ID with the specified groups.

Command:

smctl keypair update-access <keypair ID> --groups <user group ID>

Command sample:

smctl keypair update-access a609c6e6-fc89-48ff-a071-1d7001580452 --groups 15cd4b2a-699c-4466-8c58-ceaee3e63583

Description: Update keypair access for the provided keypair ID to add the existing group.

Command:

smctl keypair update-access <keypair ID> --groups <user group ID> --operation <overwrite, add or remove>

Command sample:

smctl keypair update-access a609c6e6-fc89-48ff-a071-1d7001580452 --groups 7dcf0e76-362c-4410-b521-fef05b10c661 --operation add

Description: Update keypair access for the provided keypair ID to remove the existing group.

Command:

smctl keypair update-access <keypair ID> --groups <user group ID> --operation <overwrite, add or remove>

Command sample:

smctl keypair update-access a609c6e6-fc89-48ff-a071-1d7001580452 --groups 7dcf0e76-362c-4410-b521-fef05b10c661 --operation remove