kxi entitlement

Insights entitlements commands.

Usage:

text

Copy
kxi entitlement [OPTIONS] COMMAND [ARGS]...

Options:

text

Copy
  --help  Show this message and exit.

kxi entitlement actors

List actors.

Actors are the list of groups that can be assigned to an entity.

Usage:

text

Copy
kxi entitlement actors [OPTIONS]

Options:

text

Copy
  -o, --output [json|table]  Output format. One of: (json, table)
  --timeout INTEGER          Timeout in seconds for request
  --help                     Show this message and exit.

kxi entitlement add-groups

Add groups to an entitlement.

ID is the id of the entitlement to add the groups to. GROUPS is a comma separated list of group IDs and access level

Usage:

text

Copy
kxi entitlement add-groups [OPTIONS] ID {assembly|database|package|view|query}
                           GROUPS

Options:

text

Copy
  --timeout INTEGER  Timeout in seconds for request
  --help             Show this message and exit.

kxi entitlement create

Create an entitlement.

ID is the ID of the entity being entitled. NAME is the name of the entity being entitled. ENTITYTYPE is the type of the entity being entitled

Supported entity types are 'assembly' and 'package'

--owner and --groups are optional, if not provided these are defaulted to 00000000-0000-0000-0000-000000000000 and [] respectively.

Usage:

text

Copy
kxi entitlement create [OPTIONS] ID NAME
                       {assembly|database|package|view|query}

Options:

text

Copy
  --owner UUID       User ID of the owner
  --groups TEXT      Comma separated list of group IDs and access level
                     <id>:<access>
  --timeout INTEGER  Timeout in seconds for request
  --help             Show this message and exit.

kxi entitlement delete

Delete an entitlement.

This deletes an entitlement pending user confirmation. Use --force to skip user confirmation.

Usage:

text

Copy
kxi entitlement delete [OPTIONS] ID {assembly|database|package|view|query}

Options:

text

Copy
  --timeout INTEGER  Timeout in seconds for request
  --force            Perform action without prompting for confirmation
  --help             Show this message and exit.

kxi entitlement filter

Filter list entitlements by id, type and access.

Usage:

text

Copy
kxi entitlement filter [OPTIONS]

Options:

text

Copy
  --id TEXT                       Entitlement id
  --entity-type [assembly|database|package|view|query]
                                  Type of entity
  --access TEXT                   Level of access <R|W|X>
  --timeout INTEGER               Timeout in seconds for request
  --help                          Show this message and exit.

kxi entitlement get

Get an entitlement.

Usage:

text

Copy
kxi entitlement get [OPTIONS] ID {assembly|database|package|view|query}

Options:

text

Copy
  --timeout INTEGER          Timeout in seconds for request
  -o, --output [json|table]  Output format. One of: (json, table)
  --show-columns TEXT        List of columns to show if output format is
                             'table'. Any list of "owner,groups,users,policies
                             enabled,policy types"
  --hide-columns TEXT        List of columns to hide if output format is
                             'table'. Any list of "owner,groups,users,policies
                             enabled,policy types"
  --help                     Show this message and exit.

kxi entitlement list

List entitlements.

Usage:

text

Copy
kxi entitlement list [OPTIONS]

Options:

text

Copy
  --timeout INTEGER          Timeout in seconds for request
  -o, --output [json|table]  Output format. One of: (json, table)
  --show-columns TEXT        List of columns to show if output format is
                             'table'. Any list of "owner,groups,users,policies
                             enabled,policy types"
  --hide-columns TEXT        List of columns to hide if output format is
                             'table'. Any list of "owner,groups,users,policies
                             enabled,policy types"
  --own                      Return entitlements owned by the current user.
  --help                     Show this message and exit.

kxi entitlement manage

Manage Entitlements in an Interactive Session

text

Copy
Keybindings:


                    Enter: to view and edit groups

                    C-E  : to create a new entitlement

                    C-D  : to delete the selected entitlement

                    C-B  : to go back to previous screen

                    q    : to quit (when at top level)

Usage:

text

Copy
kxi entitlement manage [OPTIONS]

Options:

text

Copy
  --timeout INTEGER  Timeout in seconds for request
  --help             Show this message and exit.

kxi entitlement policies-disable

Disable policies for an entitlement.

Usage:

text

Copy
kxi entitlement policies-disable [OPTIONS] ID
                                 {assembly|database|package|view|query}

Options:

text

Copy
  --timeout INTEGER  Timeout in seconds for request
  --help             Show this message and exit.

kxi entitlement policies-enable

Enable policies for an entitlement.

Usage:

text

Copy
kxi entitlement policies-enable [OPTIONS] ID
                                {assembly|database|package|view|query}

Options:

text

Copy
  --timeout INTEGER  Timeout in seconds for request
  --help             Show this message and exit.

kxi entitlement policy-mapping

Insights policy commands.

Usage:

text

Copy
kxi entitlement policy-mapping [OPTIONS] COMMAND [ARGS]...

Options:

text

Copy
  --help  Show this message and exit.
kxi entitlement policy-mapping add

Add a new asset to policyMapping. Or append policies to an existing asset.

Usage:

text

Copy
kxi entitlement policy-mapping add [OPTIONS] ID
                                   {assembly|database|package|view|query}

Options:

text

Copy
  --group TEXT        Group to modify
  --asset TEXT        Asset mapping key  [required]
  --policy-type TEXT  Type of policy  [required]
  --policies TEXT     Comma separated list of policies  [required]
  --timeout INTEGER   Timeout in seconds for request
  --help              Show this message and exit.
kxi entitlement policy-mapping delete

Remove an asset from policyMapping.

Usage:

text

Copy
kxi entitlement policy-mapping delete [OPTIONS] ID
                                      {assembly|database|package|view|query}

Options:

text

Copy
  --group TEXT       Group to modify
  --asset TEXT       Asset from the policy mapping key
  --timeout INTEGER  Timeout in seconds for request
  --help             Show this message and exit.
kxi entitlement policy-mapping disable

Disable one or more policy types for an entitlement.

Usage:

text

Copy
kxi entitlement policy-mapping disable [OPTIONS] ID
                                       {assembly|database|package|view|query}

Options:

text

Copy
  --policy-types TEXT  Comma separated list of policy types to disable
  --timeout INTEGER    Timeout in seconds for request
  --help               Show this message and exit.
kxi entitlement policy-mapping enable

Enable one or more policy types for an entitlement.

Usage:

text

Copy
kxi entitlement policy-mapping enable [OPTIONS] ID
                                      {assembly|database|package|view|query}

Options:

text

Copy
  --policy-types TEXT  Comma separated list of policy types to enable
  --timeout INTEGER    Timeout in seconds for request
  --help               Show this message and exit.
kxi entitlement policy-mapping get

Get policies for an entitlement.

Usage:

text

Copy
kxi entitlement policy-mapping get [OPTIONS] ID
                                   {assembly|database|package|view|query}

Options:

text

Copy
  --timeout INTEGER  Timeout in seconds for request
  --help             Show this message and exit.
kxi entitlement policy-mapping remove

Remove policies from an asset inside of a policyMapping.

Usage:

text

Copy
kxi entitlement policy-mapping remove [OPTIONS] ID
                                      {assembly|database|package|view|query}

Options:

text

Copy
  --group TEXT        Group to modify
  --asset TEXT        Asset mapping key  [required]
  --policy-type TEXT  Type of policy  [required]
  --policies TEXT     Comma separated list of policies  [required]
  --timeout INTEGER   Timeout in seconds for request
  --help              Show this message and exit.
kxi entitlement policy-mapping set

Update the enabled status for one or more policy types for a specified entitlement.

Usage:

text

Copy
kxi entitlement policy-mapping set [OPTIONS] ID
                                   {assembly|database|package|view|query}

Options:

text

Copy
  --policy-types TEXT  Comma separated list of policy types and enabled flag
                       <assetType>:<enabled>
  --timeout INTEGER    Timeout in seconds for request
  --help               Show this message and exit.
kxi entitlement policy-mapping update

Overwrite policies inside of an asset.

Usage:

text

Copy
kxi entitlement policy-mapping update [OPTIONS] ID
                                      {assembly|database|package|view|query}

Options:

text

Copy
  --group TEXT        Group to modify
  --asset TEXT        Asset mapping key  [required]
  --policy-type TEXT  Type of policy  [required]
  --policies TEXT     Comma separated list of policies  [required]
  --timeout INTEGER   Timeout in seconds for request
  --help              Show this message and exit.

kxi entitlement rm-groups

Remove groups from an entitlement.

ID is the id of the the entitlement to remove the groups from. GROUPS is a comma separated list of group IDs and access level:

Usage:

text

Copy
kxi entitlement rm-groups [OPTIONS] ID {assembly|database|package|view|query}
                          GROUPS

Options:

text

Copy
  --timeout INTEGER  Timeout in seconds for request
  --help             Show this message and exit.

kxi entitlement update

Update an entitlement.

This updates the name, owner and groups of an entitlement based on the options passed.

Usage:

text

Copy
kxi entitlement update [OPTIONS] ID {assembly|database|package|view|query}

Options:

text

Copy
  --name TEXT        Name of the entity
  --owner UUID       User ID of the owner
  --groups TEXT      Comma separated list of group IDs and access level
                     <id>:<access>
  --timeout INTEGER  Timeout in seconds for request
  --help             Show this message and exit.