CLI

The command line interface (CLI) is an alternative way to use most of the functionality that kadi-apy provides. It is especially useful for scripting and the integration with programming languages other than Python. However, due to the nature of CLI tools, it is less flexible in comparison with the Python library.

The central entry point to the CLI is provided by the main kadi-apy command:

kadi-apy --help

kadi-apy

The kadi-apy command line interface.

kadi-apy [OPTIONS] COMMAND [ARGS]...

Options

--version

Print the version of this group and exit.

--commands

Print a list of all commands this group contains and exit.

collections

Commands to manage collections.

kadi-apy collections [OPTIONS] COMMAND [ARGS]...

Options

--version

Print the version of this group and exit.

--commands

Print a list of all commands this group contains and exit.

add-group-role

Add a group role to a collection.

kadi-apy collections add-group-role [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-C, --collection-identifier <collection_identifier>

Identifier of the collection to add the group with role permissions.

-c, --collection-id <collection_id>

ID of the collection to add the group with role permissions.

-G, --group-identifier <group_identifier>

Identifier of the group.

-g, --group-id <group_id>

ID of the group.

-p, --permission-new <permission_new>

Permission of the group.

Default:

member

Options:

member | collaborator | editor | admin

add-tag

Add a tag or several tags to a collection.

kadi-apy collections add-tag [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-C, --collection-identifier <collection_identifier>

Identifier of the collection to add a tag.

-c, --collection-id <collection_id>

ID of the collection to add a tag.

-t, --tag <tag>

Required Tag to add.

add-user

Add a user to a collection.

kadi-apy collections add-user [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-C, --collection-identifier <collection_identifier>

Identifier of the collection to add the user.

-c, --collection-id <collection_id>

ID of the collection to add the user.

-D, --identity-type <identity_type>

Identity type of the user

Options:

ldap | local | shib

-U, --username <username>

Username of the user.

-u, --user <user>

ID of the user.

-p, --permission-new <permission_new>

Permission of new user.

Default:

member

Options:

member | collaborator | editor | admin

create

Create a collection.

kadi-apy collections create [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-t, --title <title>

Title of the collection.

-i, --identifier <identifier>

Required Identifier of the collection.

-v, --visibility <visibility>

Visibility of the collection.

Default:

private

Options:

private | public

-p, --pipe

Use this flag if you want to pipe the returned collection id.

Default:

False

-e, --exit-not-created

Exit with error if the collection was not newly created.

Default:

False

delete

Delete a collection.

kadi-apy collections delete [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-C, --collection-identifier <collection_identifier>

Identifier of the collection to delete.

-c, --collection-id <collection_id>

ID of the collection to delete.

--i-am-sure

Enable this option to delete the collection.

Default:

False

edit

Edit the metadata of a collection.

kadi-apy collections edit [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-C, --collection-identifier <collection_identifier>

Identifier of the collection to edit.

-c, --collection-id <collection_id>

ID of the collection to edit.

-v, --visibility <visibility>

Visibility of the collection to set.

Options:

private | public

-t, --title <title>

Title of the collection to set.

-d, --description <description>

Description of the collection to set.

export

Export the collection using a specific export type.

kadi-apy collections export [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-C, --collection-identifier <collection_identifier>

Identifier of the collection to export.

-c, --collection-id <collection_id>

ID of the collection to export.

-e, --export-type <export_type>

Export type.

Default:

json

Options:

json | qr | rdf | ro-crate

-p, --path <path>

Path (folder) to store the file.

Default:

.

-n, --name <name>

Name of the file to store. The identifier is used as default.

-f, --force

Enable if existing file with identical name should be replaced.

Default:

False

-P, --pipe

Use this flag if you want to pipe the returned json.

Default:

False

-u, --use-folder

Create, if not already existing, a folder in the specified file path with the collection’s identifier as name and save the exported file in this folder.

Default:

False

get-collection-ids

Search for collections. The ids of all found results are displayed.

kadi-apy collections get-collection-ids [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-t, --tag <tag>

Tag(s) for search.

-T, --tag-operator <tag_operator>

The operator to filter the tags with.

Default:

or

Options:

or | and

-v, --visibility <visibility>

Show results based on visibility parameter.

Default:

all

Options:

private | public | all

-p, --pipe

Use this flag if you want to pipe the returned. collection ids as tokenlist.

Default:

False

--i-am-sure

Enable this option in case more than 1000 results are found.

Default:

False

get-collections

Search for collections.

kadi-apy collections get-collections [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-t, --tag <tag>

Tag(s) for search.

-T, --tag-operator <tag_operator>

The operator to filter the tags with. Defaults to ‘or’.

Options:

or | and

-n, --per-page <per_page>

Number of results per page.

Default:

10

-p, --page <page>

Page for search results.

Default:

1

-D, --identity-type <identity_type>

Identity type of the user to show the user’s created collections.

Options:

ldap | local | shib

-U, --username <username>

Username of the user to show the user’s created collections.

-u, --user <user>

ID of the user to show the user’s created collections.

-i, --use-my-user-id

Show only own created collections.

Default:

False

-v, --visibility <visibility>

Show results based on visibility parameter.

Options:

private | public | all

-q, --query <query>

The search query.

remove-group-role

Remove a group role from a collection.

kadi-apy collections remove-group-role [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-C, --collection-identifier <collection_identifier>

Identifier of the collection to remove the group.

-c, --collection-id <collection_id>

ID of the collection to remove the group.

-G, --group-identifier <group_identifier>

Identifier of the group.

-g, --group-id <group_id>

ID of the group.

remove-tag

Remove a tag from a collection.

kadi-apy collections remove-tag [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-C, --collection-identifier <collection_identifier>

Identifier of the collection to remove a tag.

-c, --collection-id <collection_id>

ID of the collection to remove a tag.

-t, --tag <tag>

Required Tag to remove.

remove-user

Remove a user from a collection.

kadi-apy collections remove-user [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-C, --collection-identifier <collection_identifier>

Identifier of the collection to remove the user.

-c, --collection-id <collection_id>

ID of the collection to remove the user.

-D, --identity-type <identity_type>

Identity type of the user

Options:

ldap | local | shib

-U, --username <username>

Username of the user.

-u, --user <user>

ID of the user.

show-info

Show info of a collection.

kadi-apy collections show-info [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-C, --collection-identifier <collection_identifier>

Identifier of the collection.

-c, --collection-id <collection_id>

ID of the collection.

-d, --description

Show the description of the collection.

Default:

False

-v, --visibility

Show the visibility of the collection.

Default:

False

-r, --records

Show linked records of the collection.

Default:

False

-s, --subcollections

Show linked child-collections of the collection.

Default:

False

-n, --per-page <per_page>

Number of results per page.

Default:

10

-p, --page <page>

Page for search results.

Default:

1

config

Commands to manage configurations.

kadi-apy config [OPTIONS] COMMAND [ARGS]...

Options

--version

Print the version of this group and exit.

--commands

Print a list of all commands this group contains and exit.

activate-autocompletion

Activate the autocompletion for bash, zsh or fish.

kadi-apy config activate-autocompletion [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-s, --shell <shell>

Required Your shell type.

Options:

bash | zsh | fish

add-instance

Add a new instance to the config file.

kadi-apy config add-instance [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-I, --instance <instance>

Required Name of the new instance.

change-default-instance

Change the default instance.

kadi-apy config change-default-instance [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-I, --instance <instance>

Required Name of the new default instance.

create

Create the config file to store the information to connect to a Kadi instance.

kadi-apy config create [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

get-kadi-info

Get information about the Kadi instance.

kadi-apy config get-kadi-info [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

rename-instance

Rename an instance.

kadi-apy config rename-instance [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-I, --instance <instance>

Required Name of the instance to change.

-N, --instance-new <instance_new>

Required New name of the instance.

set-host

Set a host in the config file.

kadi-apy config set-host [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-I, --instance <instance>

Name of the instance defined in the config. If empty, the default instance defined in the config file is used.

set-pat

Set a personal access token (pat) in the config file.

kadi-apy config set-pat [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-I, --instance <instance>

Name of the instance defined in the config. If empty, the default instance defined in the config file is used.

show-instances

Show a list of all instances defined in the config.

kadi-apy config show-instances [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

groups

Commands to manage groups.

kadi-apy groups [OPTIONS] COMMAND [ARGS]...

Options

--version

Print the version of this group and exit.

--commands

Print a list of all commands this group contains and exit.

add-user

Add a user to a group.

kadi-apy groups add-user [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-G, --group-identifier <group_identifier>

Identifier of the group to add the user.

-g, --group-id <group_id>

ID of the group to add the user.

-D, --identity-type <identity_type>

Identity type of the user to add to the group.

Options:

ldap | local | shib

-U, --username <username>

Username of the user to add to the group.

-u, --user <user>

ID of the user to add to the group.

-p, --permission-new <permission_new>

Permission of new user.

Default:

member

Options:

member | editor | admin

create

Create a group.

kadi-apy groups create [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-t, --title <title>

Title of the group.

-i, --identifier <identifier>

Required Identifier of the group.

-v, --visibility <visibility>

Visibility of the group.

Default:

private

Options:

private | public

-p, --pipe

Use this flag if you want to pipe the returned group id.

Default:

False

-e, --exit-not-created

Exit with error if the group was not newly created.

Default:

False

delete

Delete a group.

kadi-apy groups delete [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-G, --group-identifier <group_identifier>

Identifier of the group to delete.

-g, --group-id <group_id>

ID of the group to delete.

--i-am-sure

Enable this option to delete the group.

Default:

False

edit

Edit the metadata of a group.

kadi-apy groups edit [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-G, --group-identifier <group_identifier>

Identifier of the group to edit.

-g, --group-id <group_id>

ID of the group to edit.

-v, --visibility <visibility>

Visibility of the group to set.

Options:

private | public

-t, --title <title>

Title of the group to set.

-d, --description <description>

Description of the group to set.

get-groups

Search for groups.

kadi-apy groups get-groups [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-n, --per-page <per_page>

Number of results per page.

Default:

10

-p, --page <page>

Page for search results.

Default:

1

-D, --identity-type <identity_type>

Identity type of the user to show the user’s created groups.

Options:

ldap | local | shib

-U, --username <username>

Username of the user to show the user’s created groups.

-u, --user <user>

ID of the user to show the user’s created groups.

-i, --my_user_id

Show only own created groups.

Default:

False

-v, --visibility <visibility>

Show results based on visibility parameter.

Default:

all

Options:

private | public | all

remove-user

Remove a user from a group.

kadi-apy groups remove-user [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-G, --group-identifier <group_identifier>

Identifier of the group to remove the user.

-g, --group-id <group_id>

ID of the group to remove the user.

-D, --identity-type <identity_type>

Identity type of the user to remove from the group.

Options:

ldap | local | shib

-U, --username <username>

Username of the user to remove from the group.

-u, --user <user>

ID of the user to remove from the group.

show-info

Show info of a group.

kadi-apy groups show-info [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-G, --group-identifier <group_identifier>

Identifier of the group.

-g, --group-id <group_id>

ID of the group.

-d, --description

Show the description of the group.

Default:

False

-v, --visibility

Show the visibility of the group.

Default:

False

misc

Commands for miscellaneous functionality.

kadi-apy misc [OPTIONS] COMMAND [ARGS]...

Options

--version

Print the version of this group and exit.

--commands

Print a list of all commands this group contains and exit.

get-deleted-resources

Show a list of deleted resources in the trash.

kadi-apy misc get-deleted-resources [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-n, --per-page <per_page>

Number of results per page.

Default:

10

-p, --page <page>

Page for search results.

Default:

1

-f, --filter <filter>

Filter by title or identifier.

Default:

""

get-licenses

Show a list available licenses.

kadi-apy misc get-licenses [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-n, --per-page <per_page>

Number of results per page.

Default:

10

-p, --page <page>

Page for search results.

Default:

1

-f, --filter <filter>

Filter.

Default:

""

get-roles

Show a list of roles and corresponding permissions of all resources.

kadi-apy misc get-roles [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-t, --item-type <item_type>

Show only roles of this resource.

Options:

record | collection | template | group

get-tags

Show a list available tags.

kadi-apy misc get-tags [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-n, --per-page <per_page>

Number of results per page.

Default:

10

-p, --page <page>

Page for search results.

Default:

1

-f, --filter <filter>

Filter.

Default:

""

-t, --type <type>

A resource type to limit the tags to.

Options:

record | collection

import-eln

Import an RO-Crate file following the “ELN” file specification.

kadi-apy misc import-eln [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-p, --path <path>

Required Path of the ELN file to import.

import-json-schema

Import JSON Schema file and create a template.

kadi-apy misc import-json-schema [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-p, --path <path>

Required Path of the JSON Schema file to import.

-y, --type <template_type>

Type of the template to create from JSON Schema.

Default:

extras

Options:

extras | record

import-shacl

Import SHACL file and create a template.

kadi-apy misc import-shacl [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-p, --path <path>

Required Path of the SHACl file to import.

-y, --type <template_type>

Type of the template to create from SHACL shapes.

Default:

extras

Options:

extras | record

purge-resource

Purge a resource from the trash.

kadi-apy misc purge-resource [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-t, --item-type <item_type>

Required Type of the resource to purge.

Options:

record | collection | group | template

-i, --item-id <item_id>

Required ID of the resource to purge.

restore-resource

Restore a resource from the trash.

kadi-apy misc restore-resource [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-t, --item-type <item_type>

Required Type of the resource to restore.

Options:

record | collection | group | template

-i, --item-id <item_id>

Required ID of the resource to restore.

records

Commands to manage records.

kadi-apy records [OPTIONS] COMMAND [ARGS]...

Options

--version

Print the version of this group and exit.

--commands

Print a list of all commands this group contains and exit.

add-files

Add a file or a folder content to a record.

kadi-apy records add-files [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-n, --file-name <file_name>

Required Name of the file or folder

-d, --file-description <file_description>

The description of a single file

-p, --pattern <pattern>

Pattern for selecting certain files when using a folder as input. By default, all files are taken into account. To set a pattern, Unix shell-style wildcards can be used (see Python package fnmatch).

-e, --exclude_pattern <exclude_pattern>

Pattern for excluding certain files when using a folder as input. To set a pattern, Unix shell-style wildcards can be used (see Python package fnmatch).

-f, --force

Enable if existing file(s) with identical name(s) should be replaced.

Default:

False

add-group-role

Add a group role to a record.

kadi-apy records add-group-role [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record to add the group with role permissions.

-r, --record-id <record_id>

ID of the record to add the group with role permissions.

-G, --group-identifier <group_identifier>

Identifier of the group.

-g, --group-id <group_id>

ID of the group.

-p, --permission-new <permission_new>

Permission of the group

Default:

member

Options:

member | collaborator | editor | admin

add-metadata

Add metadata with dict or a list of dicts as input.

kadi-apy records add-metadata [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record to add metadata as dictionary or as a list of dictionaries.

-r, --record-id <record_id>

ID of the record to add metadata as dictionary or as a list of dictionaries.

-m, --metadata <metadata>

Metadata string input

-p, --file <file>

Path to file containing metadata

-f, --force

Force deleting and overwriting existing metadata.

Default:

False

add-metadatum

Add a metadatum to a record.

kadi-apy records add-metadatum [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record to add a metadatum.

-r, --record-id <record_id>

ID of the record to add a metadatum.

-m, --metadatum <metadatum>

Required Name of metadatum to add

-v, --value <value>

Required Value of metadatum to add

-t, --type <type>

Type of metadatum to add

Default:

string

Options:

string | integer | float | boolean

-u, --unit <unit>

Unit of metadatum to add

-f, --force

Force overwriting existing metadatum with identical name

Default:

False

add-string-as-file

Add a string as a file to a record.

kadi-apy records add-string-as-file [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-s, --string <string>

Required String to be added as file to the record.

-n, --file-name <file_name>

Required Name of the file to store the sting.

-f, --force

Enable if existing file with identical name should be replaced.

Default:

False

add-tag

Add a tag or several tags to a record.

kadi-apy records add-tag [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-t, --tag <tag>

Required Tag to add.

add-user

Add a user to a record.

kadi-apy records add-user [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-D, --identity-type <identity_type>

Identity type of the user to add.

Options:

ldap | local | shib

-U, --username <username>

Username of the user to add.

-u, --user <user>

ID of the user to add.

-p, --permission-new <permission_new>

Permission of new user.

Default:

member

Options:

member | collaborator | editor | admin

create

Create a record.

kadi-apy records create [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-i, --identifier <identifier>

Required Identifier of the record

-t, --title <title>

Title of the record

-v, --visibility <visibility>

Visibility of the record

Default:

private

Options:

private | public

-p, --pipe

Use this flag if you want to pipe the returned record id.

Default:

False

-e, --exit-not-created

Exit with error if the record was not newly created.

Default:

False

delete

Delete a record.

kadi-apy records delete [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record to delete.

-r, --record-id <record_id>

ID of the record to delete.

--i-am-sure

Enable this option to delete the record

Default:

False

delete-all-metadata

Delete all metadatum of a record.

kadi-apy records delete-all-metadata [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record to delete all metadata.

-r, --record-id <record_id>

ID of the record to delete all metadata.

--i-am-sure

Enable this option to delete all metadata of the record.

Default:

False

delete-file

Delete a file of a record.

kadi-apy records delete-file [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-i, --file-id <file_id>

ID of the file.

-n, --file-name <file_name>

Name of the file.

delete-files

Delete all files of a record.

kadi-apy records delete-files [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

--i-am-sure

Enable this option to delete all files of the record.

Default:

False

delete-metadatum

Delete a metadatum of a record.

kadi-apy records delete-metadatum [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record to delete a metadatum.

-r, --record-id <record_id>

ID of the record to delete a metadatum.

-m, --metadatum <metadatum>

Required Name of metadatum to remove.

edit

Edit the basic metadata of a record.

kadi-apy records edit [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record to edit.

-r, --record-id <record_id>

ID of the record to edit.

-v, --visibility <visibility>

Visibility of the record

Options:

private | public

-t, --title <title>

Title of the record

-d, --description <description>

Description of the record

-y, --type <type>

Type of the record

-l, --license <license>

License of the record

edit-file

Edit the metadata of a file of a record.

kadi-apy records edit-file [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-i, --file-id <file_id>

ID of the file.

-n, --file-name <file_name>

Name of the file.

-a, --name <name>

The new name of the file.

-m, --mimetype <mimetype>

The new MIME type of the file.

export

Export the record using a specific export type.

kadi-apy records export [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record to export.

-T, --record-ids <record_ids>

Tokenlist of record IDs to export.

-r, --record-id <record_id>

ID of the record to export.

-e, --export-type <export_type>

Export type.

Default:

json

Options:

json | pdf | qr | rdf | ro-crate

-p, --path <path>

Path (folder) to store the file.

Default:

.

-n, --name <name>

Name of the file to store. The identifier is used as default.

-f, --force

Enable if existing file with identical name should be replaced.

Default:

False

-P, --pipe

Use this flag if you want to pipe the returned json.

Default:

False

-u, --use-folder

Create, if not already existing, a folder in the specified file path with the record’s identifier as name and save the exported file in this folder.

Default:

False

get-file

Download one file, all files or files with pattern from a record.

kadi-apy records get-file [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record to download files from.

-T, --record-ids <record_ids>

Tokenlist of record IDs to download files from.

-r, --record-id <record_id>

ID of the record to download files from.

-i, --file-id <file_id>

ID of the file to download.

-n, --file-name <file_name>

Name of the file to download.

-p, --filepath <filepath>

Path (folder) to store the file.

Default:

.

-P, --pattern <pattern>

Pattern for selecting certain files. To set a pattern, Unix shell-style wildcards can be used (see Python package fnmatch).

-e, --exclude_pattern <exclude_pattern>

Pattern for excluding certain files. To set a pattern, Unix shell-style wildcards can be used (see Python package fnmatch).

-f, --force

Force overwriting file in the given folder.

Default:

False

-u, --use-folder

Create, if not already existing, a folder in the specified file path with the record’s identifier as name and saves all files in this folder.

Default:

False

-E, --pipe

Use this flag if you want to pipe the returned tokenlist of downloaded files.

Default:

False

get-metadatum

Print information of a specific metadatum.

kadi-apy records get-metadatum [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-n, --name <name>

Required Name of the metadatum. Nested values can be separated via ‘.’.

-i, --information <information>

Specify the information to print.

Default:

value

Options:

value | unit | type

-p, --pipe

Use this flag if you want to pipe the returned information.

Default:

False

get-record-ids

Search for records. The ids of all found results are displayed.

kadi-apy records get-record-ids [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-t, --tag <tag>

Tag(s) for search.

-T, --tag-operator <tag_operator>

The operator to filter the tags with.

Default:

or

Options:

or | and

-m, --mimetype <mimetype>

MIME type(s) for search.

-c, --collection <collection>

Collection ID(s) to search in.

-C, --child_collections

Include child collections in the search.

Default:

False

-v, --visibility <visibility>

Show results based on visibility parameter.

Default:

all

Options:

private | public | all

-p, --pipe

Use this flag if you want to pipe the returned record ids as tokenlist.

Default:

False

--i-am-sure

Enable this option in case more than 1000 results are found.

Default:

False

get-records

Search for records.

kadi-apy records get-records [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-t, --tag <tag>

Tag(s) for search.

-T, --tag-operator <tag_operator>

The operator to filter the tags with. Defaults to ‘or’.

Options:

or | and

-m, --mimetype <mimetype>

MIME type(s) for search.

-c, --collection <collection>

Collection ID(s) to search in.

-C, --child_collections

Include child collections in the search.

Default:

False

-n, --per-page <per_page>

Number of results per page.

Default:

10

-p, --page <page>

Page for search results.

Default:

1

-D, --identity-type <identity_type>

Identity type of the user to show the user’s created records.

Options:

ldap | local | shib

-U, --username <username>

Username of the user to show the user’s created records.

-u, --user <user>

ID of the user to show the user’s created records.

-i, --use-my-user-id

Show only own created records.

Default:

False

-v, --visibility <visibility>

Show results based on visibility parameter.

Options:

private | public | all

-q, --query <query>

The search query.

remove-group-role

Remove a group role from a record.

kadi-apy records remove-group-role [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-G, --group-identifier <group_identifier>

Identifier of the group.

-g, --group-id <group_id>

ID of the group.

remove-tag

Remove a tag from a record.

kadi-apy records remove-tag [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-t, --tag <tag>

Required Tag to remove.

remove-user

Remove a user from a record.

kadi-apy records remove-user [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-D, --identity-type <identity_type>

Identity type of the user to remove.

Options:

ldap | local | shib

-U, --username <username>

Username of the user to remove.

-u, --user <user>

ID of the user to remove.

show-info

Prints information of a record.

kadi-apy records show-info [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-R, --record-identifier <record_identifier>

Identifier of the record.

-r, --record-id <record_id>

ID of the record.

-d, --description

Show the description of the record

Default:

False

-l, --filelist

Show the filelist of the record

Default:

False

-n, --per-page <per_page>

Number of results per page.

Default:

10

-p, --page <page>

Page for filelist.

Default:

1

-m, --metadata

Show the metadata of the record.

Default:

False

-v, --visibility

Show the visibility of the record.

Default:

False

-i, --pipe

Use for piping. Do not show basic info.

Default:

False

templates

Commands to manage templates.

kadi-apy templates [OPTIONS] COMMAND [ARGS]...

Options

--version

Print the version of this group and exit.

--commands

Print a list of all commands this group contains and exit.

add-group-role

Add a group role to a template.

kadi-apy templates add-group-role [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-T, --template-identifier <template_identifier>

Identifier of the template to add the group with role permissions.

-t, --template-id <template_id>

ID of the template to add the group with role permissions.

-G, --group-identifier <group_identifier>

Identifier of the group.

-g, --group-id <group_id>

ID of the group.

-p, --permission-new <permission_new>

Permission of the group

Default:

member

Options:

member | editor | admin

add-user

Add a user to a template.

kadi-apy templates add-user [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-T, --template-identifier <template_identifier>

Identifier of the template.

-t, --template-id <template_id>

ID of the template.

-D, --identity-type <identity_type>

Identity type of the user to add.

Options:

ldap | local | shib

-U, --username <username>

Username of the user to add.

-u, --user <user>

ID of the user to add.

-p, --permission-new <permission_new>

Permission of new user.

Default:

member

Options:

member | editor | admin

create

Create a template.

kadi-apy templates create [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-i, --identifier <identifier>

Required Identifier of the template.

-t, --title <title>

Title of the template.

-y, --type <template_type>

Type of the template.

Default:

record

Options:

extras | record

-p, --pipe

Use this flag if you want to pipe the returned template id.

Default:

False

-d, --data <data>

Data for the template.

-e, --exit-not-created

Exit with error if the template was not newly created.

Default:

False

delete

Delete a template.

kadi-apy templates delete [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-T, --template-identifier <template_identifier>

Identifier of the template to delete.

-t, --template-id <template_id>

ID of the template to delete.

--i-am-sure

Enable this option to delete the template.

Default:

False

edit

Edit the metadata of a template.

kadi-apy templates edit [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-T, --template-identifier <template_identifier>

Identifier of the template to edit.

-t, --template-id <template_id>

ID of the template to edit.

-v, --visibility <visibility>

Visibility of the template to set.

Options:

private | public

-i, --title <title>

Title of the template to set.

-d, --description <description>

Description of the template to set.

export

Export the template using a specific export type.

kadi-apy templates export [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-T, --template-identifier <template_identifier>

Identifier of the template to export.

-t, --template-id <template_id>

ID of the template to export.

-e, --export_type <export_type>

Export type.

Default:

json

Options:

json | json-schema

-p, --path <path>

Path (folder) to store the file.

Default:

.

-n, --name <name>

Name of the file to store. The identifier is used as default.

-f, --force

Enable if existing file with identical name should be replaced.

Default:

False

-P, --pipe

Use this flag if you want to pipe the returned json.

Default:

False

-u, --use-folder

Create, if not already existing, a folder in the specified file path with the template’s identifier as name and save the exported file in this folder.

Default:

False

get-templates

Search for templates.

kadi-apy templates get-templates [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-n, --per-page <per_page>

Number of results per page.

Default:

10

-p, --page <page>

Page for search results.

Default:

1

remove-group-role

Remove a group role from a template.

kadi-apy templates remove-group-role [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-T, --template-identifier <template_identifier>

Identifier of the template.

-t, --template-id <template_id>

ID of the template.

-G, --group-identifier <group_identifier>

Identifier of the group.

-g, --group-id <group_id>

ID of the group.

remove-user

Remove a user from a template.

kadi-apy templates remove-user [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-T, --template-identifier <template_identifier>

Identifier of the template.

-t, --template-id <template_id>

ID of the template.

-D, --identity-type <identity_type>

Identity type of the user to remove.

Options:

ldap | local | shib

-U, --username <username>

Username of the user to remove.

-u, --user <user>

ID of the user to remove.

users

Commands to manage users.

kadi-apy users [OPTIONS] COMMAND [ARGS]...

Options

--version

Print the version of this group and exit.

--commands

Print a list of all commands this group contains and exit.

get-users

Search for users.

kadi-apy users get-users [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-n, --per-page <per_page>

Number of results per page.

Default:

10

-p, --page <page>

Page for search results.

Default:

1

-f, --filter <filter>

To filter the users by their display name or username.

show-info

Show info of a user.

kadi-apy users show-info [OPTIONS]

Options

--version

Print the version of this command and exit.

--xmlhelp

Print the xmlhelp of this command and exit.

-V, --verbose <verbose>

Verbose level to define the amount of print output.

Default:

info

Options:

error | warning | info | debug

-I, --instance <instance>

Name of a Kadi instance defined in the config file.

-D, --identity-type <identity_type>

Identity type of the user

Options:

ldap | local | shib

-U, --username <username>

Username of the user.

-u, --user <user>

ID of the user.