DCT-TOOLKIT COMMAND TOPIC Generated on: Tue Oct 21 12:26:59 USEDT 2025 Source: dct-toolkit-help-2025.5.txt ================================================================================ DCT-TOOLKIT COMPLETE COMMAND REFERENCE Generated on: Tue Oct 21 12:26:59 USEDT 2025 ======================================== MAIN HELP (dct-toolkit.exe -h): ======================================== Usage: dct-toolkit[-hV] [COMMAND] -h, --help Show this help message and exit. -V, --version Print version information and exit. Commands: ================================================================================ ================================================================================ TOPIC: Accounts ================================================================================ Commands (19): get_accounts, create_account, api_key_reset, api_key_delete, api-key-regenerate, get_account, update_account, delete_account, enable_account, disable, change_account_password, reset_account_password, get_account_tags, create_account_tags, delete_account_tags, get_account_ui_profiles, get_password_policies, update_password_policies, search_accounts COMMAND: get_accounts ======================================== Usage: dct-toolkit get_accounts[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_account ======================================== Usage: dct-toolkit create_account[-hVw] [-cs] [-jh] [[[--[no-]is_admin] [-- [no-]generate_api_key] [api_client_id=string] [first_name=string] [last_name=string] [email=string] [username=string] [password=string] [ldap_principal=string] [tags[=array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]is_admin Whether the created account must be granted to admin role. --[no-]generate_api_key Whether an API key must be generated for this Account. This must be set if the Account will be used for API key based authentication, and unset otherwise. api_client_id=string The unique ID which is used to identify the identity of an API request. The web server (nginx) configuration must be configured so as to include the external ID as the value of the X_CLIENT_ID HTTP request header when requests are proxied. If this value isn't set, the application will automatically generate one. For OAuth2/JWT based authentication, this typically corresponds to a value extracted from the JWT, uniquely identifying the Account. first_name=string An optional first name for the Account. last_name=string An optional last name for the Account. email=string An optional email for the Account. username=string The username for username/password authentication. This can also be used to provide an optional logical name for the Account. password=string The password for username/password authentication. ldap_principal=string This value will be used for linking this account to an LDAP user when authenticated with the same LDAP principal. When accounts authenticate with LDAP, an LDAP principal value is calculated based on the username, msad_domain_name, search_base and username_pattern. tags[=array...] The tags to be created for this Account. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: api_key_reset ======================================== Usage: dct-toolkit api_key_reset[-hVw] [-cs] [-jh] id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. id= Numeric ID of the Account. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: api_key_delete ======================================== Usage: dct-toolkit api_key_delete[-hVw] [-cs] [-jh] id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. id= Numeric ID of the Account. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: api-key-regenerate ======================================== Usage: dct-toolkit api-key-regenerate[-hVw] [-cs] [-jh] ([token=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. token=string Current api key for the account --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_account ======================================== Usage: dct-toolkit get_account[-hVw] [-cs] [-jh] id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. id= Numeric ID of the Account. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_account ======================================== Usage: dct-toolkit update_account[-hVw] id= [-cs] [-jh] [[[api_client_id=string] [first_name=string] [last_name=string] [email=string] [username=string] [ldap_principal=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. id= Numeric ID of the Account. api_client_id=string The unique ID which is used to identify the identity of an API request. The web server (nginx) configuration must be configured so as to include the external ID as the value of the X_CLIENT_ID HTTP request header when requests are proxied. For OAuth2/JWT based authentication, this typically corresponds to a value extracted from the JWT, uniquely identifying the Account. first_name=string An optional first name for the Account. last_name=string An optional last name for the Account. email=string An optional email for the Account. username=string The username for username/password authentication. This can also be used to provide an optional logical name for the Account. ldap_principal=string This value will be used for linking this account to an LDAP user when authenticated with the same LDAP principal. When accounts authenticate with LDAP, an LDAP principal value is calculated based on the username, msad_domain_name, search_base and username_pattern. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: delete_account ======================================== Usage: dct-toolkit delete_account[-hVw] [-cs] [-jh] id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. id= Numeric ID of the Account. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: enable_account ======================================== Usage: dct-toolkit enable_account[-hVw] [-cs] [-jh] id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. id= Numeric ID of the Account. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: disable ======================================== Usage: dct-toolkit disable[-hVw] [-cs] [-jh] id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. id= Numeric ID of the Account. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: change_account_password ======================================== Usage: dct-toolkit change_account_password[-hVw] id= [-cs] [-jh] ([old_password=string [new_password=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. id= Numeric ID of the Account. old_password=string Old password that needs to be changed for the Account. new_password=string New password that needs to be set for the Account. Set this to null for unsetting the current password. Not including this property also results in unsetting of the current password. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: reset_account_password ======================================== Usage: dct-toolkit reset_account_password[-hVw] id= [-cs] [-jh] [[[new_password=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. id= Numeric ID of the Account. new_password=string New password that needs to be set for the Account. Set this to null for unsetting the current password. Not including this property also results in unsetting of the current password. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_account_tags ======================================== Usage: dct-toolkit get_account_tags[-hVw] [-cs] [-jh] id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. id= Numeric ID of the Account. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_account_tags ======================================== Usage: dct-toolkit create_account_tags[-hVw] id= [-cs] [-jh] ([tags [=array...] [tags[=array...]]...] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. id= Numeric ID of the Account. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Account. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: delete_account_tags ======================================== Usage: dct-toolkit delete_account_tags[-hVw] id= [-cs] [-jh] [[[key=string] [value=string] [tags [=array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. id= Numeric ID of the Account. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_account_ui_profiles ======================================== Usage: dct-toolkit get_account_ui_profiles[-hVw] [-cs] [-jh] id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. id= Numeric ID of the Account. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_password_policies ======================================== Usage: dct-toolkit get_password_policies[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_password_policies ======================================== Usage: dct-toolkit update_password_policies[-hVw] [-cs] [-jh] [[[--[no-] enabled] [min_length=integer] [reuse_disallow_limit=integer] [--[no-] digit] [--[no-]uppercase_letter] [--[no-]lowercase_letter] [--[no-] special_character] [--[no-]disallow_username_as_password] [maximum_password_attempts=integer]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]enabled True if password policies are enforced/enabled. min_length=integer Minimum length for password. reuse_disallow_limit=integer The password can not be the same as any of the previous n passwords. --[no-]digit Mandate at least one digit in password. --[no-]uppercase_letter Mandate at least one uppercase letter in password. --[no-]lowercase_letter Mandate at least one lower letter in password. --[no-]special_character Mandate at least one special character in password. --[no-]disallow_username_as_password Disallows password containing case-insensitive user name or reversed user name. maximum_password_attempts=integer The number of allowed attempts for incorrect password, after which the account gets locked. --body=PARAM The parameters to update the password policies. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: search_accounts ======================================== Usage: dct-toolkit search_accounts[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [first_name=string] [last_name=string] [email=string] [username=string] [last_access_time=string] [creation_time=string] [--[no-]enabled] [tags [=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id first_name=string Filter by first_name last_name=string Filter by last_name email=string Filter by email username=string Filter by username last_access_time=string Filter by last_access_time creation_time=string Filter by creation_time --[no-]enabled Filter by enabled tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ========================================