Users and groups
This page helps you create users, put them in groups, and decide what a client learns about them.
A user is a person who signs in. A group is a set of users: the permissions and attributes you give a group apply to every user in it, so you set them once instead of on each user.
Create a user
Section titled “Create a user”-
In the admin console, open Admin, Users and click New user.
-
Enter the user’s Email, and their Given name, Middle name and Family name if you like. Turn on Email verified if you know the address is theirs.
-
Choose how the user gets a password:
- Set the password now, and type it in. Tell the user what it is.
- Email a link to set it. The user chooses the password themselves, within 24 hours. This choice appears only when email is set up, under Admin, Email.
-
Click Create user. The user’s page opens on its Details tab.
Users can also create their own accounts from the sign-in page: see Self-registration.
Create a group
Section titled “Create a group”-
Open Admin, Groups and click New group.
-
Enter a Group identifier, such as
editors, and a Description. -
Leave Include in the access token and Include in the ID token on if clients should see that a user is in this group. Click Create group.
-
Open the group’s Members tab, click Add members, search for a user and click Add to group.
Now give the group what its members need: permissions on its Permissions tab, and attributes on its Attributes tab.
Each user has a subject, a random identifier the auth server gives them when they’re created. It never changes, and it’s the sub claim in every token about them, so key your app’s records on it rather than on the email address, which can change.
The email address is the user’s sign-in name. Two users can’t share one, it’s stored in lowercase, and it’s at most 254 characters long, with at most 64 before the @, the longest that email can deliver to.
Every new user gets the authserver:manage-account permission, which lets them manage their own account in the admin console’s Account pages. Nothing else: a new user holds no other permission and is in no group.
The user’s page has these tabs: Details, Profile, Picture, Email, Phone, Address, Authentication, Consents, Legal documents, Sessions, Attributes, Permissions and Groups. The profile, email, phone and address are what a client reads through scopes. Show audit events, above the tabs, opens the audit log filtered to the events about the user and the ones they made. Download data, beside it, saves the user’s data as one file: see A request for a person’s data.
Enabled and disabled
Section titled “Enabled and disabled”A disabled user can’t sign in. Turning off Enabled on the Details tab also ends every session the user has and revokes their refresh tokens, so no client can get a new token for them, and tells the apps that knew them. Turning it back on lets them sign in again, and gives back nothing that was revoked.
To remove a user for good, delete them: see Deleting users.
Deleting users
Section titled “Deleting users”You delete a user from the Users list, with the user’s Delete link, typing their email to confirm.
Users can also delete their own account, under Delete account in the admin console’s Account pages. They confirm with their password and, while two-factor authentication is on, a code from their authenticator or one of their recovery codes. The account is deleted at once.
Whether users can do this is Let users delete their own account, under Admin, General, Account deletion. It’s on by default. Turned off, the Delete account page is gone and only an administrator can delete users. It never limits what you can delete.
Goiabada refuses to delete the last enabled user holding authserver:manage, whoever asks: see the last administrator.
Either way, the deletion removes:
- the user’s profile, email address, phone and address;
- their password, authenticator and recovery codes;
- their picture;
- their group memberships, permissions and attributes;
- the consents they gave clients, and their acceptances of legal documents;
- their sessions, authorization codes and refresh tokens, with the IP address and browser each sign-in recorded, so they’re signed out everywhere, no client can get a new token for them, and the apps that knew them are told. The auth server refuses their access tokens from then on. An API that checks an access token without asking the auth server accepts it until it expires.
It leaves:
- the audit log’s entries about the user, which name them by their ID, not their email address, until the retention removes them;
- the server logs, which can include the user’s IP address;
- backups made before the deletion;
- the encrypted browser-session rows behind the cookies of the user’s sign-ins, which can remain until they expire;
- what clients already received about the user, such as their name and email address. The apps that are told learn that the user’s sessions ended, not that the user is gone.
Whoever deletes the account, the user is emailed that it’s gone, while Send email is on and their address is verified: see emails about account changes.
A request for a person’s data
Section titled “A request for a person’s data”When someone asks for a copy of the data you hold about them, as the GDPR lets them, open them in Users and click Download data, above the tabs. Your browser saves user-<id>-<date>.json, such as user-42-2026-11-05.json: the user’s id and today’s date in UTC. It’s one JSON document, ready to send them.
It holds:
- the user’s profile, email, phone and address, with whether the email and phone were verified;
- their attributes, and their groups with the attributes and permissions each gives them, except attributes no app receives;
- the permissions granted to them directly;
- the consents they gave clients;
- their live sessions, with the clients each one served;
- every refresh token the auth server holds for them, revoked ones included, with its client, scope, times, whether it’s revoked, and the IP address and browser of the sign-in it came from;
- the legal documents they accepted;
- their picture;
- every audit log entry about them or made by them;
- under
identifiers, their id, subject, email address and its digest, and underissuer, your auth server’s issuer.
Nothing secret is in it: no password, authenticator secret, recovery code, emailed code or token.
An entry an administrator made about the person says an administrator did it, with actedByAdministrator, but not who. An entry about a sign-in that replaced another user’s session on a shared browser doesn’t name that other user. The audit log itself still shows who acted. An entry the person made keeps whom they acted on, so an administrator’s file names the users they changed: review it before you send it.
Each download is recorded in the audit log as exported_user_data, under the user and under you.
People can also download the same file themselves, with Download my data under Your data in the admin console’s Account pages. If they signed in more than five minutes ago, they’re asked to sign in again first, with the code from their authenticator if they use two-factor authentication. Their own download is recorded as exported_own_user_data.
The file doesn’t hold:
- attributes, the user’s own or a group’s, with both Include in the access token and Include in the ID token off. No app receives them, so they’re your own notes about the person. They’re still on the user’s and the group’s Attributes tabs: add them to the file, or decide to keep them back;
- audit entries that name the person only by their subject, email address or its digest, not by their id. Search the
audit_logstable’sdetails, or your log pipeline, for the values underidentifiers. An entry about an address the person used before carries that address’s digest, which the file can’t know; - the server logs, which can include the person’s IP address;
- your backups.
Scripts get the same file from GET /api/v1/admin/users/{id}/export, with a token that reads both users and the audit log: see the Admin API scopes.
Passwords
Section titled “Passwords”Every password set here, by you or by the user, must meet the password policy, which the page shows under the field.
New password on the Authentication tab gives the user a new password. It signs them out of every session and revokes their refresh tokens. A password the user changes themselves does the same, except for the session they change it from. See credential changes. Either way, the user is emailed about the change, while Send email is on and their address is verified: see emails about account changes.
A user who forgot their password can ask for a reset link from the sign-in page: see Password recovery. The link you email a new user to set up their password is the same kind of link.
The Authentication tab also shows whether the user has two-factor authentication, and lets you turn it off for a user who lost their authenticator. They can set it up again under Account. If the device could be in someone else’s hands, end their sessions too: see A user who lost their authenticator.
Groups
Section titled “Groups”A group identifier is 3 to 38 characters long. It starts with a letter, ends with a letter or digit, and uses only letters, digits, - and _, with no -- or __. A description is at most 100 characters.
A user can be in any number of groups. They hold every permission each of their groups holds, as well as their own. Deleting a group takes nobody’s account with it: its members just lose what the group gave them.
A group is listed in the groups claim when the client asks for the groups scope. Include in the access token puts it in the access token, and Include in the ID token puts it in the ID token and in the /userinfo answer. Turn either off for a group a client has no business seeing.
Attributes
Section titled “Attributes”An attribute is a key and a value you attach to a user or a group, such as department and sales. A client gets them in the attributes claim when it asks for the attributes scope.
- A key is 1 to 38 characters long, with the same characters as a group identifier.
- A value is at most 250 characters, and can’t contain
<or>. - Include in the access token and Include in the ID token work as they do for groups.
A user’s claim holds their own attributes and those of every group they’re in. When a user and one of their groups both have an attribute with the same key, the group’s value wins.
Administrators
Section titled “Administrators”A user who holds one of the administrative permissions on the authserver resource, directly or through a group, is an administrator. So a group holding one makes every member an administrator, and adding a user to it, removing one, or deleting it needs authserver:manage, just as granting the permission directly does.
Goiabada also refuses any change that would leave no enabled user holding authserver:manage. Administrators has the whole rule, including the last administrator.