Skip to content

feat: Require token name when creating personal access token #35315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 10 commits into from
Jun 18, 2025
Merged

feat: Require token name when creating personal access token #35315

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cb2f47a
only allow creating token with name
xmaxlad Feb 24, 2025
2fcdbc7
Merge branch 'develop' into improve/only-allow-creating-token-with-name
dougfabris May 29, 2025
e03672f
fix: review
dougfabris May 29, 2025
f94d490
chore: changeset
dougfabris May 29, 2025
f60bcb3
fix: review
dougfabris May 29, 2025
ead3cc4
Update new-doors-smash.md
gabriellsh May 29, 2025
29ce297
Merge branch 'develop' into improve/only-allow-creating-token-with-name
dougfabris Jun 17, 2025
9724544
fix: do not allow name with empty spaces only
dougfabris Jun 17, 2025
f79d162
Merge branch 'develop' into improve/only-allow-creating-token-with-name
kodiakhq[bot] Jun 17, 2025
311f264
Merge branch 'develop' into improve/only-allow-creating-token-with-name
kodiakhq[bot] Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/new-doors-smash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@rocket.chat/i18n': minor
'@rocket.chat/meteor': minor
---

Requires token name when creating personal access token avoiding confusion if there are multiple tokens with no name
60 changes: 34 additions & 26 deletions apps/meteor/client/views/account/tokens/AccountTokensTable/AddToken.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type { SelectOption } from '@rocket.chat/fuselage';
import { Box, TextInput, Button, Margins, Select } from '@rocket.chat/fuselage';
import { Box, TextInput, Button, Margins, Select, FieldError, FieldGroup, Field, FieldRow } from '@rocket.chat/fuselage';
import { useSetModal, useToastMessageDispatch, useUserId, useMethod } from '@rocket.chat/ui-contexts';
import DOMPurify from 'dompurify';
import { useCallback, useMemo, useEffect } from 'react';
import { useCallback, useMemo } from 'react';
import { Controller, useForm } from 'react-hook-form';
import { useTranslation } from 'react-i18next';

Expand All @@ -27,11 +27,10 @@ const AddToken = ({ reload }: AddTokenProps) => {
const initialValues = useMemo(() => ({ name: '', bypassTwoFactor: 'require' }), []);

const {
register,
resetField,
handleSubmit,
control,
formState: { isSubmitted, submitCount },
reset,
formState: { errors },
} = useForm<AddTokenFormData>({ defaultValues: initialValues });

const twoFactorAuthOptions: SelectOption[] = useMemo(
Expand All @@ -47,8 +46,14 @@ const AddToken = ({ reload }: AddTokenProps) => {
try {
const token = await createTokenFn({ tokenName, bypassTwoFactor: bypassTwoFactor === 'bypass' });

const handleDismissModal = () => {
setModal(null);
reload();
reset();
};

setModal(
<GenericModal title={t('API_Personal_Access_Token_Generated')} onConfirm={() => setModal(null)} onClose={() => setModal(null)}>
<GenericModal title={t('API_Personal_Access_Token_Generated')} onConfirm={handleDismissModal} onClose={handleDismissModal}>
<Box
dangerouslySetInnerHTML={{
__html: DOMPurify.sanitize(
Expand All @@ -65,32 +70,35 @@ const AddToken = ({ reload }: AddTokenProps) => {
dispatchToastMessage({ type: 'error', message: error });
}
},
[createTokenFn, dispatchToastMessage, setModal, t, userId],
[createTokenFn, dispatchToastMessage, reload, reset, setModal, t, userId],
);

useEffect(() => {
resetField('name');
reload();
}, [isSubmitted, submitCount, reload, resetField]);

return (
<Box display='flex' is='form' onSubmit={handleSubmit(handleAddToken)} mb={8}>
<Box display='flex' width='100%'>
<Margins inlineEnd={4}>
<TextInput data-qa='PersonalTokenField' {...register('name')} placeholder={t('API_Add_Personal_Access_Token')} />
<Box>
<FieldGroup is='form' onSubmit={handleSubmit(handleAddToken)} mb={8}>
<Field>
<FieldRow>
<Margins inlineEnd={4}>
<Controller
name='bypassTwoFactor'
name='name'
control={control}
render={({ field }) => <Select {...field} options={twoFactorAuthOptions} />}
rules={{ required: t('Please_provide_a_name_for_your_token') }}
render={({ field }) => <TextInput data-qa='PersonalTokenField' {...field} placeholder={t('API_Add_Personal_Access_Token')} />}
/>
</Box>
</Margins>
</Box>
<Button primary type='submit'>
{t('Add')}
</Button>
</Box>
<Box>
<Controller
name='bypassTwoFactor'
control={control}
render={({ field }) => <Select {...field} options={twoFactorAuthOptions} />}
/>
</Box>
</Margins>
<Button primary type='submit'>
{t('Add')}
</Button>
</FieldRow>
{errors?.name && <FieldError role='alert'>{errors.name.message}</FieldError>}
</Field>
</FieldGroup>
);
};

Expand Down
1 change: 1 addition & 0 deletions packages/i18n/src/locales/en.i18n.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3972,6 +3972,7 @@
"Premium_capability": "Premium capability",
"Premium_omnichannel_capabilities": "Premium omnichannel capabilities",
"Premium_only": "Premium only",
"Please_provide_a_name_for_your_token":"Please provide a name for your token",
"Preparing_data_for_import_process": "Preparing data for import process",
"Preparing_list_of_channels": "Preparing list of channels",
"Preparing_list_of_messages": "Preparing list of messages",
Expand Down