ALTER USER … ROTATE PROGRAMMATIC ACCESS TOKEN (PAT)¶

Fait pivoter le jeton d’accès programmatique, générant un nouveau secret de jeton avec un délai d’expiration prolongé et faisant expirer le secret de jeton existant. Le nouveau secret est généré à l’aide de la même propriété DAYS_TO_EXPIRY que celle qui a été définie lors de la création du jeton.

Voir aussi :: ALTER USER … ADD PROGRAMMATIC ACCESS TOKEN (PAT), ALTER USER … MODIFY PROGRAMMATIC ACCESS TOKEN (PAT), ALTER USER … REMOVE PROGRAMMATIC ACCESS TOKEN (PAT) , SHOW USER PROGRAMMATIC ACCESS TOKENS

Syntaxe¶

ALTER USER [ IF EXISTS ] [ <username> ] ROTATE { PROGRAMMATIC ACCESS TOKEN | PAT } <token_name>
  [ EXPIRE_ROTATED_TOKEN_AFTER_HOURS = <integer> ]

Copy

Paramètres¶

username

Le nom de l’utilisateur auquel le jeton est associé.

Si vous omettez ce paramètre, la commande procède à la rotation du jeton de l’utilisateur actuellement connecté (l’utilisateur actif dans la session en cours).

ROTATE { PROGRAMMATIC ACCESS TOKEN | PAT } token_name

Procède à la rotation d’un jeton d’accès programmatique portant le nom spécifié.

Vous pouvez utiliser le mot-clé PAT comme moyen plus court pour spécifier les mots-clés PROGRAMMATIC ACCESS TOKEN.

EXPIRE_ROTATED_TOKEN_AFTER_HOURS = integer

Paramètre le délai d’expiration du secret du jeton existant pour qu’il expire après le nombre d’heures spécifié.

Vous pouvez donner à ce paramètre la valeur 0 pour que le secret du jeton actuel expire immédiatement.

Vous pouvez donner à ce paramètre une valeur comprise entre 0 et le nombre d’heures restant avant l’expiration du secret actuel.

Par défaut : 24

Exigences en matière de contrôle d’accès¶

Un rôle utilisé pour exécuter cette opération doit au minimum disposer des privilèges suivants :

Privilège	Objet	Remarques
MODIFY PROGRAMMATIC AUTHENTICATION METHODS	Utilisateur	Exigé uniquement lors de la rotation d’un jeton d’accès programmatique pour un utilisateur humain autre que vous-même ou un utilisateur de service.

Pour obtenir des instructions sur la création d’un rôle personnalisé avec un ensemble spécifique de privilèges, voir Création de rôles personnalisés.

Pour des informations générales sur les rôles et les privilèges accordés pour effectuer des actions SQL sur des objets sécurisables, voir Aperçu du contrôle d’accès.

Sortie¶

La sortie de la commande fournit des informations sur le jeton d’accès programmatique en rotation dans les colonnes suivantes :

Colonne	Description
`token_name`	Nom du jeton en rotation.
`token_secret`	Le jeton lui-même. Utilisez cette option pour vous authentifier auprès d’un point de terminaison. Note Le jeton n’apparaît que dans la sortie de la commande ALTER USER … ROTATE PROGRAMMATIC ACCESS TOKEN. Aucune autre commande ou fonction SQL n’imprime ou ne renvoie le jeton. Si vous avez besoin d’accéder à ce jeton de manière programmatique, vous pouvez utiliser Snowflake Scripting pour exécuter cette commande et récupérer le jeton à partir de RESULTSET.
`rotated_token_name`	Nom du jeton qui représente le secret préalable. Vous pouvez utiliser cet objet jeton pour déterminer la durée de validité du secret préalable. Vous pouvez également faire expirer le jeton, si nécessaire. Vous ne pouvez pas apporter d’autres types de modifications à ce jeton. Notez que cet objet de jeton est pris en compte dans le nombre maximum de jetons autorisés par utilisateur.

Colonne

Description

token_name

Nom du jeton en rotation.

token_secret

Le jeton lui-même. Utilisez cette option pour vous authentifier auprès d’un point de terminaison.

Note

Le jeton n’apparaît que dans la sortie de la commande ALTER USER … ROTATE PROGRAMMATIC ACCESS TOKEN. Aucune autre commande ou fonction SQL n’imprime ou ne renvoie le jeton.

Si vous avez besoin d’accéder à ce jeton de manière programmatique, vous pouvez utiliser Snowflake Scripting pour exécuter cette commande et récupérer le jeton à partir de RESULTSET.

rotated_token_name

Nom du jeton qui représente le secret préalable.

Vous pouvez utiliser cet objet jeton pour déterminer la durée de validité du secret préalable. Vous pouvez également faire expirer le jeton, si nécessaire. Vous ne pouvez pas apporter d’autres types de modifications à ce jeton.

Notez que cet objet de jeton est pris en compte dans le nombre maximum de jetons autorisés par utilisateur.

Notes sur l’utilisation¶

Vous ne pouvez pas procéder à la rotation d’un jeton d’accès programmatique dans une session où vous avez utilisé un jeton d’accès programmatique pour l’authentification.

Exemples¶

Procéder à la rotation d’un jeton d’accès programmatique associé à l’utilisateur example_user :

ALTER USER IF EXISTS example_user ROTATE PROGRAMMATIC ACCESS TOKEN token_name;

Copy

Procéder à la rotation d’un jeton d’accès programmatique associé à l’utilisateur example_user et faire expirer immédiatement le secret du jeton existant :

ALTER USER IF EXISTS example_user ROTATE PROGRAMMATIC ACCESS TOKEN token_name
  EXPIRE_ROTATED_TOKEN_AFTER_HOURS=0;

Copy