ggshield auth login

Description

Authentifier auprès d'une instance GitGuardian.

ggshield auth login [OPTIONS]

Une authentification réussie produit un personal access token. Ce token est stocké dans votre configuration et utilisé pour authentifier vos futures requêtes.

La méthode d'authentification par défaut est web. ggshield lance un navigateur web pour vous authentifier auprès de votre instance GitGuardian, puis génère automatiquement un token en votre nom.

Alternativement, vous pouvez utiliser --method token pour vous authentifier avec un token déjà existant. Le scope minimum requis pour le token est scan.

Par défaut, le token créé aura le scope scan. Utilisez l'option --scopes pour accorder au token des scopes supplémentaires. Vous pouvez trouver la liste des scopes disponibles dans la documentation de l'API GitGuardian.

Si un personal access token valide est déjà configuré, cette commande affiche simplement un message de succès indiquant que ggshield est déjà prêt à être utilisé.

Options

• --method [token|web] : méthode d'authentification.

  Par défaut : web.

• --instance URL : URL de l'instance auprès de laquelle s'authentifier.

• --scopes SCOPES : liste séparée par des espaces de scopes supplémentaires à demander en plus du scope scan par défaut.

• --sso-url URL : URL de votre page de connexion SSO pour forcer le flux d'authentification via le SSO de votre workspace.

• --token-name TEXT : nom du nouveau token.

• --lifetime DAYS : nombre de jours avant l'expiration du token. 0 signifie que le token n'expire jamais. [x>=0]

Cette commande prend en charge toutes les options globales ggshield.

Exemples

# start interactive web-based flow
$ ggshield auth login

# force the authentication flow through a SSO
$ ggshield auth login --sso-url https://dashboard.gitguardian.com/auth/sso/d0c192e4-0bbe-4250-ae4d-30XXXXXXXXXX

# specify the name of the personal access token about to be provisioned
$ ggshield auth login --token-name mytoken

# authenticate with an already existing token, ggshield will prompt you to enter the token
$ ggshield auth login --method=token
Enter your GitGuardian API token: <type your token and press enter>

# authenticate against a self-hosted GitGuardian instance
$ ggshield auth login --instance https://dashboard.gitguardian.mycorp.local