Method removeToken

cli/tokens.go:332–386

()

}

func (r *RootCmd) removeToken() *serpent.Command {
	var deleteToken bool
	cmd := &serpent.Command{
		Use:     "remove <name|id|token>",
		Aliases: []string{"delete"},
		Short:   "Expire or delete a token",
		Long: "Remove a token by expiring it. Use --delete to permanently hard-" +
			"delete the token instead.",
		Middleware: serpent.Chain(
			serpent.RequireNArgs(1),
		),
		Handler: func(inv *serpent.Invocation) error {
			client, err := r.InitClient(inv)
			if err != nil {
				return err
			}

			token, err := client.APIKeyByName(inv.Context(), codersdk.Me, inv.Args[0])
			if err != nil {
				// If it's a token, we need to extract the ID.
				maybeID := strings.Split(inv.Args[0], "-")[0]
				token, err = client.APIKeyByID(inv.Context(), codersdk.Me, maybeID)
				if err != nil {
					return xerrors.Errorf("fetch api key by name or id: %w", err)
				}
			}

			if deleteToken {
				err = client.DeleteAPIKey(inv.Context(), codersdk.Me, token.ID)
				if err != nil {
					return xerrors.Errorf("delete api key: %w", err)
				}
				cliui.Infof(inv.Stdout, "Token has been deleted.")
				return nil
			}

			err = client.ExpireAPIKey(inv.Context(), codersdk.Me, token.ID)
			if err != nil {
				return xerrors.Errorf("expire api key: %w", err)
			}
			cliui.Infof(inv.Stdout, "Token has been expired.")
			return nil
		},
	}

	cmd.Options = serpent.OptionSet{
		{
			Flag:        "delete",
			Description: "Permanently delete the token instead of expiring it. This removes the audit trail.",
			Value:       serpent.BoolOf(&deleteToken),
		},
	}

	return cmd
}