Interface en ligne de commande

Canaille dispose de plusieurs commandes pour aider les administrateurs à gérer leurs données.

Généralement, une configuration doit être chargée par Canaille. Cela peut être réalisé par une méthode de chargement de la configuration disponible, mais la plupart du temps une variable d’environnement CONFIG est utilisée. Pour des raisons de lisibilité, elle est omise dans les exemples suivants.

env CONFIG=path/to/config.toml canaille ...

canaille config

Manipule le fichier de configuration de Canaille.

canaille config [OPTIONS] COMMAND [ARGS]...

check

Test des connexions réseau définies dans le fichier de configuration.

Tentative pour accéder à la base de données et le serveur SMTP avec les identifiants fournis.

canaille config check [OPTIONS]

dump

Exporte le fichier de configuration au format TOML.

La configuration est exportée à l’endroit indiqué par le paramètre --path``s'il est renseigné, ou bien la variable d'environnement :envvar:`CONFIG`, ou à défaut un fichier ``config.toml dans le répertoire courant.

canaille config dump [OPTIONS]

Options

--path <path>

Le chemin du fichier de configuration.

canaille run

Lance un serveur de production Canaille avec Hypercorn.

Jetez un œil à la documentation d’Hypercorn pour savoir comment le configurer.

canaille run [OPTIONS]

Options

--config <config>

Un chemin vers un fichier de configuration Hypercorn au format TOML.

canaille clean

Suppression des jetons expirés et des codes d’autorisation.

canaille clean [OPTIONS]

canaille dump

Retourne tous les objets disponibles.

If no argument is passed, all model instances are dumped.

canaille dump [OPTIONS] [MODEL]...

Paramètres

MODEL

Optional argument(s)

canaille install

Installe les éléments de Canaille issus de la configuration.

Par exemple, selon la configuration, cela peut générer les clefs OIDC ou installer des schémas LDAP.

canaille install [OPTIONS]

canaille populate

Remplit la base de données avec des données générées aléatoirement.

canaille populate [OPTIONS] COMMAND [ARGS]...

Options

--nb <nb>

Nombre d’éléments à créer

groups

Remplit la base de données avec des groupes générés aléatoirement.

canaille populate groups [OPTIONS]

Options

--nb-users-max <nb_users_max>

Le nombre maximum d’utilisateurs qui seront aléatoirement affectés dans le groupe

users

Remplit la base de données avec des utilisateurs générés aléatoirement.

canaille populate users [OPTIONS]

canaille get

canaille get [OPTIONS] COMMAND [ARGS]...

authorizationcode

Recherche les codes d’autorisation et affiche les modèles correspondants en JSON.

canaille get authorizationcode [OPTIONS]

Options

--id <id>
--created <created>
--last-modified <last_modified>
--authorization-code-id <authorization_code_id>
--code <code>
--client <client>
--subject <subject>
--redirect-uri <redirect_uri>
--response-type <response_type>
--scope <scope>
--nonce <nonce>
--issue-date <issue_date>
--lifetime <lifetime>
--challenge <challenge>
--challenge-method <challenge_method>
--revokation-date <revokation_date>

client

Recherche les clients et affiche les modèles correspondants en JSON.

canaille get client [OPTIONS]

Options

--id <id>
--created <created>
--last-modified <last_modified>
--description <description>
--preconsent <preconsent>
--audience <audience>
--client-id <client_id>
--client-secret <client_secret>
--client-id-issued-at <client_id_issued_at>
--client-secret-expires-at <client_secret_expires_at>
--redirect-uris <redirect_uris>
--token-endpoint-auth-method <token_endpoint_auth_method>
--grant-types <grant_types>
--response-types <response_types>
--client-name <client_name>
--client-uri <client_uri>
--logo-uri <logo_uri>
--scope <scope>
--contacts <contacts>
--tos-uri <tos_uri>
--policy-uri <policy_uri>
--jwks-uri <jwks_uri>
--jwks <jwks>
--software-id <software_id>
--software-version <software_version>
--post-logout-redirect-uris <post_logout_redirect_uris>

group

Recherche les groupes et affiche les modèles correspondants en JSON.

canaille get group [OPTIONS]

Options

--id <id>
--created <created>
--last-modified <last_modified>
--display-name <display_name>
--members <members>
--description <description>

token

Recherche les jetons et affiche les modèles correspondants en JSON.

canaille get token [OPTIONS]

Options

--id <id>
--created <created>
--last-modified <last_modified>
--token-id <token_id>
--access-token <access_token>
--client <client>
--subject <subject>
--type <type>
--refresh-token <refresh_token>
--scope <scope>
--issue-date <issue_date>
--lifetime <lifetime>
--revokation-date <revokation_date>
--audience <audience>

user

Recherche les utilisateurs et affiche les modèles correspondants en JSON.

canaille get user [OPTIONS]

Options

--id <id>
--created <created>
--last-modified <last_modified>
--user-name <user_name>
--password-failure-timestamps <password_failure_timestamps>
--password <password>
--password-last-update <password_last_update>
--preferred-language <preferred_language>
--family-name <family_name>
--given-name <given_name>
--formatted-name <formatted_name>
--display-name <display_name>
--emails <emails>
--phone-numbers <phone_numbers>
--formatted-address <formatted_address>
--street <street>
--postal-code <postal_code>
--locality <locality>
--region <region>
--photo <photo>
--profile-url <profile_url>
--title <title>
--organization <organization>
--employee-number <employee_number>
--department <department>
--groups <groups>
--lock-date <lock_date>
--last-otp-login <last_otp_login>
--secret-token <secret_token>
--hotp-counter <hotp_counter>
--one-time-password <one_time_password>
--one-time-password-emission-date <one_time_password_emission_date>

canaille set

canaille set [OPTIONS] COMMAND [ARGS]...

authorizationcode

Met à jour un code d’autorisation et affiche le modèle modifié au format JSON sur la sortie standard.

IDENTIFIER devrait être un code d’autorisation ou authorization_code_id

canaille set authorizationcode [OPTIONS] IDENTIFIER

Options

--created <created>
--last-modified <last_modified>
--authorization-code-id <authorization_code_id>
--code <code>
--client <client>
--subject <subject>
--redirect-uri <redirect_uri>
--response-type <response_type>
--scope <scope>
--nonce <nonce>
--issue-date <issue_date>
--lifetime <lifetime>
--challenge <challenge>
--challenge-method <challenge_method>
--revokation-date <revokation_date>

Paramètres

IDENTIFIER

Paramètre obligatoire

client

Mise-à-jour du client et affiche le modèle modifié au format JSON sur la sortie standard.

IDENTIFIER devrait être un identifiant client ou client_id

canaille set client [OPTIONS] IDENTIFIER

Options

--created <created>
--last-modified <last_modified>
--description <description>
--preconsent <preconsent>
--audience <audience>
--client-id <client_id>
--client-secret <client_secret>
--client-id-issued-at <client_id_issued_at>
--client-secret-expires-at <client_secret_expires_at>
--redirect-uris <redirect_uris>
--token-endpoint-auth-method <token_endpoint_auth_method>
--grant-types <grant_types>
--response-types <response_types>
--client-name <client_name>
--client-uri <client_uri>
--logo-uri <logo_uri>
--scope <scope>
--contacts <contacts>
--tos-uri <tos_uri>
--policy-uri <policy_uri>
--jwks-uri <jwks_uri>
--jwks <jwks>
--software-id <software_id>
--software-version <software_version>
--post-logout-redirect-uris <post_logout_redirect_uris>

Paramètres

IDENTIFIER

Paramètre obligatoire

group

Met à jour un groupe et affiche le modèle modifié au format JSON sur la sortie standard.

IDENTIFIER devrait être un identifiant de groupe ou display_name

canaille set group [OPTIONS] IDENTIFIER

Options

--created <created>
--last-modified <last_modified>
--display-name <display_name>
--members <members>
--description <description>

Paramètres

IDENTIFIER

Paramètre obligatoire

token

Met à jour un jeton et affiche un modèle modifié au format JSON sur la sortie standard.

IDENTIFIER devrait être un identifiant de token ou token_id

canaille set token [OPTIONS] IDENTIFIER

Options

--created <created>
--last-modified <last_modified>
--token-id <token_id>
--access-token <access_token>
--client <client>
--subject <subject>
--type <type>
--refresh-token <refresh_token>
--scope <scope>
--issue-date <issue_date>
--lifetime <lifetime>
--revokation-date <revokation_date>
--audience <audience>

Paramètres

IDENTIFIER

Paramètre obligatoire

user

Met à jour un utilisateur et affiche un modèle modifié au format JSON sur la sortie standard.

IDENTIFIER devrait être un identifiant utilisateur ou user_name

canaille set user [OPTIONS] IDENTIFIER

Options

--created <created>
--last-modified <last_modified>
--user-name <user_name>
--password-failure-timestamps <password_failure_timestamps>
--password <password>
--password-last-update <password_last_update>
--preferred-language <preferred_language>
--family-name <family_name>
--given-name <given_name>
--formatted-name <formatted_name>
--display-name <display_name>
--emails <emails>
--phone-numbers <phone_numbers>
--formatted-address <formatted_address>
--street <street>
--postal-code <postal_code>
--locality <locality>
--region <region>
--photo <photo>
--profile-url <profile_url>
--title <title>
--organization <organization>
--employee-number <employee_number>
--department <department>
--groups <groups>
--lock-date <lock_date>
--last-otp-login <last_otp_login>
--secret-token <secret_token>
--hotp-counter <hotp_counter>
--one-time-password <one_time_password>
--one-time-password-emission-date <one_time_password_emission_date>

Paramètres

IDENTIFIER

Paramètre obligatoire

canaille create

canaille create [OPTIONS] COMMAND [ARGS]...

authorizationcode

Crée un nouveau code d’autorisation et affiche le modèle créé au format JSON sur la sortie standard.

canaille create authorizationcode [OPTIONS]

Options

--created <created>
--last-modified <last_modified>

client

Crée un nouveau client et affiche le modèle créé au format JSON sur la sortie standard.

canaille create client [OPTIONS]

Options

--created <created>
--last-modified <last_modified>

group

Crée un nouveau groupe et affiche le modèle créé au format JSON sur la sortie standard.

canaille create group [OPTIONS]

Options

--created <created>
--last-modified <last_modified>

token

Crée un nouveau jeton et affiche le modèle créé au format JSON sur la sortie standard.

canaille create token [OPTIONS]

Options

--created <created>
--last-modified <last_modified>

user

Crée un nouvel utilisateur et affiche le modèle créé au format JSON sur la sortie standard.

canaille create user [OPTIONS]

Options

--created <created>
--last-modified <last_modified>

canaille delete

canaille delete [OPTIONS] COMMAND [ARGS]...

authorizationcode

Supprime un code d’autorisation.

IDENTIFIER devrait être un code d’autorisation ou authorization_code_id

canaille delete authorizationcode [OPTIONS] IDENTIFIER

Paramètres

IDENTIFIER

Paramètre obligatoire

client

Supprime un client.

IDENTIFIER devrait être un identifiant client ou client_id

canaille delete client [OPTIONS] IDENTIFIER

Paramètres

IDENTIFIER

Paramètre obligatoire

group

Supprime un groupe.

IDENTIFIER devrait être un identifiant de groupe ou display_name

canaille delete group [OPTIONS] IDENTIFIER

Paramètres

IDENTIFIER

Paramètre obligatoire

token

Supprime un jeton.

IDENTIFIER devrait être un identifiant de token ou token_id

canaille delete token [OPTIONS] IDENTIFIER

Paramètres

IDENTIFIER

Paramètre obligatoire

user

Supprime un utilisateur.

IDENTIFIER devrait être un identifiant utilisateur ou user_name

canaille delete user [OPTIONS] IDENTIFIER

Paramètres

IDENTIFIER

Paramètre obligatoire

canaille reset-otp

Réinitialise le jeton des mots de passes à usage unique pour un utilisateur, et affiche l’utilisateur édité au format JSON dans la sortie standard.

IDENTIFIER devrait être un identifiant utilisateur ou user_name

canaille reset-otp [OPTIONS] IDENTIFIER

Paramètres

IDENTIFIER

Paramètre obligatoire