serviceaccount - Control Plane

Manage service accounts For a detailed overview, please visit the service account’s reference page.

cpln serviceaccount [SUBCOMMAND]

Commands:
  cpln serviceaccount access-report <ref>  Show the access report for the referenced service account
  cpln serviceaccount add-key <ref>        Add a key to the reference service account
  cpln serviceaccount audit [ref]          Retrieve audit trail events for the referenced service account
  cpln serviceaccount clone <ref>          Create a clone of the referenced service account; this will only duplicate its spec.  [aliases: copy]
  cpln serviceaccount create               Create a new service account
  cpln serviceaccount delete <ref...>      Delete one or more referenced service accounts
  cpln serviceaccount edit <ref>           Edit the referenced service account, as YAML, within an editor
  cpln serviceaccount eventlog <ref>       Show the event log of the referenced service account  [aliases: log]
  cpln serviceaccount get [ref...]         Retrieve one or more referenced service accounts
  cpln serviceaccount patch <ref>          Update the referenced service account's metadata using an input file
  cpln serviceaccount permissions          Show the grantable permissions for a service account object type
  cpln serviceaccount query                Find all the service accounts based on the given query
  cpln serviceaccount remove-key <ref>     Remove a key from the reference service account
  cpln serviceaccount tag <ref...>         Manage the tags belonging to one or more referenced service accounts

Options:
  --help  Show help  [boolean]

serviceaccount access-report

Show the access report for the referenced service account Usage

cpln serviceaccount access-report <ref> [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln serviceaccount access-report demo-service-account --org demo-cpln-organization

+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL                                               |GRANTED |
|-----------|--------------------------------------------------------|--------|
|addKey     |/org/demo-cpln-organization/group/superusers            |manage  |
|addKey     |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|create     |/org/demo-cpln-organization/group/superusers            |manage  |
|create     |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|delete     |/org/demo-cpln-organization/group/superusers            |manage  |
|delete     |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|edit       |/org/demo-cpln-organization/group/superusers            |manage  |
|edit       |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|manage     |/org/demo-cpln-organization/group/superusers            |manage  |
|manage     |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|view       |/org/demo-cpln-organization/group/superusers            |manage  |
|view       |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|view       |/org/demo-cpln-organization/group/viewers               |view    |
+-----------+--------------------------------------------------------+--------+

serviceaccount add-key

Add a key to the reference service account Usage

cpln serviceaccount add-key <ref> --description KEY_DESCRIPTION [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --description, --desc  Short description for the new key  [required]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

The ‘key’ property returned from the add-key command will only be displayed once. There is no way to retrieve the key in the future.

cpln serviceaccount add-key demo-service-account --desc demo-key --org demo-cpln-organization

{
  "description": "demo-key",
  "created": "2026-10-07T16:46:08.269Z",
  "key": "sjZSvAYLTYQlJBW0.ZGVtby1jcGxuLW9yZ2FuaXphdGlvbi5kZW1vLXNlcnZpY2UtYWNjb3VudC5VVU0yUkNVc2d2dHpqSTJuV2tCdUtWUTVldm05eThrRDlnSFFjVmI3cHpvPQ.QvwqxKJXH60NPqYM9202LatKe3dOmOxQAOf7fmira00"
}

serviceaccount audit

Retrieve audit trail events for the referenced service account Usage

cpln serviceaccount audit [ref] [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.

Command options:
  --subject  Filter by subject (serviceaccount name or user email)  [string]
  --context  Audit context name (the 'cpln' context displays Control Plane actions)  [string] [default: "cpln"]
  --since    Relative lookback window from now (e.g., 1h, 24h, 7d). Mutually exclusive with --from/--to  [string] [default: "7d"]
  --from     Start time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 7d, 1h). Cannot be used with --since  [string]
  --to       End time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 1d, 30m)  [string]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

serviceaccount clone

Create a clone of the referenced service account; this will only duplicate its spec. Usage

cpln serviceaccount clone <ref> --name CLONE_NAME [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --name         Set the name for the clone  [required]
  --description  Optional description, defaults to the name if not set
  --tag          Attach tags (e.g., --tag drink=water)
  --dry-run      Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln serviceaccount clone demo-service-account --name demo-service-account-clone --org demo-cpln-organization

+---------------------------+------------------------------+--------+--------+-----+--------------+
|NAME                       |DESCRIPTION                   |CREATED |ORIGIN  |KEYS |TAGS          |
|---------------------------|------------------------------|--------|--------|-----|--------------|
|demo-service-account-clone |Clone of demo-service-account |Now     |default |     |drink="water" |
+---------------------------+------------------------------+--------+--------+-----+--------------+

serviceaccount create

Create a new service account Usage

cpln serviceaccount create --name SERVICE_ACCOUNT_NAME [OPTIONS]

Reference

Command options:
  --name                 Name of the new secret  [required]
  --description, --desc  Optional description, defaults to the name if not set
  --tag                  Attach tags (e.g., --tag drink=water)
  --dry-run              Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln serviceaccount create --name demo-service-account --desc demo-service-account --tag drink=water --org demo-cpln-organization

+---------------------+---------------------+--------+--------+-----+--------------+
|NAME                 |DESCRIPTION          |CREATED |ORIGIN  |KEYS |TAGS          |
|---------------------|---------------------|--------|--------|-----|--------------|
|demo-service-account |demo-service-account |Now     |default |     |drink="water" |
+---------------------+---------------------+--------+--------+-----+--------------+

serviceaccount delete

Delete one or more referenced service accounts Usage

cpln serviceaccount delete <ref...> [OPTIONS]

Deleting a service account will remove all associated keys

Reference

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln serviceaccount delete demo-service-account --org demo-cpln-organization

If the delete was successful, a new command prompt will be shown.

serviceaccount edit

Edit the referenced service account, as YAML, within an editor Usage

cpln serviceaccount edit <ref> [OPTIONS]

The default editor can be set by using the EDITOR environment variable.

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --replace, -r  Replace instead of patch/merge  [boolean] [default: false]
  --dry-run      Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln serviceaccount edit demo-service-account --org demo-cpln-organization

Your default editor will be launched.

Once any modifications are saved, the updates will be sent to the API.

serviceaccount eventlog

Show the event log of the referenced service account Usage

cpln serviceaccount eventlog <ref> [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln serviceaccount eventlog demo-service-account --org demo-cpln-organization

The event log for the referenced service account will be shown.

serviceaccount get

Retrieve one or more referenced service accounts Usage

cpln serviceaccount get [ref...] [OPTIONS]

An empty reference will return all references

Reference

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [default: []]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Get all service accounts

cpln serviceaccount get --org demo-cpln-organization

+---------------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
|NAME                       |DESCRIPTION                              |CREATED        |ORIGIN  |KEYS             |TAGS          |
|---------------------------|-----------------------------------------|---------------|--------|-----------------|--------------|
|controlplane               |Built-in serviceaccount used by Contr... |5 years ago    |builtin |                 |              |
|cpln-user                  |cpln-user                                |2 years ago    |default |sOajhentlsc226k8 |              |
|demo-service-account       |demo-service-account                     |11 minutes ago |default |sjZSvAYLTYQlJBW0 |drink="water" |
|demo-service-account-get-1 |demo-service-account-get-1               |Now            |default |                 |              |
|demo-service-account-get-2 |demo-service-account-get-2               |Now            |default |                 |              |
+---------------------------+-----------------------------------------+---------------+--------+-----------------+--------------+

Get one service account

cpln serviceaccount get demo-service-account-get-1 --org demo-cpln-organization

+---------------------------+---------------------------+--------+--------+-----+-----+
|NAME                       |DESCRIPTION                |CREATED |ORIGIN  |KEYS |TAGS |
|---------------------------|---------------------------|--------|--------|-----|-----|
|demo-service-account-get-1 |demo-service-account-get-1 |Now     |default |     |     |
+---------------------------+---------------------------+--------+--------+-----+-----+

Get multiple service accounts

cpln serviceaccount get demo-service-account-get-1 demo-service-account-get-2 --org demo-cpln-organization

+---------------------------+---------------------------+--------+--------+-----+-----+
|NAME                       |DESCRIPTION                |CREATED |ORIGIN  |KEYS |TAGS |
|---------------------------|---------------------------|--------|--------|-----|-----|
|demo-service-account-get-1 |demo-service-account-get-1 |Now     |default |     |     |
|demo-service-account-get-2 |demo-service-account-get-2 |Now     |default |     |     |
+---------------------------+---------------------------+--------+--------+-----+-----+

serviceaccount patch

Update the referenced service account’s metadata using an input file Usage

cpln serviceaccount patch <ref> --file FILE_NAME [OPTIONS]

Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --file, -f  File to load the patch from. Use `--file -` to enable input from stdin.  [required]
  --dry-run   Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln serviceaccount patch demo-service-account --file update.json --org demo-cpln-organization

The changes within the JSON file will be performed against the referenced service account.

serviceaccount permissions

Show the grantable permissions for a service account object type Usage

cpln serviceaccount permissions [OPTIONS]

Reference

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln serviceaccount permissions --org demo-cpln-organization

+-------+---------------------------------------+-------------------------------------------+
|NAME   |DESCRIPTION                            |IMPLIES                                    |
|-------|---------------------------------------|-------------------------------------------|
|addKey |Add key to an existing service account |                                           |
|create |Create new service accounts            |                                           |
|delete |Delete service accounts                |                                           |
|edit   |Modify existing resources              |view                                       |
|manage |Full access                            |addKey, create, delete, edit, manage, view |
|view   |Read-only access                       |                                           |
+-------+---------------------------------------+-------------------------------------------+

serviceaccount query

Find all the service accounts based on the given query Usage

cpln serviceaccount query QUERY_OPTIONS [OPTIONS]

Reference

Query options:
  --match             Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --property, --prop  Property to query
  --tag               Tag to query
  --rel               Relation to query

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Use the --match option to display all, none, or any of the results based on a given property or tag

Search for a service account based on the name property

cpln serviceaccount query --match any --prop name=demo-service-account --org demo-cpln-organization

+---------------------+---------------------+---------------+--------+-----------------+--------------+
|NAME                 |DESCRIPTION          |CREATED        |ORIGIN  |KEYS             |TAGS          |
|---------------------|---------------------|---------------|--------|-----------------|--------------|
|demo-service-account |demo-service-account |11 minutes ago |default |sjZSvAYLTYQlJBW0 |drink="water" |
+---------------------+---------------------+---------------+--------+-----------------+--------------+

Search for a service account based on the description property

cpln serviceaccount query --match any --prop description="demo-service-account" --org demo-cpln-organization

+---------------------+---------------------+---------------+--------+-----------------+--------------+
|NAME                 |DESCRIPTION          |CREATED        |ORIGIN  |KEYS             |TAGS          |
|---------------------|---------------------|---------------|--------|-----------------|--------------|
|demo-service-account |demo-service-account |11 minutes ago |default |sjZSvAYLTYQlJBW0 |drink="water" |
+---------------------+---------------------+---------------+--------+-----------------+--------------+

Search for a service account based on a tag

cpln serviceaccount query --match any --tag drink=water --org demo-cpln-organization

+---------------------+---------------------+---------------+--------+-----------------+--------------+
|NAME                 |DESCRIPTION          |CREATED        |ORIGIN  |KEYS             |TAGS          |
|---------------------|---------------------|---------------|--------|-----------------|--------------|
|demo-service-account |demo-service-account |11 minutes ago |default |sjZSvAYLTYQlJBW0 |drink="water" |
+---------------------+---------------------+---------------+--------+-----------------+--------------+

Search for a service account based on a property and tag

cpln serviceaccount query --match any --prop description="demo-service-account" --tag drink=water --org demo-cpln-organization

+---------------------+---------------------+---------------+--------+-----------------+--------------+
|NAME                 |DESCRIPTION          |CREATED        |ORIGIN  |KEYS             |TAGS          |
|---------------------|---------------------|---------------|--------|-----------------|--------------|
|demo-service-account |demo-service-account |11 minutes ago |default |sjZSvAYLTYQlJBW0 |drink="water" |
+---------------------+---------------------+---------------+--------+-----------------+--------------+

serviceaccount remove-key

Remove a key from the reference service account Usage

cpln serviceaccount remove-key <ref> --key KEY_TO_REMOVE [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --key      Name of the key to remove. Can be repeated.  [required]
  --dry-run  Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

For the example below, the created service account key is:

+---------------------+---------------------+--------+--------+-----+--------------+
|NAME                 |DESCRIPTION          |CREATED |ORIGIN  |KEYS |TAGS          |
|---------------------|---------------------|--------|--------|-----|--------------|
|demo-service-account |demo-service-account |Now     |default |     |drink="water" |
+---------------------+---------------------+--------+--------+-----+--------------+

Remove key

cpln serviceaccount remove-key demo-service-account --key socuAZ3nzwyAzUgg --org demo-cpln-organization

+---------------------+---------------------+---------------+--------+-----------------+--------------+
|NAME                 |DESCRIPTION          |CREATED        |ORIGIN  |KEYS             |TAGS          |
|---------------------|---------------------|---------------|--------|-----------------|--------------|
|demo-service-account |demo-service-account |11 minutes ago |default |sjZSvAYLTYQlJBW0 |drink="water" |
+---------------------+---------------------+---------------+--------+-----------------+--------------+

serviceaccount tag

Manage the tags belonging to one or more referenced service accounts Usage

cpln serviceaccount tag <ref...> --tag KEY=VALUE [OPTIONS]

Built-in tags, which begin with cpln/*, can’t be modified.

Reference

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]

Command options:
  --tag         Attach tags (e.g., --tag drink=water)
  --remove-tag  Remove tags (e.g., --remove-tag tagname)
  --dry-run     Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Add a tag to a service account

cpln serviceaccount tag demo-service-account-tag-1 --tag drink=water --org demo-cpln-organization

+---------------------------+---------------------------+--------+--------+-----+--------------+
|NAME                       |DESCRIPTION                |CREATED |ORIGIN  |KEYS |TAGS          |
|---------------------------|---------------------------|--------|--------|-----|--------------|
|demo-service-account-tag-1 |demo-service-account-tag-1 |Now     |default |     |drink="water" |
+---------------------------+---------------------------+--------+--------+-----+--------------+

Update same tag (after running the example above)

cpln serviceaccount tag demo-service-account-tag-1 --tag drink=coffee --org demo-cpln-organization

+---------------------------+---------------------------+--------+--------+-----+---------------+
|NAME                       |DESCRIPTION                |CREATED |ORIGIN  |KEYS |TAGS           |
|---------------------------|---------------------------|--------|--------|-----|---------------|
|demo-service-account-tag-1 |demo-service-account-tag-1 |Now     |default |     |drink="coffee" |
+---------------------------+---------------------------+--------+--------+-----+---------------+

Remove tag (after running the example above)

cpln serviceaccount tag demo-service-account-tag-1 --remove-tag drink --org demo-cpln-organization

+---------------------------+---------------------------+--------+--------+-----+-----+
|NAME                       |DESCRIPTION                |CREATED |ORIGIN  |KEYS |TAGS |
|---------------------------|---------------------------|--------|--------|-----|-----|
|demo-service-account-tag-1 |demo-service-account-tag-1 |Now     |default |     |     |
+---------------------------+---------------------------+--------+--------+-----+-----+

Add same tag to multiple service accounts

cpln serviceaccount tag demo-service-account-tag-1 demo-service-account-tag-2 --tag multiple-serviceaccounts=true --org demo-cpln-organization

+---------------------------+---------------------------+--------+--------+-----+--------------------------------+
|NAME                       |DESCRIPTION                |CREATED |ORIGIN  |KEYS |TAGS                            |
|---------------------------|---------------------------|--------|--------|-----|--------------------------------|
|demo-service-account-tag-1 |demo-service-account-tag-1 |Now     |default |     |multiple-serviceaccounts="true" |
|demo-service-account-tag-2 |demo-service-account-tag-2 |Now     |default |     |multiple-serviceaccounts="true" |
+---------------------------+---------------------------+--------+--------+-----+--------------------------------+

Update same tag on multiple service accounts (after running the example above)

cpln serviceaccount tag demo-service-account-tag-1 demo-service-account-tag-2 --tag multiple-serviceaccounts=demo-serviceaccount --org demo-cpln-organization

+---------------------------+---------------------------+--------+--------+-----+-----------------------------------------------+
|NAME                       |DESCRIPTION                |CREATED |ORIGIN  |KEYS |TAGS                                           |
|---------------------------|---------------------------|--------|--------|-----|-----------------------------------------------|
|demo-service-account-tag-1 |demo-service-account-tag-1 |Now     |default |     |multiple-serviceaccounts="demo-serviceaccount" |
|demo-service-account-tag-2 |demo-service-account-tag-2 |Now     |default |     |multiple-serviceaccounts="demo-serviceaccount" |
+---------------------------+---------------------------+--------+--------+-----+-----------------------------------------------+

Remove same tag from multiple service accounts (after running the example above)

cpln serviceaccount tag demo-service-account-tag-1 demo-service-account-tag-2 --remove-tag multiple-serviceaccounts --org demo-cpln-organization

+---------------------------+---------------------------+--------+--------+-----+-----+
|NAME                       |DESCRIPTION                |CREATED |ORIGIN  |KEYS |TAGS |
|---------------------------|---------------------------|--------|--------|-----|-----|
|demo-service-account-tag-1 |demo-service-account-tag-1 |Now     |default |     |     |
|demo-service-account-tag-2 |demo-service-account-tag-2 |Now     |default |     |     |
+---------------------------+---------------------------+--------+--------+-----+-----+

​serviceaccount access-report

​serviceaccount add-key

​serviceaccount audit

​serviceaccount clone

​serviceaccount create

​serviceaccount delete

​serviceaccount edit

​serviceaccount eventlog

​serviceaccount get

​serviceaccount patch

​serviceaccount permissions

​serviceaccount query

​serviceaccount remove-key

​serviceaccount tag

serviceaccount access-report

serviceaccount add-key

serviceaccount audit

serviceaccount clone

serviceaccount create

serviceaccount delete

serviceaccount edit

serviceaccount eventlog

serviceaccount get

serviceaccount patch

serviceaccount permissions

serviceaccount query

serviceaccount remove-key

serviceaccount tag