rembrembdocs

Users


A user in Supabase Auth is someone with a user ID, stored in the Auth schema. Once someone is a user, they can be issued an Access Token, which can be used to access Supabase endpoints. The token is tied to the user, so you can restrict access to resources via RLS policies.

Permanent and anonymous users#

Supabase distinguishes between permanent and anonymous users.

Anonymous users are useful for:

See the Anonymous Signins guide to learn more about anonymous users.

Anonymous users do not use the anon role

Just like permanent users, anonymous users use the authenticated role for database access.

The anon role is for those who aren't signed in at all and are not tied to any user ID. We refer to these as unauthenticated or public users.

The user object#

The user object stores all the information related to a user in your application. The user object can be retrieved using one of these methods:

  1. supabase.auth.getUser()
  2. Retrieve a user object as an admin using supabase.auth.admin.getUserById()

A user can sign in with one of the following methods:

An identity describes the authentication method that a user can use to sign in. A user can have multiple identities. These are the types of identities supported:

A user with an email or phone identity will be able to sign in with either a password or passwordless method (e.g. use a one-time password (OTP) or magic link). By default, a user with an unverified email or phone number will not be able to sign in.

The user object contains the following attributes:

Attributes

Type

Description

id

string

The unique id of the identity of the user.

aud

string

The audience claim.

role

string

The role claim used by Postgres to perform Row Level Security (RLS) checks.

email

string

The user's email address.

email_confirmed_at

string

The timestamp that the user's email was confirmed. If null, it means that the user's email is not confirmed.

phone

string

The user's phone number.

phone_confirmed_at

string

The timestamp that the user's phone was confirmed. If null, it means that the user's phone is not confirmed.

confirmed_at

string

The timestamp that either the user's email or phone was confirmed. If null, it means that the user does not have a confirmed email address and phone number.

last_sign_in_at

string

The timestamp that the user last signed in.

app_metadata

object

The provider attribute indicates the first provider that the user used to sign up with. The providers attribute indicates the list of providers that the user can use to login with.

user_metadata

object

Defaults to the first provider's identity data but can contain additional custom user metadata if specified. Refer to User Identity for more information about the identity object. Don't rely on the order of information in this field. Do not use it in security sensitive context (such as in RLS policies or authorization logic), as this value is editable by the user without any checks.

identities

UserIdentity[]

Contains an object array of identities linked to the user.

created_at

string

The timestamp that the user was created.

updated_at

string

The timestamp that the user was last updated.

is_anonymous

boolean

Is true if the user is an anonymous user.

Resources#