Policy Management Command Line Interface (CLI) Reference

pim --help

Usage: pim [OPTIONS] COMMAND [ARGS]...

  Policy Information Management commands.

Options:
  --help  Show this message and exit.

Commands:
  create  Create a resource.
  delete  Delete a resource.
  get     Display one or many resources.
  invoke  Invoke resource by operation defined by the API.
  set     Update fields of a resource.

pim invoke --help

Usage: pim invoke [OPTIONS] COMMAND [ARGS]...

  Invoke resource by operation defined by the API.

Options:
  --help  Show this message and exit.

Commands:
  datastores  Commands for deploying datastore resources.
  init        Bootstrap PIM - Initialize the Policy Information system.
  roles       Commands for synchronizing role resources.
  sources     Commands for testing source resources.

pim invoke datastores --help

Usage: pim invoke datastores [OPTIONS] COMMAND [ARGS]...

  Commands for deploying datastore resources.

Options:
  --help  Show this message and exit.

Commands:
  deploy  Deploy policies and/or trusted applications to a specific datastore.

pim invoke datastores deploy --help

Usage: pim invoke datastores deploy [OPTIONS] DATASTORE_UID

  Deploy policies and/or trusted applications to a specific datastore.

  EXAMPLES:

  # Deploy single policy to datastore
  pim invoke datastores deploy 15 --policies 1

  # Deploy multiple policies to datastore
  pim invoke datastores deploy 15 --policies 1 --policies 2 --policies 3

  # Deploy trusted applications to datastore
  pim invoke datastores deploy 15 --applications 1 --applications 2

  # Deploy both policies and applications together
  pim invoke datastores deploy "<datastore-uid>" --policies 1 --policies 2 --applications 1 --applications 2

  # Clear all deployments (deploy empty configuration)
  pim invoke datastores deploy 42

  WORKFLOW:
  # Step 1: Verify datastore exists and is accessible
  pim get datastores datastore <datastore-uid>

  # Step 2: List available policies and applications
  pim get policies policy
  pim get applications application

  # Step 3: Deploy to  datastore
  pim invoke datastores deploy <datastore-uid> --policies <policy-uid> --applications <app-uid>

Options:
  --policies TEXT      UIDs of policies to deploy (can be specified multiple
                       times).
  --applications TEXT  UIDs of trusted applications to deploy (can be
                       specified multiple times).
  --help               Show this message and exit.

pim invoke init --help

Usage: pim invoke init [OPTIONS]

  Bootstrap PIM - Initialize the Policy Information Management system.

  EXAMPLES:

  # Initialize PIM system for first-time setup
  pim invoke init

Options:
  --help  Show this message and exit.

pim invoke roles --help

Usage: pim invoke roles [OPTIONS] COMMAND [ARGS]...

  Commands for synchronizing role resources.

Options:
  --help  Show this message and exit.

Commands:
  sync  Synchronize all group members for a role with external identity sources.

pim invoke roles sync --help

Usage: pim invoke roles sync [OPTIONS] ROLE_UID

  Synchronize all group members for a role with external identity sources.

  EXAMPLES:

  # Synchronize role members with LDAP/AD source
  pim invoke roles sync 15

Options:
  --help  Show this message and exit.

pim invoke sources --help

Usage: pim invoke sources [OPTIONS] COMMAND [ARGS]...

  Commands for testing source resources.

Options:
  --help  Show this message and exit.

Commands:
  test  Tests the connection and functionality of a source.

pim invoke sources test --help

Usage: pim invoke sources test [OPTIONS] UID

  Tests the connection and functionality of a source.

  EXAMPLES:

  # Basic connectivity test
  pim invoke sources test 15

Options:
  --help  Show this message and exit.

pim create --help

Usage: pim create [OPTIONS] COMMAND [ARGS]...

  Create a resource.

Options:
  --help  Show this message and exit.

Commands:
  alphabets     Creates a new alphabet.
  applications  Creates a new application.
  dataelements  Creates a new data element of a specific type.
  datastores    Commands for creating datastore resources.
  deploy        Deploys policies and/or trusted applications to a datastore.
  masks         Creates a new mask with specified masking pattern and configuration.
  policies      Creates a new policy or rule.
  roles         Creates a new role or adds members to a role.
  sources       Creates a new source.

pim create alphabets --help

Usage: pim create alphabets [OPTIONS]

  Creates a new alphabet.

  EXAMPLES:

  # Create alphabet combining existing alphabets (use numeric UIDs from 'pim get alphabets')
  pim create alphabets --label "LatinExtended" --alphabets "1,2"

  # Create alphabet with Unicode ranges (Basic Latin + punctuation)
  pim create alphabets --label "ASCIIPrintable" --ranges '[{"from": "0020", "to": "007E"}]'

  # Create alphabet with specific code points (more than 10 examples)
  pim create alphabets --label "SpecialChars" --code-points "00A9,00AE,2122,2603,2615,20AC,00A3,00A5,00B5,00B6,2020,2021,2030,2665,2660"

  # Create complex alphabet with multiple options (use numeric UIDs)
  pim create alphabets --label "CompleteSet" --alphabets "1,3,5"  --ranges '[{"from": "0100", "to": "017F"}, {"from": "1E00", "to": "1EFF"}]' --code-points "20AC,00A3,00A5"

  # Create mathematical symbols alphabet
  pim create alphabets --label "MathSymbols" --ranges '[{"from": "2200", "to": "22FF"}, {"from": "2190", "to": "21FF"}]'

Options:
  --label TEXT        The label for the custom alphabet.  [required]
  --alphabets TEXT    Comma-separated list of alphabet UIDs.
  --ranges TEXT       JSON string of code point ranges. For example, '[{"from":
                      "0020", "to": "007E"}]'.
  --code-points TEXT  Comma-separated list of code points.
  --help              Show this message and exit.

pim create applications --help

Usage: pim create applications [OPTIONS]

  Creates a new application.

  EXAMPLES:

  # Create a basic application with required fields
  pim create applications --name "WebApp" --application-name "mywebapp" --application-user "webuser"

  # Create application with description
  pim create applications --name "DatabaseApp" --description "Main database application" --application-name "dbapp" --application-user "dbuser"

Options:
  --name TEXT              Name of the application.  [required]
  --description TEXT       Description of the application.
  --application-name TEXT  The application name or the application loading the
                           API jar file.  [required]
  --application-user TEXT  The application user or the OS user.  [required]
  --help                   Show this message and exit.

pim create dataelements --help

Usage: pim create dataelements [OPTIONS] COMMAND [ARGS]...

  Creates a new data element of a specific type.

  AVAILABLE PROTECTION TYPES:

  # Encryption Methods:
  - aes128-cbc-enc       # AES-128 CBC encryption
  - aes128-cusp-enc      # AES-128 CUSP encryption  
  - aes256-cbc-enc       # AES-256 CBC encryption
  - aes256-cusp-enc      # AES-256 CUSP encryption
  - triple-des-cbc-enc   # 3DES CBC encryption
  - triple-des-cusp-enc  # 3DES CUSP encryption
  - sha1-hmac-enc        # SHA1 HMAC encryption (deprecated)
  - sha256-hmac-enc      # SHA256 HMAC encryption
  - no-enc               # No encryption (clear text)

  # Tokenization Methods:
  - token numeric        # Numeric tokens
  - token alphabetic     # Alphabetic tokens
  - token alpha-numeric  # Alphanumeric tokens
  - token printable      # Printable character tokens
  - token unicode        # Unicode tokens
  - token credit-card    # Credit card specific tokens
  - token email          # Email specific tokens

  # Format Preserving Encryption (FPE):
  - fpe numeric          # Numeric FPE
  - fpe alphabetic       # Alphabetic FPE
  - fpe alpha-numeric    # Alphanumeric FPE

  # Special Protection Types:
  - masking              # Data masking using NoEnc
  - monitor              # Data monitoring using NoEnc

Options:
  --help  Show this message and exit.

Commands:
  aes128-cbc-enc       Creates a new AES-128-CBC-ENC data element.
  aes128-cusp-enc      Creates a new AES-128-CUSP-ENC data element.
  aes256-cbc-enc       Creates a new AES-256-CBC-ENC data element.
  aes256-cusp-enc      Creates a new AES-256-CUSP-ENC data element.
  fpe                  Creates a new FPE (Format Preserving Encryption)...
  masking              Creates a new masking data element using NoEnc...
  monitor              Creates a new monitoring data element using NoEnc...
  no-enc               Creates a new No-Enc data element.
  sha1-hmac-enc        Creates a new SHA1-HMAC-ENC data element...
  sha256-hmac-enc      Creates a new SHA256-HMAC-ENC data element.
  token                Creates a new token data element of a specific type.
  triple-des-cbc-enc   Creates a new 3DES-CBC-ENC data element.
  triple-des-cusp-enc  Creates a new 3DES-CUSP-ENC data element.

pim create dataelements aes128-cbc-enc --help

Usage: pim create dataelements aes128-cbc-enc [OPTIONS]

  Creates a new AES-128-CBC-ENC data element.

  EXAMPLES:

  # Create basic AES-128 encryption data element
  pim create dataelements aes128-cbc-enc --name "BasicEncryption" --description "Basic data encryption"

  # Create with all security features enabled
  pim create dataelements aes128-cbc-enc --name "FullSecurityEnc" --description "Full security encryption" --iv-type "SYSTEM_APPEND" --checksum-type "CRC32" --cipher-format "INSERT_KEYID_V1"

Options:
  --name TEXT                               The name for the data element.  [required]
  --description TEXT                        An optional description for the data element.
  --iv-type [NONE|SYSTEM_APPEND]            Initialization Vector type.
  --checksum-type [NONE|CRC32]              Checksum type.
  --cipher-format [NONE|INSERT_KEYID_V1]    Cipher format.
  --help                                    Show this message and exit.

pim create dataelements aes128-cusp-enc --help

Usage: pim create dataelements aes128-cusp-enc [OPTIONS]

  Creates a new AES-128-CUSP-ENC data element.      EXAMPLES:

  # Create with key rotation support
  pim create dataelements aes128-cusp-enc --name "RotatingCUSP" --description "CUSP with key rotation" --cipher-format "INSERT_KEYID_V1"

Options:
  --name TEXT                               The name for the data element.  [required]
  --description TEXT                        An optional description for the data element.
  --iv-type [NONE|SYSTEM_APPEND]            Initialization Vector type.
  --checksum-type [NONE|CRC32]              Checksum type.
  --cipher-format [NONE|INSERT_KEYID_V1]    Cipher format.
  --help                                    Show this message and exit.

pim create dataelements aes256-cbc-enc --help

Usage: pim create dataelements aes256-cbc-enc [OPTIONS]

  Creates a new AES-256-CBC-ENC data element.

  EXAMPLES:

  # Create with system-generated IV and CRC32 checksum
  pim create dataelements aes256-cbc-enc --name "CreditCardEnc" --description "Credit card encryption" --iv-type "SYSTEM_APPEND" --checksum-type "CRC32"    

Options:
  --name TEXT                               The name for the data element.  [required]
  --description TEXT                        An optional description for the data element.
  --iv-type [NONE|SYSTEM_APPEND]            Initialization Vector type.
  --checksum-type [NONE|CRC32]              Checksum type.
  --cipher-format [NONE|INSERT_KEYID_V1]    Cipher format.
  --help                                    Show this message and exit.

pim create dataelements aes256-cusp-enc --help

Usage: pim create dataelements aes256-cusp-enc [OPTIONS]

  Creates a new AES-256-CUSP-ENC data element.

  EXAMPLES:

  # Create basic AES-256 CUSP encryption
  pim create dataelements aes256-cusp-enc --name "HighSecurityEnc" --description "High security data encryption"

  # Create with key ID insertion for key management
  pim create dataelements aes256-cusp-enc --name "EnterpriseEnc" --description "Enterprise encryption with key tracking" --cipher-format "INSERT_KEYID_V1"

Options:
  --name TEXT                               The name for the data element.  [required]
  --description TEXT                        An optional description for the data element.
  --iv-type [NONE|SYSTEM_APPEND]            Initialization Vector type.
  --checksum-type [NONE|CRC32]              Checksum type.
  --cipher-format [NONE|INSERT_KEYID_V1]    Cipher format.
  --help                                    Show this message and exit.

pim create dataelements triple-des-cbc-enc --help

Usage: pim create dataelements triple-des-cbc-enc [OPTIONS]

  Creates a new 3DES-CBC-ENC data element.

  EXAMPLES:

  # Create basic 3DES-CBC encryption
  pim create dataelements triple-des-cbc-enc --name "Legacy3DESEnc" --description "Legacy 3DES encryption for compatibility"

  # Create with key ID insertion for key management
  pim create dataelements triple-des-cbc-enc --name "Managed3DES" --description "3DES with key tracking" --cipher-format "INSERT_KEYID_V1"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --iv-type [NONE|SYSTEM_APPEND]  Initialization Vector type.
  --checksum-type [NONE|CRC32]    Checksum type.
  --cipher-format [NONE|INSERT_KEYID_V1]
                                  Cipher format.
  --help                          Show this message and exit.

pim create dataelements triple-des-cusp-enc --help

Usage: pim create dataelements triple-des-cusp-enc [OPTIONS]

  Creates a new 3DES-CUSP-ENC data element.

  EXAMPLES:

  # Create with system-generated IV and integrity checking
  pim create dataelements triple-des-cusp-enc --name "Secure3DESCusp" --description "3DES CUSP with enhanced security" --iv-type "SYSTEM_APPEND" --checksum-type "CRC32"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --iv-type [NONE|SYSTEM_APPEND]  Initialization Vector type.
  --checksum-type [NONE|CRC32]    Checksum type.
  --cipher-format [NONE|INSERT_KEYID_V1]
                                  Cipher format.
  --help                          Show this message and exit.

pim create dataelements fpe --help

Usage: pim create dataelements fpe [OPTIONS] COMMAND [ARGS]...

  Creates a new FPE (Format Preserving Encryption) data element of a specific
  type.

  AVAILABLE FPE TYPES:

  - numeric                           # Numeric data (0-9)
  - alphabetic                        # Alphabetic data (a-z, A-Z)  
  - alpha-numeric                     # Alphanumeric data (0-9, a-z, A-Z)
  - unicode-basic-latin-alphabetic    # Unicode Basic Latin alphabetic
  - unicode-basic-latin-alpha-numeric # Unicode Basic Latin alphanumeric

Options:
  --help  Show this message and exit.

Commands:
  alpha-numeric                        Creates a new Alpha Numeric FPE data element.
  alphabetic                           Creates a new Alphabetic FPE data element.
  numeric                              Creates a new Numeric FPE data element.
  unicode-basic-latin-alpha-numeric    Creates a new Unicode Basic Latin Alpha Numeric (Format Preserving Encryption) FPE data element.
  unicode-basic-latin-alphabetic       Creates a new Unicode Basic Latin Alphabetic FPE data element.

pim create dataelements fpe alpha-numeric --help

Usage: pim create dataelements fpe alpha-numeric [OPTIONS]

  Creates a new Alpha Numeric FPE data element.

  EXAMPLES:

  # Create basic alphanumeric FPE for user IDs
  pim create dataelements fpe alpha-numeric --name "UserIDFPE" --description "User ID alphanumeric format-preserving encryption"

  # Create for product codes with flexible length handling
  pim create dataelements fpe alpha-numeric --name "ProductCodeFPE" --description "Product code alphanumeric FPE" --from-left 2 --min-length 5 --allow-short "NOINPUTVALUE"

  # Create for mixed case identifiers
  pim create dataelements fpe alpha-numeric --name "MixedCaseIDFPE" --description "Mixed case identifier encryption"  --from-left 1 --from-right 2 --min-length 7

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --plain-text-encoding TEXT      Kept for backwards compatibility, will be
                                  ignored if sent in. Removed in later
                                  releases.
  --from-left INTEGER             Number of characters to retain in clear from
                                  the left.
  --from-right INTEGER            Number of characters to retain in clear from
                                  the right.
  --min-length INTEGER            The minimum supported input length is 2
                                  bytes and is configurable up to 10 bytes.
  --tweak-mode [EXT_API|EXT_INPUT]
                                  The tweak input is derived from either the
                                  API (EXT_API) or the input message
                                  (EXT_INPUT).
  --allow-short [NOWITHERROR|NOINPUTVALUE]
                                  Specifies whether the short data must be
                                  supported or not.
  --help                          Show this message and exit.

pim create dataelements fpe alphabetic --help

Usage: pim create dataelements fpe alphabetic [OPTIONS]

  Creates a new Alphabetic FPE data element.

  EXAMPLES:

  # Create with partial clear text (preserve first 2 and last 2 chars)
  pim create dataelements fpe alphabetic --name "PartialAlphaFPE" --description "Partial alphabetic FPE with clear boundaries" --from-left 2 --from-right 2

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --plain-text-encoding TEXT      Kept for backwards compatibility, will be
                                  ignored if sent in. Removed in later
                                  releases.
  --from-left INTEGER             Number of characters to retain in clear from
                                  the left.
  --from-right INTEGER            Number of characters to retain in clear from
                                  the right.
  --min-length INTEGER            The minimum supported input length is 2
                                  bytes and is configurable up to 10 bytes.
  --allow-short [NOWITHERROR|NOINPUTVALUE]
                                  Specifies whether the short data must be
                                  supported or not.
  --tweak-mode [EXT_API|EXT_INPUT]
                                  The tweak input is derived from either the
                                  API (EXT_API) or the input message
                                  (EXT_INPUT).
  --help                          Show this message and exit.

pim create dataelements fpe numeric --help

Usage: pim create dataelements fpe numeric [OPTIONS]

  Creates a new Numeric FPE data element.

  EXAMPLES:

  # Create basic numeric FPE for account numbers
  pim create dataelements fpe numeric --name "AccountFPE" --description "Account number format-preserving encryption" --min-length 6

  # Create FPE with partial masking (show first 4 digits)
  pim create dataelements fpe numeric --name "PartialFPE" --description "Partial numeric FPE" --min-length 8 --from-left 4

  # Create credit card FPE with BIN preservation
  pim create dataelements fpe numeric --name "CreditCardFPE" --description "Credit card FPE with BIN visible" --min-length 8 --from-left 6 --from-right 4 --special-numeric-handling "CCN"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --plain-text-encoding TEXT      Kept for backwards compatibility, will be
                                  ignored if sent in. Removed in later
                                  releases.
  --from-left INTEGER             Number of characters to retain in clear from
                                  the left.
  --from-right INTEGER            Number of characters to retain in clear from
                                  the right.
  --min-length INTEGER            The minimum supported input length is 2
                                  bytes and is configurable up to 10 bytes.
                                  The default minimum supported input length
                                  for Credit Card Number (CCN) is 8 bytes and
                                  is configurable up to 10 bytes.
  --tweak-mode [EXT_API|EXT_INPUT]
                                  The tweak input is derived from either the
                                  API (EXT_API) or the input message
                                  (EXT_INPUT).
  --allow-short [NOWITHERROR|NOINPUTVALUE]
                                  Specifies whether the short data must be
                                  supported or not.
  --special-numeric-handling [NONE|CCN]
                                  The Format Preserving Encryption (FPE) for
                                  Credit Card Number (CCN) is handled by
                                  configuring numeric data type as the
                                  plaintext alphabet.
  --help                          Show this message and exit.

pim create dataelements fpe unicode-basic-latin-alpha-numeric --help

Usage: pim create dataelements fpe unicode-basic-latin-alpha-numeric 
           [OPTIONS]

  Creates a new Unicode Basic Latin Alpha Numeric (Format Preserving
  Encryption) FPE data element.

  EXAMPLES:

  # Create basic Unicode Latin alphanumeric FPE
  pim create dataelements fpe unicode-basic-latin-alpha-numeric --name "UnicodeLatinFPE"  --description "Unicode Latin alphanumeric format-preserving encryption"

  # Create with partial clear text for international IDs
  pim create dataelements fpe unicode-basic-latin-alpha-numeric --name "IntlIDFPE" --description "International ID with clear prefix,suffix" --from-left 2 --from-right 2 --min-length 6

  # Create for international user IDs with flexible length
  pim create dataelements fpe unicode-basic-latin-alpha-numeric --name "GlobalUserIDFPE" --description "Global user ID format-preserving encryption" --min-length 4 --allow-short "NOINPUTVALUE"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --plain-text-encoding TEXT      Kept for backwards compatibility, will be
                                  ignored if sent in. Removed in later
                                  releases.
  --from-left INTEGER             Number of characters to retain in clear from
                                  the left.
  --from-right INTEGER            Number of characters to retain in clear from
                                  the right.
  --min-length INTEGER            The minimum supported input length is 2
                                  bytes and is configurable up to 10 bytes.
  --tweak-mode [EXT_API|EXT_INPUT]
                                  The tweak input is derived from either the
                                  API (EXT_API) or the input message
                                  (EXT_INPUT).
  --allow-short [NOWITHERROR|NOINPUTVALUE]
                                  Specifies whether the short data must be
                                  supported or not.
  --help                          Show this message and exit.

pim create dataelements fpe unicode-basic-latin-alphabetic --help

Usage: pim create dataelements fpe unicode-basic-latin-alphabetic 
           [OPTIONS]

  Creates a new Unicode Basic Latin Alphabetic FPE data element.

  EXAMPLES:

  # Create basic Unicode Basic Latin alphabetic FPE
  pim create dataelements fpe unicode-basic-latin-alphabetic --name "UnicodeAlphaFPE"  --description "Unicode Basic Latin alphabetic FPE"

  # Create for European customer names
  pim create dataelements fpe unicode-basic-latin-alphabetic --name "EuropeanNameFPE" --description "European customer name FPE" --from-left 1 --min-length 3 --allow-short "NOWITHERROR"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --plain-text-encoding TEXT      Kept for backwards compatibility, will be
                                  ignored if sent in. Removed in later
                                  releases.
  --from-left INTEGER             Number of characters to retain in clear from
                                  the left.
  --from-right INTEGER            Number of characters to retain in clear from
                                  the right.
  --min-length INTEGER            The minimum supported input length is 2
                                  bytes and is configurable up to 10 bytes.
  --tweak-mode [EXT_API|EXT_INPUT]
                                  The tweak input is derived from either the
                                  API (EXT_API) or the input message
                                  (EXT_INPUT).
  --allow-short [NOWITHERROR|NOINPUTVALUE]
                                  Specifies whether the short data must be
                                  supported or not.
  --help                          Show this message and exit.

pim create dataelements masking --help

Usage: pim create dataelements masking [OPTIONS]

  Creates a new masking data element using NoEnc with masking enabled.

  EXAMPLES:

  # Create basic data masking with a specific mask
  pim create dataelements masking --name "SSNMasking" --description "Social Security Number masking"  --mask-uid "1"

  # Create email masking for development environment
  pim create dataelements masking --name "EmailMasking" --description "Email masking for dev environment" --mask-uid "2"

Options:
  --name TEXT         The name for the data element.  [required]
  --description TEXT  An optional description for the data element.
  --mask-uid TEXT     The UID of the mask to apply for masking data.
                      [required]
  --help              Show this message and exit.

pim create dataelements monitor --help

Usage: pim create dataelements monitor [OPTIONS]

  Creates a new monitoring data element using no encryption with monitoring enabled.

  EXAMPLES:

  # Create basic monitoring for sensitive database fields
  pim create dataelements monitor --name "CustomerDataMonitor"  --description "Monitor customer data access"

Options:
  --name TEXT         The name for the data element.  [required]
  --description TEXT  An optional description for the data element.
  --help              Show this message and exit.

pim create dataelements no-enc --help

Usage: pim create dataelements no-enc [OPTIONS]

  Creates a new No-Enc data element.

  EXAMPLES:

  # Create basic no-encryption element for testing
  pim create dataelements no-enc --name "TestNoEnc" --description "Test data element with no encryption"

Options:
  --name TEXT         The name for the data element.  [required]
  --description TEXT  An optional description for the data element.
  --help              Show this message and exit.

pim create dataelements sha1-hmac-enc --help

Usage: pim create dataelements sha1-hmac-enc [OPTIONS]

  Creates a new SHA1-HMAC-ENC data element (deprecated).

  EXAMPLES:

  # Create basic SHA1-HMAC encryption (legacy support)
  pim create dataelements sha1-hmac-enc --name "LegacyHashEnc" --description "SHA1 HMAC for legacy system compatibility"

Options:
  --name TEXT         The name for the data element.  [required]
  --description TEXT  An optional description for the data element.
  --help              Show this message and exit.

pim create dataelements sha256-hmac-enc --help

Usage: pim create dataelements sha256-hmac-enc [OPTIONS]

  Creates a new SHA256-HMAC-ENC data element.

  EXAMPLES:

  # Create basic SHA256-HMAC encryption
  pim create dataelements sha256-hmac-enc --name "SecureHashEnc" --description "Strong SHA256 HMAC encryption"

Options:
  --name TEXT         The name for the data element.  [required]
  --description TEXT  An optional description for the data element.
  --help              Show this message and exit.

pim create dataelements token --help

Usage: pim create dataelements token [OPTIONS] COMMAND [ARGS]...

  Creates a new token data element of a specific type.

  AVAILABLE TOKEN TYPES:

  - numeric              # Numeric data tokenization (0-9)
  - alphabetic           # Alphabetic data tokenization (a-z, A-Z)
  - alpha-numeric        # Alphanumeric tokenization (0-9, a-z, A-Z)
  - printable            # Printable ASCII characters
  - unicode              # Unicode character tokenization
  - unicode-base64       # Base64 encoded Unicode tokens
  - unicode-gen2         # Generation 2 Unicode tokens with custom alphabets
  - binary               # Binary data tokenization
  - lower-ascii          # Lowercase ASCII tokenization
  - upper-alphabetic     # Uppercase alphabetic tokens
  - upper-alpha-numeric  # Uppercase alphanumeric tokens

  # Specialized Token Types:
  - credit-card          # Credit card number tokenization
  - email                # Email address tokenization
  - integer              # Integer value tokenization
  - decimal              # Decimal number tokenization
  - date-yyyymmdd        # Date in YYYY-MM-DD format
  - date-ddmmyyyy        # Date in DD-MM-YYYY format
  - date-mmddyyyy        # Date in MM-DD-YYYY format
  - date-time            # Date and time tokenization

  COMMON OPTIONS:

  --tokenizer            # Lookup table type (SLT_1_3, SLT_2_3, SLT_1_6, SLT_2_6)
  --from-left            # Characters to keep in clear from left
  --from-right           # Characters to keep in clear from right
  --length-preserving    # Maintain original data length
  --allow-short          # Handle short input data (YES, NO, ERROR)

Options:
  --help  Show this message and exit.

Commands:
  alpha-numeric        Creates a new Alpha Numeric Token data element.
  alphabetic           Creates a new Alphabetic Token data element.
  binary               Creates a new Binary Token data element.
  credit-card          Creates a new Credit Card Token data element.
  date-ddmmyyyy        Creates a new Date DDMMYYYY Token data element.
  date-mmddyyyy        Creates a new Date MMDDYYYY Token data element.
  date-time            Creates a new Date Time Token data element.
  date-yyyymmdd        Creates a new Date YYYYMMDD Token data element.
  decimal              Creates a new Decimal Token data element.
  email                Creates a new Email Token data element.
  integer              Creates a new Integer Token data element.
  lower-ascii          Creates a new Lower ASCII Token data element.
  numeric              Creates a new Numeric Token data element.
  printable            Creates a new Printable Token data element.
  unicode              Creates a new Unicode Token data element.
  unicode-base64       Creates a new Unicode Base64 Token data element.
  unicode-gen2         Creates a new Unicode Gen2 Token data element.
  upper-alpha-numeric  Creates a new Upper Alpha Numeric Token data element.
  upper-alphabetic     Creates a new Upper Alphabetic Token data element.

pim create dataelements token alpha-numeric --help

Usage: pim create dataelements token alpha-numeric [OPTIONS]

  Creates a new Alpha Numeric Token data element.

  EXAMPLES:     # Create for reference codes pim create dataelements token
  alpha-numeric --name "RefCodeToken" --description "Reference code
  alphanumeric tokenization" --tokenizer "SLT_1_3" --from-left 2 --allow-short
  NOWITHERROR

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3|SLT_1_6|SLT_2_6]
                                  The lookup tables to be generated.
                                  [required]
  --from-left INTEGER             Number of characters to keep in clear from
                                  the left.
  --from-right INTEGER            Number of characters to keep in clear from
                                  the right.
  --length-preserving             Specifies whether the output must be of the
                                  same length as the input.
  --allow-short [YES|NOINPUTVALUE|NOWITHERROR]
                                  Allow short tokens.
  --help                          Show this message and exit.

pim create dataelements token alphabetic --help

Usage: pim create dataelements token alphabetic [OPTIONS]

  Creates a new Alphabetic Token data element.

  EXAMPLES:

  # Create length-preserving alphabetic token
  pim create dataelements token alphabetic --name "ExactLengthAlpha" --description "Length-preserving alphabetic token" --tokenizer "SLT_2_3" --length-preserving

  # Create for name tokenization with short value support
  pim create dataelements token alphabetic --name "NameToken" --description "Name tokenization with short support" --tokenizer "SLT_2_3" --allow-short YES --length-preserving

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3]   The lookup tables to be generated.
                                  [required]
  --from-left INTEGER             Number of characters to keep in clear from
                                  the left.
  --from-right INTEGER            Number of characters to keep in clear from
                                  the right.
  --length-preserving             Specifies whether the output must be of the
                                  same length as the input.
  --allow-short [YES|NOINPUTVALUE|NOWITHERROR]
                                  Allow short tokens.
  --help                          Show this message and exit.

pim create dataelements token binary --help

Usage: pim create dataelements token binary [OPTIONS]

  Creates a new Binary Token data element.

  EXAMPLES:

  # Create basic binary tokenization
  pim create dataelements token binary --name "BinaryToken" --description "Binary data tokenization" --tokenizer "SLT_1_3"

Options:
  --name TEXT                    The name for the data element.  [required]
  --description TEXT             An optional description for the data element.
  --tokenizer [SLT_1_3|SLT_2_3]  The lookup tables to be generated.
                                 [required]
  --from-left INTEGER            Number of characters to keep in clear from
                                 the left.
  --from-right INTEGER           Number of characters to keep in clear from
                                 the right.
  --help                         Show this message and exit.

pim create dataelements token credit-card --help

Usage: pim create dataelements token credit-card [OPTIONS]

  Creates a new Credit Card Token data element.

  EXAMPLES:

  # Create basic credit card tokenization
  pim create dataelements token credit-card --name "CCTokenBasic" --description "Basic credit card tokenization" --tokenizer "SLT_1_6"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3|SLT_1_6|SLT_2_6]
                                  The lookup tables to be generated.
                                  [required]
  --from-left INTEGER             Number of characters to keep in clear from
                                  the left.
  --from-right INTEGER            Number of characters to keep in clear from
                                  the right.
  --invalid-card-type             Token values will not begin with digits that
                                  real credit card numbers begin with.
  --invalid-luhn-digit            Validate Luhn checksum (requires valid
                                  credit cards as input).
  --alphabetic-indicator          Include one alphabetic character in the
                                  token.
  --alphabetic-indicator-position INTEGER
                                  Position for the alphabetic indicator
                                  (required when alphabetic-indicator is
                                  enabled).
  --help                          Show this message and exit.

pim create dataelements token date-ddmmyyyy --help

Usage: pim create dataelements token date-ddmmyyyy [OPTIONS]

  Creates a new Date DDMMYYYY Token data element.

  EXAMPLES:

  # Create basic DDMMYYYY date tokenization
  pim create dataelements token date-ddmmyyyy --name "DateDDMMYYYY" --description "European date format DD-MM-YYYY tokenization" --tokenizer "SLT_1_3"

  # Create for compliance reporting dates
  pim create dataelements token date-ddmmyyyy --name "ComplianceDate" --description "Compliance reporting DD-MM-YYYY dates" --tokenizer "SLT_2_3"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3|SLT_1_6|SLT_2_6]
                                  The lookup tables to be generated.
                                  [required]
  --help                          Show this message and exit.

pim create dataelements token date-mmddyyyy --help

Usage: pim create dataelements token date-mmddyyyy [OPTIONS]

  Creates a new Date MMDDYYYY Token data element.

  EXAMPLES:

  # Create for financial reporting dates
  pim create dataelements token date-mmddyyyy --name "FinancialReportDate" --description "Financial reporting MM-DD-YYYY format" --tokenizer "SLT_2_3"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3|SLT_1_6|SLT_2_6]
                                  The lookup tables to be generated.
                                  [required]
  --help                          Show this message and exit.

pim create dataelements token date-time --help

Usage: pim create dataelements token date-time [OPTIONS]

  Creates a new Date Time Token data element.

  EXAMPLES:

  # Create basic date-time tokenization
  pim create dataelements token date-time --name "DateTimeToken" --description "Basic date-time tokenization" --tokenizer "SLT_8_DATETIME"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_8_DATETIME]    The lookup tables to be generated.
                                  [required]
  --tokenize-time                 Whether to tokenize time (HH:MM:SS).
  --distinguishable-date          Whether date tokens should be
                                  distinguishable from real dates.
  --date-in-clear [NONE|YEAR|MONTH]
                                  Which date parts to keep in clear.
  --help                          Show this message and exit.

pim create dataelements token date-yyyymmdd --help

Usage: pim create dataelements token date-yyyymmdd [OPTIONS]

  Creates a new Date YYYYMMDD Token data element.

  EXAMPLES:

  # Create basic YYYYMMDD date tokenization
  pim create dataelements token date-yyyymmdd --name "DateYYYYMMDD" --description "Date tokenization in YYYY-MM-DD format" --tokenizer "SLT_1_3"

  # Create for event date tracking
  pim create dataelements token date-yyyymmdd --name "EventDateToken" --description "Event date in YYYY-MM-DD format" --tokenizer "SLT_2_3"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3|SLT_1_6|SLT_2_6]
                                  The lookup tables to be generated.
                                  [required]
  --help                          Show this message and exit.

pim create dataelements token decimal --help

Usage: pim create dataelements token decimal [OPTIONS]

  Creates a new Decimal Token data element.

  EXAMPLES:

  # Create basic decimal tokenization for amounts
  pim create dataelements token decimal --name "DecimalToken" --description "Financial decimal amount tokenization" --tokenizer "SLT_6_DECIMAL" --max-length 15

Options:
  --name TEXT                  The name for the data element.  [required]
  --description TEXT           An optional description for the data element.
  --tokenizer [SLT_6_DECIMAL]  The lookup tables to be generated.  [required]
  --min-length INTEGER         Minimum length of the token element that can be
                               protected.
  --max-length INTEGER         Maximum length of the token element that can be
                               protected (max 38).  [required]
  --help                       Show this message and exit.

pim create dataelements token email --help

Usage: pim create dataelements token email [OPTIONS]

  Creates a new Email Token data element.

  EXAMPLES:

  # Create basic email tokenization
  pim create dataelements token email --name "EmailTokenBasic" --description "Basic email tokenization" --tokenizer "SLT_1_3"  --allow-short NOWITHERROR

  # Create email tokenization with error on short input
  pim create dataelements token email --name "EmailTokenError" --description "Email tokenization with short input errors" --tokenizer "SLT_1_3" --length-preserving  --allow-short NOWITHERROR

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3]   The lookup tables to be generated.
                                  [required]
  --length-preserving             Specifies whether the output must be of the
                                  same length as the input.
  --allow-short [YES|NOINPUTVALUE|NOWITHERROR]
                                  Allow short tokens.
  --help                          Show this message and exit.

pim create dataelements token integer --help

Usage: pim create dataelements token integer [OPTIONS]

  Creates a new Integer Token data element.

  EXAMPLES:

  # Create basic integer tokenization (default 4-byte)
  pim create dataelements token integer --name "IntegerToken" --description "Basic integer tokenization" --tokenizer "SLT_1_3"

  # Create short integer tokenization for small numbers
  pim create dataelements token integer --name "ShortIntegerToken" --description "Short integer (2-byte) tokenization" --tokenizer "SLT_1_3" --integer-size "SHORT"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3]           The lookup tables to be generated.
                                  [required]
  --integer-size [SHORT|INT|LONG]
                                  Integer size: 2 bytes (SHORT), 4 bytes
                                  (INT), or 8 bytes (LONG).
  --help                          Show this message and exit.

pim create dataelements token lower-ascii --help

Usage: pim create dataelements token lower-ascii [OPTIONS]

  Creates a new Lower ASCII Token data element.

  EXAMPLES:

  # Create strict ASCII tokenization (error on short input)
  pim create dataelements token lower-ascii --name "StrictAsciiToken" --description "Strict ASCII tokenization" --tokenizer "SLT_1_3" --allow-short "NOWITHERROR"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3]           The lookup tables to be generated.
                                  [required]
  --from-left INTEGER             Number of characters to keep in clear from
                                  the left.
  --from-right INTEGER            Number of characters to keep in clear from
                                  the right.
  --length-preserving             Specifies whether the output must be of the
                                  same length as the input.
  --allow-short [YES|NOINPUTVALUE|NOWITHERROR]
                                  Allow short tokens.
  --help                          Show this message and exit.

pim create dataelements token numeric --help

Usage: pim create dataelements token numeric [OPTIONS]

  Creates a new Numeric Token data element.

  EXAMPLES:

  # Create basic numeric token for SSN
  pim create dataelements token numeric --name "SSNToken" --description "Social Security Number tokenization" --tokenizer "SLT_1_6" --length-preserving

  # Create high-security token for financial data
  pim create dataelements token numeric --name "FinancialToken" --description "Financial account tokenization" --tokenizer "SLT_2_6" --length-preserving --allow-short "NOWITHERROR"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3|SLT_1_6|SLT_2_6]
                                  The lookup tables to be generated.
                                  [required]
  --from-left INTEGER             Number of characters to keep in clear from
                                  the left.
  --from-right INTEGER            Number of characters to keep in clear from
                                  the right.
  --length-preserving             Specifies whether the output must be of the
                                  same length as the input.
  --allow-short [YES|NOINPUTVALUE|NOWITHERROR]
                                  Allow short tokens.
  --help                          Show this message and exit.

pim create dataelements token printable --help

Usage: pim create dataelements token printable [OPTIONS]

  Creates a new Printable Token data element.

  EXAMPLES:

  # Create length-preserving printable token
  pim create dataelements token printable --name "ExactLengthPrintable" --description "Length-preserving printable tokenization" --tokenizer "SLT_1_3" --length-preserving

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3]           The lookup tables to be generated.
                                  [required]
  --from-left INTEGER             Number of characters to keep in clear from
                                  the left.
  --from-right INTEGER            Number of characters to keep in clear from
                                  the right.
  --length-preserving             Specifies whether the output must be of the
                                  same length as the input.
  --allow-short [YES|NOINPUTVALUE|NOWITHERROR]
                                  Allow short tokens.
  --help                          Show this message and exit.

pim create dataelements token unicode --help

Usage: pim create dataelements token unicode [OPTIONS]

  Creates a new Unicode Token data element.

  EXAMPLES:

  # Create with short value support for names
  pim create dataelements token unicode --name "IntlNameToken" --description "International name tokenization" --tokenizer "SLT_2_3" --allow-short "YES"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3]   The lookup tables to be generated.
                                  [required]
  --allow-short [NOWITHERROR|YES|NOINPUTVALUE]
                                  Allow short tokens.
  --help                          Show this message and exit.

pim create dataelements token unicode-base64 --help

Usage: pim create dataelements token unicode-base64 [OPTIONS]

  Creates a new Unicode Base64 Token data element.

  EXAMPLES:

  # Create basic Unicode Base64 tokenization
  pim create dataelements token unicode-base64 --name "UnicodeBase64Token" --description "Base64 encoded Unicode tokenization" --tokenizer "SLT_1_3"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3|SLT_1_6|SLT_2_6]
                                  The lookup tables to be generated.
                                  [required]
  --help                          Show this message and exit.

pim create dataelements token unicode-gen2 --help

Usage: pim create dataelements token unicode-gen2 [OPTIONS]

  Creates a new Unicode Gen2 Token data element.

  EXAMPLES:

  # Create basic Unicode Gen2 token with custom alphabet
  pim create dataelements token unicode-gen2 --name "UnicodeGen2Token" --description "Unicode Gen2 with custom alphabet" --tokenizer "SLT_1_3" --alphabet-uid "1"

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_X_1]   The lookup tables to be generated.
                                  [required]
  --alphabet-uid TEXT             The UID of the alphabet to use for
                                  tokenization.  [required]
  --from-left INTEGER             Number of characters to keep in clear from
                                  the left.
  --from-right INTEGER            Number of characters to keep in clear from
                                  the right.
  --length-preserving             Specifies whether the output must be of the
                                  same length as the input.
  --allow-short [YES|NOINPUTVALUE|NOWITHERROR]
                                  Allow short tokens.
  --default-encoding TEXT         Default encoding (kept for backwards
                                  compatibility).
  --help                          Show this message and exit.

pim create dataelements token upper-alpha-numeric --help

Usage: pim create dataelements token upper-alpha-numeric 
           [OPTIONS]

  Creates a new Upper Alpha Numeric Token data element.

  EXAMPLES:

  # Create for product codes
  pim create dataelements token upper-alpha-numeric --name "ProductCodeToken" --description "Product code uppercase tokenization" --tokenizer "SLT_1_3" --from-left 2 --length-preserving

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3]   The lookup tables to be generated.
                                  [required]
  --from-left INTEGER             Number of characters to keep in clear from
                                  the left.
  --from-right INTEGER            Number of characters to keep in clear from
                                  the right.
  --length-preserving             Specifies whether the output must be of the
                                  same length as the input.
  --allow-short [YES|NOINPUTVALUE|NOWITHERROR]
                                  Allow short tokens.
  --help                          Show this message and exit.

pim create dataelements token upper-alphabetic --help

Usage: pim create dataelements token upper-alphabetic [OPTIONS]

  Creates a new Upper Alphabetic Token data element.

  EXAMPLES:

  # Create for organization names with short support
  pim create dataelements token upper-alphabetic --name "OrgNameToken" --description "Organization name tokenization"  --tokenizer "SLT_2_3" --allow-short "NOINPUTVALUE" --length-preserving

Options:
  --name TEXT                     The name for the data element.  [required]
  --description TEXT              An optional description for the data
                                  element.
  --tokenizer [SLT_1_3|SLT_2_3]   The lookup tables to be generated.
                                  [required]
  --from-left INTEGER             Number of characters to keep in clear from
                                  the left.
  --from-right INTEGER            Number of characters to keep in clear from
                                  the right.
  --length-preserving             Specifies whether the output must be of the
                                  same length as the input.
  --allow-short [YES|NOINPUTVALUE|NOWITHERROR]
                                  Allow short tokens.
  --help                          Show this message and exit.

pim create datastores --help

Usage: pim create datastores [OPTIONS] COMMAND [ARGS]...

  Commands for creating datastore resources.

Options:
  --help  Show this message and exit.

Commands:
  datastore  Creates a new datastore with the specified name and configuration.
  key        Creates and exports a datastore key for secure data operations.
  range      Adds an IP address range to a datastore for network access control.

pim create datastores datastore --help

Usage: pim create datastores datastore [OPTIONS]

  Creates a new datastore with the specified name and configuration.

  Datastores represent physical or logical storage systems that host protected
  data. They define where data protection policies are applied and provide the
  foundation for implementing encryption, tokenization, and access controls.

  EXAMPLES:

  # Create a simple datastore for development
  pim create datastores datastore --name "dev-database" --description "Development PostgreSQL database"

  # Create production datastore with detailed description
  pim create datastores datastore --name "prod-customer-db" --description "Production customer data warehouse with PII protection"

  # Create datastore and set as default
  pim create datastores datastore --name "primary-db" --description "Primary application database" --default

  WORKFLOW:
  # Step 1: Plan your datastore configuration
  # - Choose descriptive name for identification
  # - Decide if this should be the default datastore

  # Step 2: Create the datastore
  pim create datastores datastore --name <name> --description <description> [--default]

  # Step 3: Configure IP ranges and access controls
  pim create datastores range <datastore-uid> --from-ip <start> --to <end>

  # Step 4: Set up encryption keys if needed
  pim create datastores key <datastore-uid> --name <key-name>

Options:
  --name TEXT         Name of the datastore.  [required]
  --description TEXT  Description for the datastore.
  --default           Set this datastore as the default.
  --help              Show this message and exit.

pim create datastores key --help

Usage: pim create datastores key [OPTIONS] DATASTORE_UID

  Creates and exports a datastore key for secure data operations.

  EXAMPLES:

  # Create RSA export key for datastore
  pim create datastores key 15 --algorithm "RSA-OAEP-512" --description "export key" --pem "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ...\n-----END PUBLIC KEY-----"

  WORKFLOW:
  # Step 1: Generate a key pair (outside of PIM)
  openssl genrsa -out private_key.pem 2048
  openssl rsa -in private_key.pem -pubout -out public_key.pem

  # Step 2: Prepare the PEM content (escape newlines for command line)
  awk 'NF {sub(/
  /, ""); printf "%s\n",$0;}' public_key.pem

  # Step 3: Create the export key in PIM
  pim create datastores key <datastore-uid> --algorithm <algorithm> --description <description> --pem <pem-content>

  # Step 4: Verify the key was created
  pim get datastores keys <datastore-uid>

Options:
  --algorithm [RSA-OAEP-256|RSA-OAEP-512]
                                  Algorithm for the key.  [required]
  --description TEXT              Description of the key.
  --pem TEXT                      PEM formatted public key.  [required]
  --help                          Show this message and exit.

pim create datastores range --help

Usage: pim create datastores range [OPTIONS] DATASTORE_UID

  Adds an IP address range to a datastore for network access control.

  IP ranges define which network addresses are allowed to access the
  datastore. This provides network-level security by restricting datastore
  access to specific IP addresses or CIDR blocks.

  EXAMPLES:

  # Add single IP address access
  pim create datastores range 15 --from "192.168.1.100" --to "192.168.1.100"

  # Add corporate network access range
  pim create datastores range <datastore-uid> --from "10.0.0.1" --to "10.0.255.255"

  WORKFLOW:
  # Step 1: Get datastore UID
  pim get datastores datastore

  # Step 2: Plan your IP range requirements
  # - Identify source networks that need access
  # - Define start and end IP addresses

  # Step 3: Create the IP range
  pim create datastores range <datastore-uid> --from <start-ip> --to <end-ip>

  # Step 4: Verify the range was created
  pim get datastores ranges <datastore-uid>

Options:
  --from TEXT  Start IP address of the range.  [required]
  --to TEXT    End IP address of the range.  [required]
  --help       Show this message and exit.

pim create deploy --help

Usage: pim create deploy [OPTIONS]

  Deploys policies and/or trusted applications to a data store.

  Creates a deployment that pushes data protection policies and trusted
  application configurations to the specified datastore.

  EXAMPLES:

  # Deploy single policy to a datastore
  pim create deploy --data-store-uid 15 --policy-uids 1

  # Deploy multiple policies to a datastore
  pim create deploy --data-store-uid 15 --policy-uids 1 --policy-uids 2 --policy-uids 3

  # Deploy trusted applications to grant access
  pim create deploy --data-store-uid 15 --trusted-application-uids 1 --trusted-application-uids 2

  # Deploy both policies and applications together
  pim create deploy --data-store-uid 15 --policy-uids 1 --policy-uids 2 --trusted-application-uids 1 --trusted-application-uids 2

  WORKFLOW:
  # Step 1: Verify datastore exists and is accessible
  pim get datastores datastore <data-store-uid>

  # Step 2: List available policies and applications
  pim get policies policy
  pim get applications application

  # Step 3: Deploy to a datastore
  pim create deploy --data-store-uid <datastore-uid> --policy-uids <policy-uid> --trusted-application-uids <app-uid>

  # Step 4: Verify deployment was successful
  pim get deploy

Options:
  --data-store-uid TEXT                UID of the data store to deploy.  [required]
  --policy-uids TEXT                   UIDs of the policies to deploy.
  --trusted-application-uids TEXT      UIDs of the trusted applications to deploy.
  --help                               Show this message and exit.

pim create masks --help

Usage: pim create masks [OPTIONS]

  Creates a new mask with specified masking pattern and configuration.

  EXAMPLES:

  # Create mask for credit card numbers (show last 4 digits)
  pim create masks --name "credit-card-mask" --description "Mask credit card showing last 4 digits" --from-left 0 --from-right 4 --character "*"

  MASKING PATTERNS:

  Credit Card Masking (****-****-****-1234):
  --from-left 0 --from-right 4 --character "*"

  Email Masking (j***@example.com):
  --from-left 1 --from-right 0 --character "*"

  Full Masking (***********):
  --from-left 0 --from-right 0 --character "*" --masked

Options:
  --name TEXT           The name for the mask.  [required]
  --description TEXT    An optional description for the mask.
  --from-left INTEGER   Number of characters to be masked or kept in clear
                        from the left.  [required]
  --from-right INTEGER  Number of characters to be masked or kept in clear
                        from the right.  [required]
  --masked              Specifies whether the left and right characters should
                        be masked or kept in clear.
  --character TEXT      Specifies the mask character (*,#,-,0,1,2,3,4,5,6,7,8,
                        or 9).  [required]
  --help                Show this message and exit.

pim create policies --help

Usage: pim create policies [OPTIONS] COMMAND [ARGS]...

  Creates a new policy or rule.

Options:
  --help  Show this message and exit.

Commands:
  policy  Creates a new data protection policy with specified access permissions.
  rules   Creates multiple rules and adds them to a policy in bulk.

pim create policies policy --help

Usage: pim create policies policy [OPTIONS]

  Creates a new data protection policy with specified access permissions.

    EXAMPLES:

  # Create basic policy with all protection operations enabled
  pim create policies policy --name "full-protection-policy" --description "Complete data protection with all operations" --protect --re-protect --un-protect

  # Create read-only policy (no protection operations)
  pim create policies policy --name "read-only-policy" --description "Read-only access without protection operations"

Options:
  --name TEXT         Name of the policy.  [required]
  --description TEXT  Description of the policy.  [required]
  --protect           Allow protect operation.
  --re-protect        Allow re-protect operation.
  --un-protect        Allow un-protect operation.
  --help              Show this message and exit.

pim create policies rules --help

Usage: pim create policies rules [OPTIONS] POLICY_UID

  Creates multiple rules and adds them to a policy in bulk.

  Rules define the mapping between roles and data elements with specific
  protection methods and access permissions. Each rule specifies how a role
  can access a data element, what masking to apply, and which protection
  operations are allowed.

  RULE FORMAT: role_uid,data_element_uid[,mask][,no_access_operation][,protect
  ][,re_protect][,un_protect]

  EXAMPLES:

  # Create rules for different roles accessing PII data elements
  pim create policies rules 15  --rule "1,3,1,NULL_VALUE,true,true,true" --rule "3,3,1,PROTECTED_VALUE,false,false,false" --rule "4,2,,NULL_VALUE,true,false,false"

  WORKFLOW:
  # Step 1: Verify policy exists and review its configuration
  pim get policies <policy-uid>

  # Step 2: Identify required roles and data elements
  pim get applications application  # for roles
  pim get data_elements data_element  # for data elements
  pim get masks  # for available masks

  # Step 3: Create rules in bulk
  pim create policies rules <policy-uid> --rule "..." --rule "..." --rule "..."

  # Step 4: Verify rules were created successfully
  pim get policies <policy-uid> --rules

  PARAMETER DESCRIPTIONS:

  role_uid (Required): UID of the role/application that will access data
  - References trusted applications or user roles
  - Must exist in the system before creating rules
  - Determines who can perform operations on data elements

  data_element_uid (Required): UID of the data element 
  - References specific data fields or columns
  - Must exist before creating rules
  - Defines what data is being protected

  mask (Optional): UID of mask to apply for data obfuscation
  - Empty/omitted: No masking applied
  - Must reference existing mask configuration
  - Controls how data appears when accessed

  no_access_operation (Optional, Default: NULL_VALUE):
  - NULL_VALUE: Return null when access denied
  - PROTECTED_VALUE: Return masked/protected format
  - EXCEPTION: Throw exception when access denied

  protect (Optional, Default: false): Allow data protection operations
  - true: Role can encrypt/tokenize/mask data
  - false: Role cannot perform protection operations

  re_protect (Optional, Default: false): Allow data re-protection
  - true: Role can change protection methods/keys
  - false: Role cannot re-protect data

  un_protect (Optional, Default: false): Allow data un-protection
  - true: Role can decrypt/detokenize/unmask data
  - false: Role cannot remove protection

  Examples: --rule "role1,de1,mask1,NULL_VALUE,true,false,false" --rule
  "role2,de2,,EXCEPTION,false,true,true"  --rule "role3,de3"

Options:
  --rule TEXT  Rule specification in format: "role_uid,data_element_uid[,mask]
               [,no_access_operation][,protect][,re_protect][,un_protect]".
               Can be specified multiple times.  [required]
  --help       Show this message and exit.

pim create roles --help

Usage: pim create roles [OPTIONS] COMMAND [ARGS]...

  Creates a new role or adds members to a role.

Options:
  --help  Show this message and exit.

Commands:
  members  Adds members to a role in bulk.
  role     Creates a new role with specified configuration and access mode.

pim create roles members --help

Usage: pim create roles members [OPTIONS] ROLE_UID

  Adds members to a role in bulk.

  Members can be individual users or groups from various identity sources.
  This command allows adding multiple members at once with proper validation
  and error handling for each member specification.

  MEMBER FORMAT: name,source,sync_id,type  OR  name,source,type (sync_id
  optional)

  EXAMPLES:

  # Add individual users from LDAP
  pim create roles members 15  --member "john.doe,1,12345,USER" --member "jane.smith,1,67890,USER"

  Examples: --member "john.doe,ldap,12345,USER" --member
  "admin_group,ldap,67890,GROUP" --member "jane.smith,ad,USER"  (sync_id
  omitted)

Options:
  --member TEXT  Member specification in format: "name,source,sync_id,type" or
                 "name,source,type". Can be specified multiple times. Where
                 name is the member name (required, min_length=1), source is
                 the source of the member (required), sync_id is the
                 synchronization ID (optional), and type is the member type
                 (required: USER or GROUP).
  --help         Show this message and exit.

pim create roles role --help

Usage: pim create roles role [OPTIONS]

  Creates a new role with specified configuration and access mode.

  EXAMPLES:

  # Create semiautomatic role for project team
  pim create roles role --name "project-alpha-team" --description "Project Alpha mixed access" --mode "SEMIAUTOMATIC"

Options:
  --name TEXT                               Name of the role.  [required]
  --description TEXT                        Description of the role.
  --mode [MANUAL|SEMIAUTOMATIC|AUTOMATIC]   Role mode.  [required]
  --allow-all                               Allow access to all users for this role.
  --help                                    Show this message and exit.

pim create sources --help

Usage: pim create sources [OPTIONS] COMMAND [ARGS]...

  Creates a new source.

Options:
  --help  Show this message and exit.

Commands:
  ad        Creates a new Active Directory source for Windows domain integration.
  azure     Creates a new AZURE AD source for Microsoft cloud identity integration.
  database  Creates a new DATABASE source for relational database user repositories.
  file      Creates a new FILE source for static user and group management.
  ldap      Creates a new LDAP source for directory-based authentication and user management.
  posix     Creates a new POSIX source for Unix/Linux system account integration.

pim create sources ad --help

Usage: pim create sources ad [OPTIONS]

  Creates a new Active Directory source for Windows domain integration.

  EXAMPLES:

  Note: The following commands use line continuation (\) for readability.
  In practice, run each command as a single line or use your shell's
  line continuation syntax

  # Create basic AD source with domain controller
  pim create sources ad --name "corporate-ad" --description "Corporate Active Directory" \
      --host "dc1.company.com" --port 389 \
      --user-name "service@company.com" --pass-word "password123" \
      --base-dn "dc=company,dc=com"

Options:
  --name TEXT         Name of the source.  [required]
  --description TEXT  Description of the source.
  --user-name TEXT    Authentication user.
  --pass-word TEXT    Authentication password.
  --host TEXT         The Fully Qualified Domain Name (FQDN) or IP address of
                      the directory server.
  --port INTEGER      The network port on the directory server where the
                      service is listening.
  --tls               The TLS protocol is enabled to create a secure
                      communication to the directory server.
  --base-dn TEXT      The Base DN for the server to search for users.
  --recursive         Enables recursive search for active directory or Azure
                      AD.
  --ldaps             Use LDAPS instead of startTLS.
  --help              Show this message and exit.

pim create sources azure --help

Usage: pim create sources azure [OPTIONS]

  Creates a new AZURE AD source for Microsoft cloud identity integration.

  EXAMPLES:

  Note: The following commands use line continuation (\) for readability.
  In practice, run each command as a single line or use your shell's
  line continuation syntax.

  # Create basic Azure AD source for corporate tenant
  pim create sources azure --name "corporate-azure" --description "Corporate Azure AD" \
      --client-id "12345678-1234-1234-1234-123456789012" \
      --tenant-id "87654321-4321-4321-4321-210987654321" \
      --environment "PUBLIC"

  # Create Azure AD source with service principal authentication
  pim create sources azure --name "sp-azure" --description "Service Principal Azure AD" \
      --user-name "service-principal@company.onmicrosoft.com" \
      --pass-word "sp-secret-key" \
      --client-id "app-registration-id" \
      --tenant-id "company-tenant-id" \
      --environment "PUBLIC" --recursive

  # Create Azure Government cloud source
  pim create sources azure --name "gov-azure" --description "Azure Government Cloud" \
      --client-id "gov-app-id" \
      --tenant-id "gov-tenant-id" \
      --environment "USGOVERNMENT" \
      --user-attribute "userPrincipalName" \
      --group-attribute "displayName"

  # Create Azure China cloud source
  pim create sources azure --name "china-azure" --description "Azure China Cloud" \
      --client-id "china-app-id" \
      --tenant-id "china-tenant-id" \
      --environment "CHINA" \
      --recursive

  # Create Azure AD with custom attributes
  pim create sources azure --name "custom-azure" --description "Custom Azure AD Configuration" \
      --client-id "custom-app-id" \
      --tenant-id "custom-tenant-id" \
      --environment "PUBLIC" \
      --user-attribute "mail" \
      --group-attribute "displayName" \
      --group-members-attribute "members" \
      --recursive

  # Create multi-tenant Azure AD source
  pim create sources azure --name "partner-azure" --description "Partner Tenant Azure AD" \
      --client-id "partner-app-id" \
      --tenant-id "partner-tenant-id" \
      --environment "PUBLIC" \
      --user-name "guest@partner.onmicrosoft.com" \
      --pass-word "guest-credentials"

Options:
  --name TEXT                     Name of the source.  [required]
  --description TEXT              Description of the source.
  --user-name TEXT                Authentication user.
  --pass-word TEXT                Authentication password.
  --recursive                     Enables recursive search for active
                                  directory or Azure AD.
  --user-attribute TEXT           The Relative Distinguished Name (RDN)
                                  attribute of the user distinguished name.
  --group-attribute TEXT          The Relative Distinguished Name (RDN)
                                  attribute of the group distinguished name.
  --group-members-attribute TEXT  The attribute that enumerates members of the
                                  group.
  --client-id TEXT                The client id for AZURE AD.
  --tenant-id TEXT                The tenant id for the AZURE AD.
  --environment [CHINA|CANARY|PUBLIC|USGOVERNMENT|USGOVERNMENTL5]
                                  The AZURE AD environment that should be used.
  --help                          Show this message and exit.

pim create sources database --help

Usage: pim create sources database [OPTIONS]

  Creates a new DATABASE source for relational database user repositories.

  EXAMPLES:

  Note: The following commands use line continuation (\) for readability.
  In practice, run each command as a single line or use your shell's
  line continuation syntax

  # Create Oracle database source with DSN
  pim create sources database --name "oracle-hr" --description "Oracle HR Database" \
      --user-name "pim_service" --pass-word "oracle123" \
      --host "oracle.company.com" --port 1521 \
      --dsn "XE" --vendor "ORACLE"

Options:
  --name TEXT                     Name of the source.  [required]
  --description TEXT              Description of the source.
  --user-name TEXT                Authentication user.
  --pass-word TEXT                Authentication password.
  --host TEXT                     The Fully Qualified Domain Name (FQDN) or IP
                                  address of the database server.
  --port INTEGER                  The network port on the directory server
                                  where the service is listening.
  --dsn TEXT                      The Data Source Name (DSN) for ODBC
                                  connection.
  --vendor [TERADATA|ORACLE|DATABASE|SQLSERVER|DB2|POSTGRESQLX]
                                  The vendor of the ODBC driver.
  --help                          Show this message and exit.

pim create sources file --help

Usage: pim create sources file [OPTIONS]

  Creates a new FILE source for static user and group management.

  EXAMPLES:

  # Create basic file source with user list
  pim create sources file --name "dev-users" --description "environment users" --user-file exampleusers.txt --group-file examplegroups.txt

Options:
  --name TEXT         Name of the source.  [required]
  --description TEXT  Description of the source.
  --user-file TEXT    A sample file that contains a list of individual
                      members.
  --group-file TEXT   A sample file that contains groups of members.
  --help              Show this message and exit.

pim create sources ldap --help

Usage: pim create sources ldap [OPTIONS]

  Creates a new LDAP source for directory-based authentication and user
  management.

  EXAMPLES:

  Note: The following commands use line continuation (\) for readability.
  In practice, run each command as a single line or use your shell's
  line continuation syntax

  # Create basic LDAP source with minimal configuration
  pim create sources ldap --name "company-ldap" --description "Company LDAP directory" \
      --host "ldap.company.com" --port 389 \
      --user-name "cn=admin,dc=company,dc=com" --pass-word "password123" \
      --user-base-dn "ou=users,dc=company,dc=com" \
      --group-base-dn "ou=groups,dc=company,dc=com"

  # Create OpenLDAP source with detailed configuration
  pim create sources ldap --name "openldap-prod" --description "Production OpenLDAP" \
      --host "openldap.company.com" --port 389 \
      --user-name "cn=readonly,dc=company,dc=com" --pass-word "readonly123" \
      --user-base-dn "ou=employees,dc=company,dc=com" \
      --user-attribute "uid" --user-object-class "posixAccount" \
      --user-login-attribute "uid" \
      --group-base-dn "ou=departments,dc=company,dc=com" \
      --group-attribute "cn" --group-object-class "posixGroup" \
      --group-members-attribute "memberUid" --timeout 60

Options:
  --name TEXT                     Name of the source.  [required]
  --description TEXT              Description of the source.
  --user-name TEXT                Authentication user.
  --pass-word TEXT                Authentication password.
  --host TEXT                     The Fully Qualified Domain Name (FQDN) or IP
                                  address of the directory server.
  --port INTEGER                  The network port on the directory server
                                  where the service is listening.
  --tls                           The TLS protocol is enabled to create a
                                  secure communication to the directory
                                  server.
  --user-base-dn TEXT             The base distinguished name where users can
                                  be found in the directory.
  --user-attribute TEXT           The Relative Distinguished Name (RDN)
                                  attribute of the user distinguished name.
  --user-object-class TEXT        The object class of entries where user
                                  objects are stored.
  --user-login-attribute TEXT     The attribute intended for authentication or
                                  login.
  --group-base-dn TEXT            The base distinguished name where groups can
                                  be found in the directory.
  --group-attribute TEXT          The Relative Distinguished Name (RDN)
                                  attribute of the group distinguished name.
  --group-object-class TEXT       The object class of entries where group
                                  objects are stored.
  --group-members-attribute TEXT  The attribute that enumerates members of the
                                  group.
  --group-member-is-dn            The members may be listed using their fully
                                  qualified name.
  --timeout INTEGER               The timeout value when waiting for a
                                  response from the directory server.
  --help                          Show this message and exit.

pim delete --help

Usage: pim delete [OPTIONS] COMMAND [ARGS]...

  Delete a resource.

Options:
  --help  Show this message and exit.

Commands:
  alphabets     Deletes a specific alphabet by UID.
  applications  Deletes a specific application by UID.
  dataelements  Deletes a specific data element by UID.
  datastores    Commands for deleting datastore resources.
  masks         Deletes a specific mask by its UID.
  policies      Deletes a policy, a rule from a policy, or a data element from a policy.
  roles         Commands for deleting role resources.
  sources       Permanently deletes a source from the system.

pim delete alphabets --help

Usage: pim delete alphabets [OPTIONS] UID

  Deletes a specific alphabet by UID.

  WORKFLOW:

  # Step 1: First, list all alphabets to find the UID you want to delete
  pim get alphabets

  # Step 2: Copy the UID from the list and use it to delete the alphabet
  pim delete alphabets <uid-from-list>

  EXAMPLES:

  # Complete workflow example:
  # 1. List all alphabets to see available UIDs
  pim get alphabets

  # 2. Delete a specific alphabet using UID from the list above
  pim delete alphabets 14

Options:
  --help  Show this message and exit.

pim delete applications --help

Usage: pim delete applications [OPTIONS] UID

  Deletes a specific application by UID.

  WORKFLOW:

  # Step 1: First, list all applications to find the UID you want to delete
  pim get applications

  # Step 2: Copy the UID from the list and use it to delete the application
  pim delete applications <uid-from-list>

  EXAMPLES:

  # 1. List all applications to see available UIDs
  pim get applications

  # 2. Delete a specific application using numeric UID from the list above
  pim delete applications 42

Options:
  --help  Show this message and exit.

pim delete dataelements --help

Usage: pim delete dataelements [OPTIONS] UID

  Deletes a specific data element by UID.

  WORKFLOW:

  # Step 1: First, list all data elements to find the UID you want to delete
  pim get dataelements

  # Step 2: Copy the UID from the list and use it to delete the data element
  pim delete dataelements <uid-from-list>

  EXAMPLES:

  # Complete workflow example: # 1. List all data elements to see available
  UIDs pim get dataelements

  # 2. Delete a specific data element using numeric UID from the list above
  pim delete dataelements 42

Options:
  --help  Show this message and exit.

pim delete datastores --help

Usage: pim delete datastores [OPTIONS] COMMAND [ARGS]...

  Commands for deleting datastore resources.

Options:
  --help  Show this message and exit.

Commands:
  datastore  Deletes a datastore by UID.
  key        Deletes an export key from a datastore.
  range      Deletes an IP address range from a datastore.

pim delete datastores datastore --help

Usage: pim delete datastores datastore [OPTIONS] UID

  Deletes a datastore by UID.

  EXAMPLES:

  # Delete datastore by numeric UID
  pim delete datastores datastore 15

Options:
  --help  Show this message and exit.

pim delete datastores key --help

Usage: pim delete datastores key [OPTIONS] DATASTORE_UID KEY_UID

  Deletes an export key from a datastore.      
  
  EXAMPLES:

  # Remove specific export key from datastore
  pim delete datastores key 1 2

  WORKFLOW:
  # Step 1: List current keys to identify the key UID
  pim get datastores keys <datastore-uid>

  # Step 2: Verify which processes use this key
  # - Check backup and migration schedules
  # - Verify no active export operations

  # Step 3: Delete the key
  pim delete datastores key <datastore-uid> <key-uid>

  # Step 4: Verify deletion
  pim get datastores keys <datastore-uid>

Options:
  --help  Show this message and exit.

pim delete datastores range --help

Usage: pim delete datastores range [OPTIONS] DATASTORE_UID RANGE_UID

  Deletes an IP address range from a datastore.

  EXAMPLES:

  # Remove specific IP range from datastore
  pim delete datastores range 15 1

  WORKFLOW:
  # Step 1: List current ranges to identify the range UID
  pim get datastores ranges <datastore-uid>

  # Step 2: Verify which systems use this range
  # - Check with network administrators
  # - Verify no active connections from this range

  # Step 3: Delete the range
  pim delete datastores range <datastore-uid> <range-uid>

  # Step 4: Verify deletion
  pim get datastores ranges <datastore-uid>

Options:
  --help  Show this message and exit.

pim delete masks --help

Usage: pim delete masks [OPTIONS] UID

  Deletes a specific mask by its UID.

  EXAMPLES:

  # Delete mask by UID
  pim delete masks 15

Options:
  --help  Show this message and exit.

pim delete policies --help

Usage: pim delete policies [OPTIONS] UID

  Deletes a policy, a rule from a policy, or a data element from a policy.

  EXAMPLES:

  # Delete entire policy (removes all rules and deployments)
  pim delete policies 15

  # Remove specific rule from policy
  pim delete policies 15 --rule-uid 23

  # Remove all rules for specific data element from policy
  pim delete policies 42 --data-element-uid 67

Options:
  --rule-uid TEXT          UID of the rule to remove.
  --data-element-uid TEXT  UID of the data element to remove from a policy.
  --help                   Show this message and exit.

pim delete roles --help

Usage: pim delete roles [OPTIONS] COMMAND [ARGS]...

  Commands for deleting role resources.

Options:
  --help  Show this message and exit.

Commands:
  members  Removes a specific member from a role.
  role     Permanently deletes a role from the system.

pim delete roles members --help

Usage: pim delete roles members [OPTIONS] ROLE_UID MEMBER_UID

  Removes a specific member from a role.

  EXAMPLES:

  # Remove specific user from role
  pim delete roles members 15 42
  pim delete roles members <role_uuid> <member_uuid>

Options:
  --help  Show this message and exit.

pim delete roles role --help

Usage: pim delete roles role [OPTIONS] UID

  Permanently deletes a role from the system.

  EXAMPLES:

  # Remove specific role  
  pim delete roles role 15

Options:
  --help  Show this message and exit.

pim delete sources --help

Usage: pim delete sources [OPTIONS] UID

  Permanently deletes a source from the system.

  EXAMPLES:

  # Interactive source deletion with confirmation
  pim delete sources 15

Options:
  --help  Show this message and exit.

pim get --help

Usage: pim get [OPTIONS] COMMAND [ARGS]...

  Display one or many resources.

Options:
  --help  Show this message and exit.

Commands:
  alphabets     Gets a specific alphabet by UID, or lists all alphabets if no UID is provided.
  applications  Gets a specific application by UID, or lists all applications if no UID is provided.
  dataelements  Gets a specific data element by UID, or lists all data elements if no UID is provided.
  datastores    Commands for getting datastore resources.
  deploy        List deployment history across all datastores.
  health        Displays the server health information and status.
  log           Gets the current log level configuration.
  masks         Gets a specific mask by UID, or lists all masks if no UID is provided.
  policies      Gets a specific policy by UID, lists all policies, or lists rules of a policy.
  ready         Displays the server readiness information and operational status.
  roles         Commands for getting role resources.
  sources       Gets source information by UID, lists all sources, or lists source members.
  version       Displays the server version information.

pim get alphabets --help

Usage: pim get alphabets [OPTIONS] [UID]

  Gets a specific alphabet by UID, or lists all alphabets if no UID is
  provided.

  EXAMPLES:

  # List all available alphabets
  pim get alphabets

  # Get details for a specific alphabet by UID
  pim get alphabets 29

Options:
  --help  Show this message and exit.

pim get applications --help

Usage: pim get applications [OPTIONS] [UID]

  Gets a specific application by UID, or lists all applications if no UID is
  provided.

  EXAMPLES:

  # List all available applications
  pim get applications

  # Get details for a specific application by UID
  pim get applications 1

Options:
  --help  Show this message and exit.

pim get dataelements --help

Usage: pim get dataelements [OPTIONS] [UID]

  Gets a specific data element by UID, or lists all data elements if no UID is
  provided.

  EXAMPLES:

  # List all available data elements pim get dataelements

  # Get details for a specific data element by UID pim get dataelements 15

Options:
  --help  Show this message and exit.

pim get datastores --help

Usage: pim get datastores [OPTIONS] COMMAND [ARGS]...

  Commands for getting datastore resources.

Options:
  --help  Show this message and exit.

Commands:
  datastore  Gets a specific datastore by UID, or lists all datastores if no UID is provided.
  keys       Gets a specific key by UID, or lists all keys for a datastore.
  ranges     Gets a specific range by UID, or lists all ranges for a datastore.

pim get datastores datastore --help

Usage: pim get datastores datastore [OPTIONS] [UID]

  Gets a specific datastore by UID, or lists all datastores if no UID is
  provided.

  Datastores represent the physical or logical storage systems where protected
  data is stored. They contain policies, applications, and IP ranges that
  define access control.

  EXAMPLES:

  # List all available datastores
  pim get datastores datastore

  # Get details for a specific datastore by UID
  pim get datastores datastore 15

Options:
  --help  Show this message and exit.

pim get datastores keys --help

Usage: pim get datastores keys [OPTIONS] DATASTORE_UID

  Gets a specific key by UID, or lists all keys for a datastore.

  Datastore keys manage encryption and access credentials for secure data
  operations. Keys can be export keys for data migration or operational keys
  for ongoing protection services. Key management is critical for data
  security.

  EXAMPLES:

  # List all keys for a specific datastore
  pim get datastores keys <datastore-uid>

  # Get details for a specific key within a datastore
  pim get datastores keys 15 --key-uid <key-uid>

  WORKFLOW:

  # Step 1: List all datastores to find the datastore UID
  pim get datastores datastore

  # Step 2: List keys for the specific datastore
  pim get datastores keys <datastore-uid>

  # Step 3: Get specific key details if needed
  pim get datastores keys <datastore-uid> --key-uid <key-uid>

Options:
  --key-uid TEXT  UID of the specific key to get.
  --help          Show this message and exit.

pim get datastores ranges --help

Usage: pim get datastores ranges [OPTIONS] DATASTORE_UID

  Gets a specific range by UID, or lists all ranges for a datastore.

  IP ranges define which network addresses are allowed to access the
  datastore. Ranges provide network-level security by restricting datastore
  access to specific IP addresses or CIDR blocks.

  EXAMPLES:

  # List all IP ranges for a specific datastore
  pim get datastores ranges 15

  # Get details for a specific range within a datastore
  pim get datastores ranges 15 --range-uid 1

  WORKFLOW:

  # Step 1: List all datastores to find the datastore UID
  pim get datastores datastore

  # Step 2: List ranges for the specific datastore
  pim get datastores ranges <datastore-uid>

  # Step 3: Get specific range details if needed
  pim get datastores ranges <datastore-uid> --range-uid <range-uid>

Options:
  --range-uid TEXT  UID of the range to get.
  --help            Show this message and exit.

pim get deploy --help

Usage: pim get deploy [OPTIONS]

  List deployment history across all datastores.

  EXAMPLES:

  # List all deployment history
  pim get deploy

Options:
  --help  Show this message and exit.

pim get health --help

Usage: pim get health [OPTIONS]

  Displays the server health information and status.

  EXAMPLES:

  # Check current server health status
  pim get health

Options:
  --help  Show this message and exit.

pim get log --help

Usage: pim get log [OPTIONS]

  Gets the current log level configuration.

  EXAMPLES:

  # Check current log level setting
  pim get log

Options:
  --help  Show this message and exit.

pim get masks --help

Usage: pim get masks [OPTIONS] [UID]

  Gets a specific mask by UID, or lists all masks if no UID is provided.

  EXAMPLES:

  # List all available masks
  pim get masks

  # Get details for a specific mask by UID
  pim get masks 15

Options:
  --help  Show this message and exit.

pim get policies --help

Usage: pim get policies [OPTIONS] [UID]

  Gets a specific policy by UID, lists all policies, or lists rules of a
  policy.

  EXAMPLES:

  # List all available policies
  pim get policies

  # Get details for a specific policy by UID
  pim get policies 15

  # List all rules within a specific policy
  pim get policies 15 --rules

Options:
  --rules  List rules of the policy.
  --help   Show this message and exit.

pim get ready --help

Usage: pim get ready [OPTIONS]

  Displays the server readiness information and operational status.

  EXAMPLES:

  # Check if server is ready for requests
  pim get ready

Options:
  --help  Show this message and exit.

pim get roles --help

Usage: pim get roles [OPTIONS] COMMAND [ARGS]...

  Commands for getting role resources.

Options:
  --help  Show this message and exit.

Commands:
  members  Lists all members of a specific role.
  role     Gets a specific role by UID, or lists all roles if no UID is provided.
  users    Lists users of a specific member in a role.

pim get roles members --help

Usage: pim get roles members [OPTIONS] ROLE_UID

  Lists all members of a specific role.

  EXAMPLES:

  # List all members of a specific role
  pim get roles members 15

Options:
  --help  Show this message and exit.

pim get roles role --help

Usage: pim get roles role [OPTIONS] [UID]

  Gets a specific role by UID, or lists all roles if no UID is provided.

  EXAMPLES:

  # List all available roles
  pim get roles role

  # Get details for a specific role by UID
  pim get roles role 15

Options:
  --help  Show this message and exit.

pim get roles users --help

Usage: pim get roles users [OPTIONS] ROLE_UID MEMBER_UID

  Lists users of a specific member in a role.

  EXAMPLES:

  # List users in a specific group member of a role
  pim get roles users 15 23
  pim get roles users "<role-uuid>" "<member-uuid>"

Options:
  --help  Show this message and exit.

pim get sources --help

Usage: pim get sources [OPTIONS] [UID]

  Gets source information by UID, lists all sources, or lists source members.

  EXAMPLES:

  # List all configured sources
  pim get sources

  # Get detailed information about a specific source
  pim get sources 15

  # List all members of a specific source
  pim get sources 23 --members

Options:
  --members  List members of the source.
  --help     Show this message and exit.

pim get version --help

Usage: pim get version [OPTIONS]

  Displays the server version information.

  EXAMPLES:

  # Display server version information
  pim get version

Options:
  --help  Show this message and exit.

pim set --help

Usage: pim set [OPTIONS] COMMAND [ARGS]...

  Update fields of a resource.

Options:
  --help  Show this message and exit.

Commands:
  log  Sets the log level for the PIM server.

pim set log --help

Usage: pim set log [OPTIONS] {ERROR|WARN|INFO|DEBUG|TRACE}

  Sets the log level for the PIM server.

  Higher levels include all lower levels (TRACE includes DEBUG, INFO, WARN,
  ERROR).

  EXAMPLES:

  # Enable debug logging for troubleshooting
  pim set log DEBUG

Options:
  --help  Show this message and exit.