Self-Hosting Auth

The Supabase Auth Server (GoTrue) is a JSON Web Token (JWT)-based API for managing users and issuing access tokens.

GoTrue is an open-source API written in Golang, that acts as a self-standing API service for handling user registration and authentication for JAM projects. It's based on OAuth2 and JWT and handles user signup, authentication, and custom user data.

Client libraries

Additional links

Generates an email action link.

post/admin/generate_link

Body

data
Optional
object
email
Optional
string
new_email
Optional
string
password
Optional
string
redirect_to
Optional
string
type
Optional
string

Response codes

Response (200)

1
{
2
  "action_link": "lorem",
3
  "app_metadata": {
4
    "property1": null,
5
    "property2": null
6
  },
7
  "aud": "lorem",
8
  "banned_until": "2021-12-31T23:34:00Z",
9
  "confirmation_sent_at": "2021-12-31T23:34:00Z",
10
  "confirmed_at": "2021-12-31T23:34:00Z",
11
  "created_at": "2021-12-31T23:34:00Z",
12
  "email": "lorem",
13
  "email_change_sent_at": "2021-12-31T23:34:00Z",
14
  "email_confirmed_at": "2021-12-31T23:34:00Z",
15
  "email_otp": "lorem",
16
  "hashed_token": "lorem",
17
  "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
18
  "identities": [
19
    {
20
      "created_at": "2021-12-31T23:34:00Z",
21
      "id": "lorem",
22
      "identity_data": {
23
        "property1": null,
24
        "property2": null
25
      },
26
      "last_sign_in_at": "2021-12-31T23:34:00Z",
27
      "provider": "lorem",
28
      "updated_at": "2021-12-31T23:34:00Z",
29
      "user_id": "fbdf5a53-161e-4460-98ad-0e39408d8689"
30
    }
31
  ],
32
  "invited_at": "2021-12-31T23:34:00Z",
33
  "last_sign_in_at": "2021-12-31T23:34:00Z",
34
  "new_email": "lorem",
35
  "new_phone": "lorem",
36
  "phone": "lorem",
37
  "phone_change_sent_at": "2021-12-31T23:34:00Z",
38
  "phone_confirmed_at": "2021-12-31T23:34:00Z",
39
  "reauthentication_sent_at": "2021-12-31T23:34:00Z",
40
  "recovery_sent_at": "2021-12-31T23:34:00Z",
41
  "redirect_to": "lorem",
42
  "role": "lorem",
43
  "updated_at": "2021-12-31T23:34:00Z",
44
  "user_metadata": {
45
    "property1": null,
46
    "property2": null
47
  },
48
  "verification_type": "lorem"
49
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "action_link": {
5
      "type": "string",
6
      "x-go-name": "ActionLink"
7
    },
8
    "app_metadata": {
9
      "type": "object",
10
      "additionalProperties": {},
11
      "x-go-package": "github.com/netlify/gotrue/models"
12
    },
13
    "aud": {
14
      "type": "string",
15
      "x-go-name": "Aud"
16
    },
17
    "banned_until": {
18
      "type": "string",
19
      "format": "date-time",
20
      "x-go-name": "BannedUntil"
21
    },
22
    "confirmation_sent_at": {
23
      "type": "string",
24
      "format": "date-time",
25
      "x-go-name": "ConfirmationSentAt"
26
    },
27
    "confirmed_at": {
28
      "description": "For backward compatibility only. Use EmailConfirmedAt or PhoneConfirmedAt instead.",
29
      "type": "string",
30
      "format": "date-time",
31
      "x-go-name": "ConfirmedAt"
32
    },
33
    "created_at": {
34
      "type": "string",
35
      "format": "date-time",
36
      "x-go-name": "CreatedAt"
37
    },
38
    "email": {
39
      "type": "string",
40
      "x-go-package": "github.com/netlify/gotrue/storage"
41
    },
42
    "email_change_sent_at": {
43
      "type": "string",
44
      "format": "date-time",
45
      "x-go-name": "EmailChangeSentAt"
46
    },
47
    "email_confirmed_at": {
48
      "type": "string",
49
      "format": "date-time",
50
      "x-go-name": "EmailConfirmedAt"
51
    },
52
    "email_otp": {
53
      "type": "string",
54
      "x-go-name": "EmailOtp"
55
    },
56
    "hashed_token": {
57
      "type": "string",
58
      "x-go-name": "HashedToken"
59
    },
60
    "id": {
61
      "type": "string",
62
      "format": "uuid",
63
      "x-go-name": "ID"
64
    },
65
    "identities": {
66
      "type": "array",
67
      "items": {
68
        "type": "object",
69
        "properties": {
70
          "created_at": {
71
            "type": "string",
72
            "format": "date-time",
73
            "x-go-name": "CreatedAt"
74
          },
75
          "id": {
76
            "type": "string",
77
            "x-go-name": "ID"
78
          },
79
          "identity_data": {
80
            "type": "object",
81
            "additionalProperties": {},
82
            "x-go-package": "github.com/netlify/gotrue/models"
83
          },
84
          "last_sign_in_at": {
85
            "type": "string",
86
            "format": "date-time",
87
            "x-go-name": "LastSignInAt"
88
          },
89
          "provider": {
90
            "type": "string",
91
            "x-go-name": "Provider"
92
          },
93
          "updated_at": {
94
            "type": "string",
95
            "format": "date-time",
96
            "x-go-name": "UpdatedAt"
97
          },
98
          "user_id": {
99
            "type": "string",
100
            "format": "uuid",
101
            "x-go-name": "UserID"
102
          }
103
        },
104
        "x-go-package": "github.com/netlify/gotrue/models"
105
      },
106
      "x-go-name": "Identities"
107
    },
108
    "invited_at": {
109
      "type": "string",
110
      "format": "date-time",
111
      "x-go-name": "InvitedAt"
112
    },
113
    "last_sign_in_at": {
114
      "type": "string",
115
      "format": "date-time",
116
      "x-go-name": "LastSignInAt"
117
    },
118
    "new_email": {
119
      "type": "string",
120
      "x-go-name": "EmailChange"
121
    },
122
    "new_phone": {
123
      "type": "string",
124
      "x-go-name": "PhoneChange"
125
    },
126
    "phone": {
127
      "type": "string",
128
      "x-go-package": "github.com/netlify/gotrue/storage"
129
    },
130
    "phone_change_sent_at": {
131
      "type": "string",
132
      "format": "date-time",
133
      "x-go-name": "PhoneChangeSentAt"
134
    },
135
    "phone_confirmed_at": {
136
      "type": "string",
137
      "format": "date-time",
138
      "x-go-name": "PhoneConfirmedAt"
139
    },
140
    "reauthentication_sent_at": {
141
      "type": "string",
142
      "format": "date-time",
143
      "x-go-name": "ReauthenticationSentAt"
144
    },
145
    "recovery_sent_at": {
146
      "type": "string",
147
      "format": "date-time",
148
      "x-go-name": "RecoverySentAt"
149
    },
150
    "redirect_to": {
151
      "type": "string",
152
      "x-go-name": "RedirectTo"
153
    },
154
    "role": {
155
      "type": "string",
156
      "x-go-name": "Role"
157
    },
158
    "updated_at": {
159
      "type": "string",
160
      "format": "date-time",
161
      "x-go-name": "UpdatedAt"
162
    },
163
    "user_metadata": {
164
      "type": "object",
165
      "additionalProperties": {},
166
      "x-go-package": "github.com/netlify/gotrue/models"
167
    },
168
    "verification_type": {
169
      "type": "string",
170
      "x-go-name": "VerificationType"
171
    }
172
  },
173
  "x-go-package": "github.com/netlify/gotrue/api"
174
}

Get a user.

get/admin/users/{user_id}

Path parameters

user_id
Required
The user's id

Response codes

Response (200)

1
{
2
  "app_metadata": {
3
    "property1": null,
4
    "property2": null
5
  },
6
  "aud": "lorem",
7
  "banned_until": "2021-12-31T23:34:00Z",
8
  "confirmation_sent_at": "2021-12-31T23:34:00Z",
9
  "confirmed_at": "2021-12-31T23:34:00Z",
10
  "created_at": "2021-12-31T23:34:00Z",
11
  "email": "lorem",
12
  "email_change_sent_at": "2021-12-31T23:34:00Z",
13
  "email_confirmed_at": "2021-12-31T23:34:00Z",
14
  "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
15
  "identities": [
16
    {
17
      "created_at": "2021-12-31T23:34:00Z",
18
      "id": "lorem",
19
      "identity_data": {
20
        "property1": null,
21
        "property2": null
22
      },
23
      "last_sign_in_at": "2021-12-31T23:34:00Z",
24
      "provider": "lorem",
25
      "updated_at": "2021-12-31T23:34:00Z",
26
      "user_id": "fbdf5a53-161e-4460-98ad-0e39408d8689"
27
    }
28
  ],
29
  "invited_at": "2021-12-31T23:34:00Z",
30
  "last_sign_in_at": "2021-12-31T23:34:00Z",
31
  "new_email": "lorem",
32
  "new_phone": "lorem",
33
  "phone": "lorem",
34
  "phone_change_sent_at": "2021-12-31T23:34:00Z",
35
  "phone_confirmed_at": "2021-12-31T23:34:00Z",
36
  "reauthentication_sent_at": "2021-12-31T23:34:00Z",
37
  "recovery_sent_at": "2021-12-31T23:34:00Z",
38
  "role": "lorem",
39
  "updated_at": "2021-12-31T23:34:00Z",
40
  "user_metadata": {
41
    "property1": null,
42
    "property2": null
43
  }
44
}

1
{
2
  "description": "User respresents a registered user with email/password authentication",
3
  "type": "object",
4
  "properties": {
5
    "app_metadata": {
6
      "type": "object",
7
      "additionalProperties": {},
8
      "x-go-package": "github.com/netlify/gotrue/models"
9
    },
10
    "aud": {
11
      "type": "string",
12
      "x-go-name": "Aud"
13
    },
14
    "banned_until": {
15
      "type": "string",
16
      "format": "date-time",
17
      "x-go-name": "BannedUntil"
18
    },
19
    "confirmation_sent_at": {
20
      "type": "string",
21
      "format": "date-time",
22
      "x-go-name": "ConfirmationSentAt"
23
    },
24
    "confirmed_at": {
25
      "description": "For backward compatibility only. Use EmailConfirmedAt or PhoneConfirmedAt instead.",
26
      "type": "string",
27
      "format": "date-time",
28
      "x-go-name": "ConfirmedAt"
29
    },
30
    "created_at": {
31
      "type": "string",
32
      "format": "date-time",
33
      "x-go-name": "CreatedAt"
34
    },
35
    "email": {
36
      "type": "string",
37
      "x-go-package": "github.com/netlify/gotrue/storage"
38
    },
39
    "email_change_sent_at": {
40
      "type": "string",
41
      "format": "date-time",
42
      "x-go-name": "EmailChangeSentAt"
43
    },
44
    "email_confirmed_at": {
45
      "type": "string",
46
      "format": "date-time",
47
      "x-go-name": "EmailConfirmedAt"
48
    },
49
    "id": {
50
      "type": "string",
51
      "format": "uuid",
52
      "x-go-name": "ID"
53
    },
54
    "identities": {
55
      "type": "array",
56
      "items": {
57
        "type": "object",
58
        "properties": {
59
          "created_at": {
60
            "type": "string",
61
            "format": "date-time",
62
            "x-go-name": "CreatedAt"
63
          },
64
          "id": {
65
            "type": "string",
66
            "x-go-name": "ID"
67
          },
68
          "identity_data": {
69
            "type": "object",
70
            "additionalProperties": {},
71
            "x-go-package": "github.com/netlify/gotrue/models"
72
          },
73
          "last_sign_in_at": {
74
            "type": "string",
75
            "format": "date-time",
76
            "x-go-name": "LastSignInAt"
77
          },
78
          "provider": {
79
            "type": "string",
80
            "x-go-name": "Provider"
81
          },
82
          "updated_at": {
83
            "type": "string",
84
            "format": "date-time",
85
            "x-go-name": "UpdatedAt"
86
          },
87
          "user_id": {
88
            "type": "string",
89
            "format": "uuid",
90
            "x-go-name": "UserID"
91
          }
92
        },
93
        "x-go-package": "github.com/netlify/gotrue/models"
94
      },
95
      "x-go-name": "Identities"
96
    },
97
    "invited_at": {
98
      "type": "string",
99
      "format": "date-time",
100
      "x-go-name": "InvitedAt"
101
    },
102
    "last_sign_in_at": {
103
      "type": "string",
104
      "format": "date-time",
105
      "x-go-name": "LastSignInAt"
106
    },
107
    "new_email": {
108
      "type": "string",
109
      "x-go-name": "EmailChange"
110
    },
111
    "new_phone": {
112
      "type": "string",
113
      "x-go-name": "PhoneChange"
114
    },
115
    "phone": {
116
      "type": "string",
117
      "x-go-package": "github.com/netlify/gotrue/storage"
118
    },
119
    "phone_change_sent_at": {
120
      "type": "string",
121
      "format": "date-time",
122
      "x-go-name": "PhoneChangeSentAt"
123
    },
124
    "phone_confirmed_at": {
125
      "type": "string",
126
      "format": "date-time",
127
      "x-go-name": "PhoneConfirmedAt"
128
    },
129
    "reauthentication_sent_at": {
130
      "type": "string",
131
      "format": "date-time",
132
      "x-go-name": "ReauthenticationSentAt"
133
    },
134
    "recovery_sent_at": {
135
      "type": "string",
136
      "format": "date-time",
137
      "x-go-name": "RecoverySentAt"
138
    },
139
    "role": {
140
      "type": "string",
141
      "x-go-name": "Role"
142
    },
143
    "updated_at": {
144
      "type": "string",
145
      "format": "date-time",
146
      "x-go-name": "UpdatedAt"
147
    },
148
    "user_metadata": {
149
      "type": "object",
150
      "additionalProperties": {},
151
      "x-go-package": "github.com/netlify/gotrue/models"
152
    }
153
  },
154
  "x-go-package": "github.com/netlify/gotrue/models"
155
}

Update a user.

put/admin/users/{user_id}

Path parameters

user_id
Required
The user's id

Response codes

Response (200)

1
{
2
  "app_metadata": {
3
    "property1": null,
4
    "property2": null
5
  },
6
  "aud": "lorem",
7
  "banned_until": "2021-12-31T23:34:00Z",
8
  "confirmation_sent_at": "2021-12-31T23:34:00Z",
9
  "confirmed_at": "2021-12-31T23:34:00Z",
10
  "created_at": "2021-12-31T23:34:00Z",
11
  "email": "lorem",
12
  "email_change_sent_at": "2021-12-31T23:34:00Z",
13
  "email_confirmed_at": "2021-12-31T23:34:00Z",
14
  "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
15
  "identities": [
16
    {
17
      "created_at": "2021-12-31T23:34:00Z",
18
      "id": "lorem",
19
      "identity_data": {
20
        "property1": null,
21
        "property2": null
22
      },
23
      "last_sign_in_at": "2021-12-31T23:34:00Z",
24
      "provider": "lorem",
25
      "updated_at": "2021-12-31T23:34:00Z",
26
      "user_id": "fbdf5a53-161e-4460-98ad-0e39408d8689"
27
    }
28
  ],
29
  "invited_at": "2021-12-31T23:34:00Z",
30
  "last_sign_in_at": "2021-12-31T23:34:00Z",
31
  "new_email": "lorem",
32
  "new_phone": "lorem",
33
  "phone": "lorem",
34
  "phone_change_sent_at": "2021-12-31T23:34:00Z",
35
  "phone_confirmed_at": "2021-12-31T23:34:00Z",
36
  "reauthentication_sent_at": "2021-12-31T23:34:00Z",
37
  "recovery_sent_at": "2021-12-31T23:34:00Z",
38
  "role": "lorem",
39
  "updated_at": "2021-12-31T23:34:00Z",
40
  "user_metadata": {
41
    "property1": null,
42
    "property2": null
43
  }
44
}

1
{
2
  "description": "User respresents a registered user with email/password authentication",
3
  "type": "object",
4
  "properties": {
5
    "app_metadata": {
6
      "type": "object",
7
      "additionalProperties": {},
8
      "x-go-package": "github.com/netlify/gotrue/models"
9
    },
10
    "aud": {
11
      "type": "string",
12
      "x-go-name": "Aud"
13
    },
14
    "banned_until": {
15
      "type": "string",
16
      "format": "date-time",
17
      "x-go-name": "BannedUntil"
18
    },
19
    "confirmation_sent_at": {
20
      "type": "string",
21
      "format": "date-time",
22
      "x-go-name": "ConfirmationSentAt"
23
    },
24
    "confirmed_at": {
25
      "description": "For backward compatibility only. Use EmailConfirmedAt or PhoneConfirmedAt instead.",
26
      "type": "string",
27
      "format": "date-time",
28
      "x-go-name": "ConfirmedAt"
29
    },
30
    "created_at": {
31
      "type": "string",
32
      "format": "date-time",
33
      "x-go-name": "CreatedAt"
34
    },
35
    "email": {
36
      "type": "string",
37
      "x-go-package": "github.com/netlify/gotrue/storage"
38
    },
39
    "email_change_sent_at": {
40
      "type": "string",
41
      "format": "date-time",
42
      "x-go-name": "EmailChangeSentAt"
43
    },
44
    "email_confirmed_at": {
45
      "type": "string",
46
      "format": "date-time",
47
      "x-go-name": "EmailConfirmedAt"
48
    },
49
    "id": {
50
      "type": "string",
51
      "format": "uuid",
52
      "x-go-name": "ID"
53
    },
54
    "identities": {
55
      "type": "array",
56
      "items": {
57
        "type": "object",
58
        "properties": {
59
          "created_at": {
60
            "type": "string",
61
            "format": "date-time",
62
            "x-go-name": "CreatedAt"
63
          },
64
          "id": {
65
            "type": "string",
66
            "x-go-name": "ID"
67
          },
68
          "identity_data": {
69
            "type": "object",
70
            "additionalProperties": {},
71
            "x-go-package": "github.com/netlify/gotrue/models"
72
          },
73
          "last_sign_in_at": {
74
            "type": "string",
75
            "format": "date-time",
76
            "x-go-name": "LastSignInAt"
77
          },
78
          "provider": {
79
            "type": "string",
80
            "x-go-name": "Provider"
81
          },
82
          "updated_at": {
83
            "type": "string",
84
            "format": "date-time",
85
            "x-go-name": "UpdatedAt"
86
          },
87
          "user_id": {
88
            "type": "string",
89
            "format": "uuid",
90
            "x-go-name": "UserID"
91
          }
92
        },
93
        "x-go-package": "github.com/netlify/gotrue/models"
94
      },
95
      "x-go-name": "Identities"
96
    },
97
    "invited_at": {
98
      "type": "string",
99
      "format": "date-time",
100
      "x-go-name": "InvitedAt"
101
    },
102
    "last_sign_in_at": {
103
      "type": "string",
104
      "format": "date-time",
105
      "x-go-name": "LastSignInAt"
106
    },
107
    "new_email": {
108
      "type": "string",
109
      "x-go-name": "EmailChange"
110
    },
111
    "new_phone": {
112
      "type": "string",
113
      "x-go-name": "PhoneChange"
114
    },
115
    "phone": {
116
      "type": "string",
117
      "x-go-package": "github.com/netlify/gotrue/storage"
118
    },
119
    "phone_change_sent_at": {
120
      "type": "string",
121
      "format": "date-time",
122
      "x-go-name": "PhoneChangeSentAt"
123
    },
124
    "phone_confirmed_at": {
125
      "type": "string",
126
      "format": "date-time",
127
      "x-go-name": "PhoneConfirmedAt"
128
    },
129
    "reauthentication_sent_at": {
130
      "type": "string",
131
      "format": "date-time",
132
      "x-go-name": "ReauthenticationSentAt"
133
    },
134
    "recovery_sent_at": {
135
      "type": "string",
136
      "format": "date-time",
137
      "x-go-name": "RecoverySentAt"
138
    },
139
    "role": {
140
      "type": "string",
141
      "x-go-name": "Role"
142
    },
143
    "updated_at": {
144
      "type": "string",
145
      "format": "date-time",
146
      "x-go-name": "UpdatedAt"
147
    },
148
    "user_metadata": {
149
      "type": "object",
150
      "additionalProperties": {},
151
      "x-go-package": "github.com/netlify/gotrue/models"
152
    }
153
  },
154
  "x-go-package": "github.com/netlify/gotrue/models"
155
}

Deletes a user.

delete/admin/users/{user_id}

Path parameters

user_id
Required
The user's id

Response codes

Response (200)

1
{}

List all users.

get/admin/users

Response codes

Response (200)

1
{
2
  "aud": "lorem",
3
  "users": [
4
    {
5
      "app_metadata": {
6
        "property1": null,
7
        "property2": null
8
      },
9
      "aud": "lorem",
10
      "banned_until": "2021-12-31T23:34:00Z",
11
      "confirmation_sent_at": "2021-12-31T23:34:00Z",
12
      "confirmed_at": "2021-12-31T23:34:00Z",
13
      "created_at": "2021-12-31T23:34:00Z",
14
      "email": "lorem",
15
      "email_change_sent_at": "2021-12-31T23:34:00Z",
16
      "email_confirmed_at": "2021-12-31T23:34:00Z",
17
      "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
18
      "identities": [
19
        {
20
          "created_at": "2021-12-31T23:34:00Z",
21
          "id": "lorem",
22
          "identity_data": {
23
            "property1": null,
24
            "property2": null
25
          },
26
          "last_sign_in_at": "2021-12-31T23:34:00Z",
27
          "provider": "lorem",
28
          "updated_at": "2021-12-31T23:34:00Z",
29
          "user_id": "fbdf5a53-161e-4460-98ad-0e39408d8689"
30
        }
31
      ],
32
      "invited_at": "2021-12-31T23:34:00Z",
33
      "last_sign_in_at": "2021-12-31T23:34:00Z",
34
      "new_email": "lorem",
35
      "new_phone": "lorem",
36
      "phone": "lorem",
37
      "phone_change_sent_at": "2021-12-31T23:34:00Z",
38
      "phone_confirmed_at": "2021-12-31T23:34:00Z",
39
      "reauthentication_sent_at": "2021-12-31T23:34:00Z",
40
      "recovery_sent_at": "2021-12-31T23:34:00Z",
41
      "role": "lorem",
42
      "updated_at": "2021-12-31T23:34:00Z",
43
      "user_metadata": {
44
        "property1": null,
45
        "property2": null
46
      }
47
    }
48
  ]
49
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "aud": {
5
      "type": "string",
6
      "x-go-name": "Aud"
7
    },
8
    "users": {
9
      "type": "array",
10
      "items": {
11
        "description": "User respresents a registered user with email/password authentication",
12
        "type": "object",
13
        "properties": {
14
          "app_metadata": {
15
            "type": "object",
16
            "additionalProperties": {},
17
            "x-go-package": "github.com/netlify/gotrue/models"
18
          },
19
          "aud": {
20
            "type": "string",
21
            "x-go-name": "Aud"
22
          },
23
          "banned_until": {
24
            "type": "string",
25
            "format": "date-time",
26
            "x-go-name": "BannedUntil"
27
          },
28
          "confirmation_sent_at": {
29
            "type": "string",
30
            "format": "date-time",
31
            "x-go-name": "ConfirmationSentAt"
32
          },
33
          "confirmed_at": {
34
            "description": "For backward compatibility only. Use EmailConfirmedAt or PhoneConfirmedAt instead.",
35
            "type": "string",
36
            "format": "date-time",
37
            "x-go-name": "ConfirmedAt"
38
          },
39
          "created_at": {
40
            "type": "string",
41
            "format": "date-time",
42
            "x-go-name": "CreatedAt"
43
          },
44
          "email": {
45
            "type": "string",
46
            "x-go-package": "github.com/netlify/gotrue/storage"
47
          },
48
          "email_change_sent_at": {
49
            "type": "string",
50
            "format": "date-time",
51
            "x-go-name": "EmailChangeSentAt"
52
          },
53
          "email_confirmed_at": {
54
            "type": "string",
55
            "format": "date-time",
56
            "x-go-name": "EmailConfirmedAt"
57
          },
58
          "id": {
59
            "type": "string",
60
            "format": "uuid",
61
            "x-go-name": "ID"
62
          },
63
          "identities": {
64
            "type": "array",
65
            "items": {
66
              "type": "object",
67
              "properties": {
68
                "created_at": {
69
                  "type": "string",
70
                  "format": "date-time",
71
                  "x-go-name": "CreatedAt"
72
                },
73
                "id": {
74
                  "type": "string",
75
                  "x-go-name": "ID"
76
                },
77
                "identity_data": {
78
                  "type": "object",
79
                  "additionalProperties": {},
80
                  "x-go-package": "github.com/netlify/gotrue/models"
81
                },
82
                "last_sign_in_at": {
83
                  "type": "string",
84
                  "format": "date-time",
85
                  "x-go-name": "LastSignInAt"
86
                },
87
                "provider": {
88
                  "type": "string",
89
                  "x-go-name": "Provider"
90
                },
91
                "updated_at": {
92
                  "type": "string",
93
                  "format": "date-time",
94
                  "x-go-name": "UpdatedAt"
95
                },
96
                "user_id": {
97
                  "type": "string",
98
                  "format": "uuid",
99
                  "x-go-name": "UserID"
100
                }
101
              },
102
              "x-go-package": "github.com/netlify/gotrue/models"
103
            },
104
            "x-go-name": "Identities"
105
          },
106
          "invited_at": {
107
            "type": "string",
108
            "format": "date-time",
109
            "x-go-name": "InvitedAt"
110
          },
111
          "last_sign_in_at": {
112
            "type": "string",
113
            "format": "date-time",
114
            "x-go-name": "LastSignInAt"
115
          },
116
          "new_email": {
117
            "type": "string",
118
            "x-go-name": "EmailChange"
119
          },
120
          "new_phone": {
121
            "type": "string",
122
            "x-go-name": "PhoneChange"
123
          },
124
          "phone": {
125
            "type": "string",
126
            "x-go-package": "github.com/netlify/gotrue/storage"
127
          },
128
          "phone_change_sent_at": {
129
            "type": "string",
130
            "format": "date-time",
131
            "x-go-name": "PhoneChangeSentAt"
132
          },
133
          "phone_confirmed_at": {
134
            "type": "string",
135
            "format": "date-time",
136
            "x-go-name": "PhoneConfirmedAt"
137
          },
138
          "reauthentication_sent_at": {
139
            "type": "string",
140
            "format": "date-time",
141
            "x-go-name": "ReauthenticationSentAt"
142
          },
143
          "recovery_sent_at": {
144
            "type": "string",
145
            "format": "date-time",
146
            "x-go-name": "RecoverySentAt"
147
          },
148
          "role": {
149
            "type": "string",
150
            "x-go-name": "Role"
151
          },
152
          "updated_at": {
153
            "type": "string",
154
            "format": "date-time",
155
            "x-go-name": "UpdatedAt"
156
          },
157
          "user_metadata": {
158
            "type": "object",
159
            "additionalProperties": {},
160
            "x-go-package": "github.com/netlify/gotrue/models"
161
          }
162
        },
163
        "x-go-package": "github.com/netlify/gotrue/models"
164
      },
165
      "x-go-name": "Users"
166
    }
167
  },
168
  "x-go-package": "github.com/netlify/gotrue/api"
169
}

Returns the created user.

post/admin/users

Body

app_metadata
Optional
object
aud
Optional
string
ban_duration
Optional
string
email
Optional
string
email_confirm
Optional
boolean
password
Optional
string
phone
Optional
string
phone_confirm
Optional
boolean
role
Optional
string
user_metadata
Optional
object

Response codes

Response (200)

1
{
2
  "app_metadata": {
3
    "property1": null,
4
    "property2": null
5
  },
6
  "aud": "lorem",
7
  "banned_until": "2021-12-31T23:34:00Z",
8
  "confirmation_sent_at": "2021-12-31T23:34:00Z",
9
  "confirmed_at": "2021-12-31T23:34:00Z",
10
  "created_at": "2021-12-31T23:34:00Z",
11
  "email": "lorem",
12
  "email_change_sent_at": "2021-12-31T23:34:00Z",
13
  "email_confirmed_at": "2021-12-31T23:34:00Z",
14
  "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
15
  "identities": [
16
    {
17
      "created_at": "2021-12-31T23:34:00Z",
18
      "id": "lorem",
19
      "identity_data": {
20
        "property1": null,
21
        "property2": null
22
      },
23
      "last_sign_in_at": "2021-12-31T23:34:00Z",
24
      "provider": "lorem",
25
      "updated_at": "2021-12-31T23:34:00Z",
26
      "user_id": "fbdf5a53-161e-4460-98ad-0e39408d8689"
27
    }
28
  ],
29
  "invited_at": "2021-12-31T23:34:00Z",
30
  "last_sign_in_at": "2021-12-31T23:34:00Z",
31
  "new_email": "lorem",
32
  "new_phone": "lorem",
33
  "phone": "lorem",
34
  "phone_change_sent_at": "2021-12-31T23:34:00Z",
35
  "phone_confirmed_at": "2021-12-31T23:34:00Z",
36
  "reauthentication_sent_at": "2021-12-31T23:34:00Z",
37
  "recovery_sent_at": "2021-12-31T23:34:00Z",
38
  "role": "lorem",
39
  "updated_at": "2021-12-31T23:34:00Z",
40
  "user_metadata": {
41
    "property1": null,
42
    "property2": null
43
  }
44
}

1
{
2
  "description": "User respresents a registered user with email/password authentication",
3
  "type": "object",
4
  "properties": {
5
    "app_metadata": {
6
      "type": "object",
7
      "additionalProperties": {},
8
      "x-go-package": "github.com/netlify/gotrue/models"
9
    },
10
    "aud": {
11
      "type": "string",
12
      "x-go-name": "Aud"
13
    },
14
    "banned_until": {
15
      "type": "string",
16
      "format": "date-time",
17
      "x-go-name": "BannedUntil"
18
    },
19
    "confirmation_sent_at": {
20
      "type": "string",
21
      "format": "date-time",
22
      "x-go-name": "ConfirmationSentAt"
23
    },
24
    "confirmed_at": {
25
      "description": "For backward compatibility only. Use EmailConfirmedAt or PhoneConfirmedAt instead.",
26
      "type": "string",
27
      "format": "date-time",
28
      "x-go-name": "ConfirmedAt"
29
    },
30
    "created_at": {
31
      "type": "string",
32
      "format": "date-time",
33
      "x-go-name": "CreatedAt"
34
    },
35
    "email": {
36
      "type": "string",
37
      "x-go-package": "github.com/netlify/gotrue/storage"
38
    },
39
    "email_change_sent_at": {
40
      "type": "string",
41
      "format": "date-time",
42
      "x-go-name": "EmailChangeSentAt"
43
    },
44
    "email_confirmed_at": {
45
      "type": "string",
46
      "format": "date-time",
47
      "x-go-name": "EmailConfirmedAt"
48
    },
49
    "id": {
50
      "type": "string",
51
      "format": "uuid",
52
      "x-go-name": "ID"
53
    },
54
    "identities": {
55
      "type": "array",
56
      "items": {
57
        "type": "object",
58
        "properties": {
59
          "created_at": {
60
            "type": "string",
61
            "format": "date-time",
62
            "x-go-name": "CreatedAt"
63
          },
64
          "id": {
65
            "type": "string",
66
            "x-go-name": "ID"
67
          },
68
          "identity_data": {
69
            "type": "object",
70
            "additionalProperties": {},
71
            "x-go-package": "github.com/netlify/gotrue/models"
72
          },
73
          "last_sign_in_at": {
74
            "type": "string",
75
            "format": "date-time",
76
            "x-go-name": "LastSignInAt"
77
          },
78
          "provider": {
79
            "type": "string",
80
            "x-go-name": "Provider"
81
          },
82
          "updated_at": {
83
            "type": "string",
84
            "format": "date-time",
85
            "x-go-name": "UpdatedAt"
86
          },
87
          "user_id": {
88
            "type": "string",
89
            "format": "uuid",
90
            "x-go-name": "UserID"
91
          }
92
        },
93
        "x-go-package": "github.com/netlify/gotrue/models"
94
      },
95
      "x-go-name": "Identities"
96
    },
97
    "invited_at": {
98
      "type": "string",
99
      "format": "date-time",
100
      "x-go-name": "InvitedAt"
101
    },
102
    "last_sign_in_at": {
103
      "type": "string",
104
      "format": "date-time",
105
      "x-go-name": "LastSignInAt"
106
    },
107
    "new_email": {
108
      "type": "string",
109
      "x-go-name": "EmailChange"
110
    },
111
    "new_phone": {
112
      "type": "string",
113
      "x-go-name": "PhoneChange"
114
    },
115
    "phone": {
116
      "type": "string",
117
      "x-go-package": "github.com/netlify/gotrue/storage"
118
    },
119
    "phone_change_sent_at": {
120
      "type": "string",
121
      "format": "date-time",
122
      "x-go-name": "PhoneChangeSentAt"
123
    },
124
    "phone_confirmed_at": {
125
      "type": "string",
126
      "format": "date-time",
127
      "x-go-name": "PhoneConfirmedAt"
128
    },
129
    "reauthentication_sent_at": {
130
      "type": "string",
131
      "format": "date-time",
132
      "x-go-name": "ReauthenticationSentAt"
133
    },
134
    "recovery_sent_at": {
135
      "type": "string",
136
      "format": "date-time",
137
      "x-go-name": "RecoverySentAt"
138
    },
139
    "role": {
140
      "type": "string",
141
      "x-go-name": "Role"
142
    },
143
    "updated_at": {
144
      "type": "string",
145
      "format": "date-time",
146
      "x-go-name": "UpdatedAt"
147
    },
148
    "user_metadata": {
149
      "type": "object",
150
      "additionalProperties": {},
151
      "x-go-package": "github.com/netlify/gotrue/models"
152
    }
153
  },
154
  "x-go-package": "github.com/netlify/gotrue/models"
155
}

Receives the redirect from an external provider during the OAuth authentication process. Starts the process of creating an access and refresh token.

get/callback

Response codes

The healthcheck endpoint for gotrue. Returns the current gotrue version.

get/health

Response codes

Response (200)

1
{
2
  "description": "lorem",
3
  "name": "lorem",
4
  "version": "lorem"
5
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "description": {
5
      "type": "string",
6
      "x-go-name": "Description"
7
    },
8
    "name": {
9
      "type": "string",
10
      "x-go-name": "Name"
11
    },
12
    "version": {
13
      "type": "string",
14
      "x-go-name": "Version"
15
    }
16
  },
17
  "x-go-package": "github.com/netlify/gotrue/api"
18
}

Sends an invite link to the user.

post/invite

Body

data
Optional
object
email
Optional
string

Response codes

Response (200)

1
{}

Logs out the user.

post/logout

Response codes

Response (204)

1
{}

Sends a password recovery email link to the user's email.

post/recover

Body

email
Optional
string

Response codes

Response (200)

1
{}

Returns the configuration settings for the gotrue server.

get/settings

Response codes

Response (200)

1
{
2
  "disable_signup": true,
3
  "external": {
4
    "apple": true,
5
    "azure": true,
6
    "bitbucket": true,
7
    "discord": true,
8
    "email": true,
9
    "facebook": true,
10
    "github": true,
11
    "gitlab": true,
12
    "google": true,
13
    "keycloak": true,
14
    "linkedin": true,
15
    "notion": true,
16
    "phone": true,
17
    "saml": true,
18
    "slack": true,
19
    "spotify": true,
20
    "twitch": true,
21
    "twitter": true,
22
    "workos": true,
23
    "zoom": true
24
  },
25
  "mailer_autoconfirm": true,
26
  "phone_autoconfirm": true,
27
  "sms_provider": "lorem"
28
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "disable_signup": {
5
      "type": "boolean",
6
      "x-go-name": "DisableSignup"
7
    },
8
    "external": {
9
      "type": "object",
10
      "properties": {
11
        "apple": {
12
          "type": "boolean",
13
          "x-go-name": "Apple"
14
        },
15
        "azure": {
16
          "type": "boolean",
17
          "x-go-name": "Azure"
18
        },
19
        "bitbucket": {
20
          "type": "boolean",
21
          "x-go-name": "Bitbucket"
22
        },
23
        "discord": {
24
          "type": "boolean",
25
          "x-go-name": "Discord"
26
        },
27
        "email": {
28
          "type": "boolean",
29
          "x-go-name": "Email"
30
        },
31
        "facebook": {
32
          "type": "boolean",
33
          "x-go-name": "Facebook"
34
        },
35
        "github": {
36
          "type": "boolean",
37
          "x-go-name": "GitHub"
38
        },
39
        "gitlab": {
40
          "type": "boolean",
41
          "x-go-name": "GitLab"
42
        },
43
        "google": {
44
          "type": "boolean",
45
          "x-go-name": "Google"
46
        },
47
        "keycloak": {
48
          "type": "boolean",
49
          "x-go-name": "Keycloak"
50
        },
51
        "linkedin": {
52
          "type": "boolean",
53
          "x-go-name": "Linkedin"
54
        },
55
        "notion": {
56
          "type": "boolean",
57
          "x-go-name": "Notion"
58
        },
59
        "phone": {
60
          "type": "boolean",
61
          "x-go-name": "Phone"
62
        },
63
        "saml": {
64
          "type": "boolean",
65
          "x-go-name": "SAML"
66
        },
67
        "slack": {
68
          "type": "boolean",
69
          "x-go-name": "Slack"
70
        },
71
        "spotify": {
72
          "type": "boolean",
73
          "x-go-name": "Spotify"
74
        },
75
        "twitch": {
76
          "type": "boolean",
77
          "x-go-name": "Twitch"
78
        },
79
        "twitter": {
80
          "type": "boolean",
81
          "x-go-name": "Twitter"
82
        },
83
        "workos": {
84
          "type": "boolean",
85
          "x-go-name": "WorkOS"
86
        },
87
        "zoom": {
88
          "type": "boolean",
89
          "x-go-name": "Zoom"
90
        }
91
      },
92
      "x-go-package": "github.com/netlify/gotrue/api"
93
    },
94
    "mailer_autoconfirm": {
95
      "type": "boolean",
96
      "x-go-name": "MailerAutoconfirm"
97
    },
98
    "phone_autoconfirm": {
99
      "type": "boolean",
100
      "x-go-name": "PhoneAutoconfirm"
101
    },
102
    "sms_provider": {
103
      "type": "string",
104
      "x-go-name": "SmsProvider"
105
    }
106
  },
107
  "x-go-package": "github.com/netlify/gotrue/api"
108
}

Password-based signup with either email or phone.

post/signup

Body

data
Optional
object
email
Optional
string
password
Optional
string
phone
Optional
string

Response codes

Response (200)

1
{
2
  "app_metadata": {
3
    "property1": null,
4
    "property2": null
5
  },
6
  "aud": "lorem",
7
  "banned_until": "2021-12-31T23:34:00Z",
8
  "confirmation_sent_at": "2021-12-31T23:34:00Z",
9
  "confirmed_at": "2021-12-31T23:34:00Z",
10
  "created_at": "2021-12-31T23:34:00Z",
11
  "email": "lorem",
12
  "email_change_sent_at": "2021-12-31T23:34:00Z",
13
  "email_confirmed_at": "2021-12-31T23:34:00Z",
14
  "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
15
  "identities": [
16
    {
17
      "created_at": "2021-12-31T23:34:00Z",
18
      "id": "lorem",
19
      "identity_data": {
20
        "property1": null,
21
        "property2": null
22
      },
23
      "last_sign_in_at": "2021-12-31T23:34:00Z",
24
      "provider": "lorem",
25
      "updated_at": "2021-12-31T23:34:00Z",
26
      "user_id": "fbdf5a53-161e-4460-98ad-0e39408d8689"
27
    }
28
  ],
29
  "invited_at": "2021-12-31T23:34:00Z",
30
  "last_sign_in_at": "2021-12-31T23:34:00Z",
31
  "new_email": "lorem",
32
  "new_phone": "lorem",
33
  "phone": "lorem",
34
  "phone_change_sent_at": "2021-12-31T23:34:00Z",
35
  "phone_confirmed_at": "2021-12-31T23:34:00Z",
36
  "reauthentication_sent_at": "2021-12-31T23:34:00Z",
37
  "recovery_sent_at": "2021-12-31T23:34:00Z",
38
  "role": "lorem",
39
  "updated_at": "2021-12-31T23:34:00Z",
40
  "user_metadata": {
41
    "property1": null,
42
    "property2": null
43
  }
44
}

1
{
2
  "description": "User respresents a registered user with email/password authentication",
3
  "type": "object",
4
  "properties": {
5
    "app_metadata": {
6
      "type": "object",
7
      "additionalProperties": {},
8
      "x-go-package": "github.com/netlify/gotrue/models"
9
    },
10
    "aud": {
11
      "type": "string",
12
      "x-go-name": "Aud"
13
    },
14
    "banned_until": {
15
      "type": "string",
16
      "format": "date-time",
17
      "x-go-name": "BannedUntil"
18
    },
19
    "confirmation_sent_at": {
20
      "type": "string",
21
      "format": "date-time",
22
      "x-go-name": "ConfirmationSentAt"
23
    },
24
    "confirmed_at": {
25
      "description": "For backward compatibility only. Use EmailConfirmedAt or PhoneConfirmedAt instead.",
26
      "type": "string",
27
      "format": "date-time",
28
      "x-go-name": "ConfirmedAt"
29
    },
30
    "created_at": {
31
      "type": "string",
32
      "format": "date-time",
33
      "x-go-name": "CreatedAt"
34
    },
35
    "email": {
36
      "type": "string",
37
      "x-go-package": "github.com/netlify/gotrue/storage"
38
    },
39
    "email_change_sent_at": {
40
      "type": "string",
41
      "format": "date-time",
42
      "x-go-name": "EmailChangeSentAt"
43
    },
44
    "email_confirmed_at": {
45
      "type": "string",
46
      "format": "date-time",
47
      "x-go-name": "EmailConfirmedAt"
48
    },
49
    "id": {
50
      "type": "string",
51
      "format": "uuid",
52
      "x-go-name": "ID"
53
    },
54
    "identities": {
55
      "type": "array",
56
      "items": {
57
        "type": "object",
58
        "properties": {
59
          "created_at": {
60
            "type": "string",
61
            "format": "date-time",
62
            "x-go-name": "CreatedAt"
63
          },
64
          "id": {
65
            "type": "string",
66
            "x-go-name": "ID"
67
          },
68
          "identity_data": {
69
            "type": "object",
70
            "additionalProperties": {},
71
            "x-go-package": "github.com/netlify/gotrue/models"
72
          },
73
          "last_sign_in_at": {
74
            "type": "string",
75
            "format": "date-time",
76
            "x-go-name": "LastSignInAt"
77
          },
78
          "provider": {
79
            "type": "string",
80
            "x-go-name": "Provider"
81
          },
82
          "updated_at": {
83
            "type": "string",
84
            "format": "date-time",
85
            "x-go-name": "UpdatedAt"
86
          },
87
          "user_id": {
88
            "type": "string",
89
            "format": "uuid",
90
            "x-go-name": "UserID"
91
          }
92
        },
93
        "x-go-package": "github.com/netlify/gotrue/models"
94
      },
95
      "x-go-name": "Identities"
96
    },
97
    "invited_at": {
98
      "type": "string",
99
      "format": "date-time",
100
      "x-go-name": "InvitedAt"
101
    },
102
    "last_sign_in_at": {
103
      "type": "string",
104
      "format": "date-time",
105
      "x-go-name": "LastSignInAt"
106
    },
107
    "new_email": {
108
      "type": "string",
109
      "x-go-name": "EmailChange"
110
    },
111
    "new_phone": {
112
      "type": "string",
113
      "x-go-name": "PhoneChange"
114
    },
115
    "phone": {
116
      "type": "string",
117
      "x-go-package": "github.com/netlify/gotrue/storage"
118
    },
119
    "phone_change_sent_at": {
120
      "type": "string",
121
      "format": "date-time",
122
      "x-go-name": "PhoneChangeSentAt"
123
    },
124
    "phone_confirmed_at": {
125
      "type": "string",
126
      "format": "date-time",
127
      "x-go-name": "PhoneConfirmedAt"
128
    },
129
    "reauthentication_sent_at": {
130
      "type": "string",
131
      "format": "date-time",
132
      "x-go-name": "ReauthenticationSentAt"
133
    },
134
    "recovery_sent_at": {
135
      "type": "string",
136
      "format": "date-time",
137
      "x-go-name": "RecoverySentAt"
138
    },
139
    "role": {
140
      "type": "string",
141
      "x-go-name": "Role"
142
    },
143
    "updated_at": {
144
      "type": "string",
145
      "format": "date-time",
146
      "x-go-name": "UpdatedAt"
147
    },
148
    "user_metadata": {
149
      "type": "object",
150
      "additionalProperties": {},
151
      "x-go-package": "github.com/netlify/gotrue/models"
152
    }
153
  },
154
  "x-go-package": "github.com/netlify/gotrue/models"
155
}

Signs in a user with a password.

post/token?grant_type=password

Body

email
Optional
string
password
Optional
string
phone
Optional
string

Response codes

Response (200)

1
{
2
  "access_token": "lorem",
3
  "expires_in": 42,
4
  "refresh_token": "lorem",
5
  "token_type": "lorem",
6
  "user": {
7
    "app_metadata": {
8
      "property1": null,
9
      "property2": null
10
    },
11
    "aud": "lorem",
12
    "banned_until": "2021-12-31T23:34:00Z",
13
    "confirmation_sent_at": "2021-12-31T23:34:00Z",
14
    "confirmed_at": "2021-12-31T23:34:00Z",
15
    "created_at": "2021-12-31T23:34:00Z",
16
    "email": "lorem",
17
    "email_change_sent_at": "2021-12-31T23:34:00Z",
18
    "email_confirmed_at": "2021-12-31T23:34:00Z",
19
    "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
20
    "identities": [
21
      {
22
        "created_at": "2021-12-31T23:34:00Z",
23
        "id": "lorem",
24
        "identity_data": {
25
          "property1": null,
26
          "property2": null
27
        },
28
        "last_sign_in_at": "2021-12-31T23:34:00Z",
29
        "provider": "lorem",
30
        "updated_at": "2021-12-31T23:34:00Z",
31
        "user_id": "fbdf5a53-161e-4460-98ad-0e39408d8689"
32
      }
33
    ],
34
    "invited_at": "2021-12-31T23:34:00Z",
35
    "last_sign_in_at": "2021-12-31T23:34:00Z",
36
    "new_email": "lorem",
37
    "new_phone": "lorem",
38
    "phone": "lorem",
39
    "phone_change_sent_at": "2021-12-31T23:34:00Z",
40
    "phone_confirmed_at": "2021-12-31T23:34:00Z",
41
    "reauthentication_sent_at": "2021-12-31T23:34:00Z",
42
    "recovery_sent_at": "2021-12-31T23:34:00Z",
43
    "role": "lorem",
44
    "updated_at": "2021-12-31T23:34:00Z",
45
    "user_metadata": {
46
      "property1": null,
47
      "property2": null
48
    }
49
  }
50
}

1
{
2
  "description": "AccessTokenResponse represents an OAuth2 success response",
3
  "type": "object",
4
  "properties": {
5
    "access_token": {
6
      "type": "string",
7
      "x-go-name": "Token"
8
    },
9
    "expires_in": {
10
      "type": "integer",
11
      "format": "int64",
12
      "x-go-name": "ExpiresIn"
13
    },
14
    "refresh_token": {
15
      "type": "string",
16
      "x-go-name": "RefreshToken"
17
    },
18
    "token_type": {
19
      "type": "string",
20
      "x-go-name": "TokenType"
21
    },
22
    "user": {
23
      "description": "User respresents a registered user with email/password authentication",
24
      "type": "object",
25
      "properties": {
26
        "app_metadata": {
27
          "type": "object",
28
          "additionalProperties": {},
29
          "x-go-package": "github.com/netlify/gotrue/models"
30
        },
31
        "aud": {
32
          "type": "string",
33
          "x-go-name": "Aud"
34
        },
35
        "banned_until": {
36
          "type": "string",
37
          "format": "date-time",
38
          "x-go-name": "BannedUntil"
39
        },
40
        "confirmation_sent_at": {
41
          "type": "string",
42
          "format": "date-time",
43
          "x-go-name": "ConfirmationSentAt"
44
        },
45
        "confirmed_at": {
46
          "description": "For backward compatibility only. Use EmailConfirmedAt or PhoneConfirmedAt instead.",
47
          "type": "string",
48
          "format": "date-time",
49
          "x-go-name": "ConfirmedAt"
50
        },
51
        "created_at": {
52
          "type": "string",
53
          "format": "date-time",
54
          "x-go-name": "CreatedAt"
55
        },
56
        "email": {
57
          "type": "string",
58
          "x-go-package": "github.com/netlify/gotrue/storage"
59
        },
60
        "email_change_sent_at": {
61
          "type": "string",
62
          "format": "date-time",
63
          "x-go-name": "EmailChangeSentAt"
64
        },
65
        "email_confirmed_at": {
66
          "type": "string",
67
          "format": "date-time",
68
          "x-go-name": "EmailConfirmedAt"
69
        },
70
        "id": {
71
          "type": "string",
72
          "format": "uuid",
73
          "x-go-name": "ID"
74
        },
75
        "identities": {
76
          "type": "array",
77
          "items": {
78
            "type": "object",
79
            "properties": {
80
              "created_at": {
81
                "type": "string",
82
                "format": "date-time",
83
                "x-go-name": "CreatedAt"
84
              },
85
              "id": {
86
                "type": "string",
87
                "x-go-name": "ID"
88
              },
89
              "identity_data": {
90
                "type": "object",
91
                "additionalProperties": {},
92
                "x-go-package": "github.com/netlify/gotrue/models"
93
              },
94
              "last_sign_in_at": {
95
                "type": "string",
96
                "format": "date-time",
97
                "x-go-name": "LastSignInAt"
98
              },
99
              "provider": {
100
                "type": "string",
101
                "x-go-name": "Provider"
102
              },
103
              "updated_at": {
104
                "type": "string",
105
                "format": "date-time",
106
                "x-go-name": "UpdatedAt"
107
              },
108
              "user_id": {
109
                "type": "string",
110
                "format": "uuid",
111
                "x-go-name": "UserID"
112
              }
113
            },
114
            "x-go-package": "github.com/netlify/gotrue/models"
115
          },
116
          "x-go-name": "Identities"
117
        },
118
        "invited_at": {
119
          "type": "string",
120
          "format": "date-time",
121
          "x-go-name": "InvitedAt"
122
        },
123
        "last_sign_in_at": {
124
          "type": "string",
125
          "format": "date-time",
126
          "x-go-name": "LastSignInAt"
127
        },
128
        "new_email": {
129
          "type": "string",
130
          "x-go-name": "EmailChange"
131
        },
132
        "new_phone": {
133
          "type": "string",
134
          "x-go-name": "PhoneChange"
135
        },
136
        "phone": {
137
          "type": "string",
138
          "x-go-package": "github.com/netlify/gotrue/storage"
139
        },
140
        "phone_change_sent_at": {
141
          "type": "string",
142
          "format": "date-time",
143
          "x-go-name": "PhoneChangeSentAt"
144
        },
145
        "phone_confirmed_at": {
146
          "type": "string",
147
          "format": "date-time",
148
          "x-go-name": "PhoneConfirmedAt"
149
        },
150
        "reauthentication_sent_at": {
151
          "type": "string",
152
          "format": "date-time",
153
          "x-go-name": "ReauthenticationSentAt"
154
        },
155
        "recovery_sent_at": {
156
          "type": "string",
157
          "format": "date-time",
158
          "x-go-name": "RecoverySentAt"
159
        },
160
        "role": {
161
          "type": "string",
162
          "x-go-name": "Role"
163
        },
164
        "updated_at": {
165
          "type": "string",
166
          "format": "date-time",
167
          "x-go-name": "UpdatedAt"
168
        },
169
        "user_metadata": {
170
          "type": "object",
171
          "additionalProperties": {},
172
          "x-go-package": "github.com/netlify/gotrue/models"
173
        }
174
      },
175
      "x-go-package": "github.com/netlify/gotrue/models"
176
    }
177
  },
178
  "x-go-package": "github.com/netlify/gotrue/api"
179
}

Refreshes a user's refresh token.

post/token?grant_type=refresh_token

Body

refresh_token
Optional
string

Response codes

Response (200)

1
{
2
  "access_token": "lorem",
3
  "expires_in": 42,
4
  "refresh_token": "lorem",
5
  "token_type": "lorem",
6
  "user": {
7
    "app_metadata": {
8
      "property1": null,
9
      "property2": null
10
    },
11
    "aud": "lorem",
12
    "banned_until": "2021-12-31T23:34:00Z",
13
    "confirmation_sent_at": "2021-12-31T23:34:00Z",
14
    "confirmed_at": "2021-12-31T23:34:00Z",
15
    "created_at": "2021-12-31T23:34:00Z",
16
    "email": "lorem",
17
    "email_change_sent_at": "2021-12-31T23:34:00Z",
18
    "email_confirmed_at": "2021-12-31T23:34:00Z",
19
    "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
20
    "identities": [
21
      {
22
        "created_at": "2021-12-31T23:34:00Z",
23
        "id": "lorem",
24
        "identity_data": {
25
          "property1": null,
26
          "property2": null
27
        },
28
        "last_sign_in_at": "2021-12-31T23:34:00Z",
29
        "provider": "lorem",
30
        "updated_at": "2021-12-31T23:34:00Z",
31
        "user_id": "fbdf5a53-161e-4460-98ad-0e39408d8689"
32
      }
33
    ],
34
    "invited_at": "2021-12-31T23:34:00Z",
35
    "last_sign_in_at": "2021-12-31T23:34:00Z",
36
    "new_email": "lorem",
37
    "new_phone": "lorem",
38
    "phone": "lorem",
39
    "phone_change_sent_at": "2021-12-31T23:34:00Z",
40
    "phone_confirmed_at": "2021-12-31T23:34:00Z",
41
    "reauthentication_sent_at": "2021-12-31T23:34:00Z",
42
    "recovery_sent_at": "2021-12-31T23:34:00Z",
43
    "role": "lorem",
44
    "updated_at": "2021-12-31T23:34:00Z",
45
    "user_metadata": {
46
      "property1": null,
47
      "property2": null
48
    }
49
  }
50
}

1
{
2
  "description": "AccessTokenResponse represents an OAuth2 success response",
3
  "type": "object",
4
  "properties": {
5
    "access_token": {
6
      "type": "string",
7
      "x-go-name": "Token"
8
    },
9
    "expires_in": {
10
      "type": "integer",
11
      "format": "int64",
12
      "x-go-name": "ExpiresIn"
13
    },
14
    "refresh_token": {
15
      "type": "string",
16
      "x-go-name": "RefreshToken"
17
    },
18
    "token_type": {
19
      "type": "string",
20
      "x-go-name": "TokenType"
21
    },
22
    "user": {
23
      "description": "User respresents a registered user with email/password authentication",
24
      "type": "object",
25
      "properties": {
26
        "app_metadata": {
27
          "type": "object",
28
          "additionalProperties": {},
29
          "x-go-package": "github.com/netlify/gotrue/models"
30
        },
31
        "aud": {
32
          "type": "string",
33
          "x-go-name": "Aud"
34
        },
35
        "banned_until": {
36
          "type": "string",
37
          "format": "date-time",
38
          "x-go-name": "BannedUntil"
39
        },
40
        "confirmation_sent_at": {
41
          "type": "string",
42
          "format": "date-time",
43
          "x-go-name": "ConfirmationSentAt"
44
        },
45
        "confirmed_at": {
46
          "description": "For backward compatibility only. Use EmailConfirmedAt or PhoneConfirmedAt instead.",
47
          "type": "string",
48
          "format": "date-time",
49
          "x-go-name": "ConfirmedAt"
50
        },
51
        "created_at": {
52
          "type": "string",
53
          "format": "date-time",
54
          "x-go-name": "CreatedAt"
55
        },
56
        "email": {
57
          "type": "string",
58
          "x-go-package": "github.com/netlify/gotrue/storage"
59
        },
60
        "email_change_sent_at": {
61
          "type": "string",
62
          "format": "date-time",
63
          "x-go-name": "EmailChangeSentAt"
64
        },
65
        "email_confirmed_at": {
66
          "type": "string",
67
          "format": "date-time",
68
          "x-go-name": "EmailConfirmedAt"
69
        },
70
        "id": {
71
          "type": "string",
72
          "format": "uuid",
73
          "x-go-name": "ID"
74
        },
75
        "identities": {
76
          "type": "array",
77
          "items": {
78
            "type": "object",
79
            "properties": {
80
              "created_at": {
81
                "type": "string",
82
                "format": "date-time",
83
                "x-go-name": "CreatedAt"
84
              },
85
              "id": {
86
                "type": "string",
87
                "x-go-name": "ID"
88
              },
89
              "identity_data": {
90
                "type": "object",
91
                "additionalProperties": {},
92
                "x-go-package": "github.com/netlify/gotrue/models"
93
              },
94
              "last_sign_in_at": {
95
                "type": "string",
96
                "format": "date-time",
97
                "x-go-name": "LastSignInAt"
98
              },
99
              "provider": {
100
                "type": "string",
101
                "x-go-name": "Provider"
102
              },
103
              "updated_at": {
104
                "type": "string",
105
                "format": "date-time",
106
                "x-go-name": "UpdatedAt"
107
              },
108
              "user_id": {
109
                "type": "string",
110
                "format": "uuid",
111
                "x-go-name": "UserID"
112
              }
113
            },
114
            "x-go-package": "github.com/netlify/gotrue/models"
115
          },
116
          "x-go-name": "Identities"
117
        },
118
        "invited_at": {
119
          "type": "string",
120
          "format": "date-time",
121
          "x-go-name": "InvitedAt"
122
        },
123
        "last_sign_in_at": {
124
          "type": "string",
125
          "format": "date-time",
126
          "x-go-name": "LastSignInAt"
127
        },
128
        "new_email": {
129
          "type": "string",
130
          "x-go-name": "EmailChange"
131
        },
132
        "new_phone": {
133
          "type": "string",
134
          "x-go-name": "PhoneChange"
135
        },
136
        "phone": {
137
          "type": "string",
138
          "x-go-package": "github.com/netlify/gotrue/storage"
139
        },
140
        "phone_change_sent_at": {
141
          "type": "string",
142
          "format": "date-time",
143
          "x-go-name": "PhoneChangeSentAt"
144
        },
145
        "phone_confirmed_at": {
146
          "type": "string",
147
          "format": "date-time",
148
          "x-go-name": "PhoneConfirmedAt"
149
        },
150
        "reauthentication_sent_at": {
151
          "type": "string",
152
          "format": "date-time",
153
          "x-go-name": "ReauthenticationSentAt"
154
        },
155
        "recovery_sent_at": {
156
          "type": "string",
157
          "format": "date-time",
158
          "x-go-name": "RecoverySentAt"
159
        },
160
        "role": {
161
          "type": "string",
162
          "x-go-name": "Role"
163
        },
164
        "updated_at": {
165
          "type": "string",
166
          "format": "date-time",
167
          "x-go-name": "UpdatedAt"
168
        },
169
        "user_metadata": {
170
          "type": "object",
171
          "additionalProperties": {},
172
          "x-go-package": "github.com/netlify/gotrue/models"
173
        }
174
      },
175
      "x-go-package": "github.com/netlify/gotrue/models"
176
    }
177
  },
178
  "x-go-package": "github.com/netlify/gotrue/api"
179
}

Get information for the logged-in user.

get/user

Response codes

Response (200)

1
{
2
  "app_metadata": {
3
    "property1": null,
4
    "property2": null
5
  },
6
  "aud": "lorem",
7
  "banned_until": "2021-12-31T23:34:00Z",
8
  "confirmation_sent_at": "2021-12-31T23:34:00Z",
9
  "confirmed_at": "2021-12-31T23:34:00Z",
10
  "created_at": "2021-12-31T23:34:00Z",
11
  "email": "lorem",
12
  "email_change_sent_at": "2021-12-31T23:34:00Z",
13
  "email_confirmed_at": "2021-12-31T23:34:00Z",
14
  "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
15
  "identities": [
16
    {
17
      "created_at": "2021-12-31T23:34:00Z",
18
      "id": "lorem",
19
      "identity_data": {
20
        "property1": null,
21
        "property2": null
22
      },
23
      "last_sign_in_at": "2021-12-31T23:34:00Z",
24
      "provider": "lorem",
25
      "updated_at": "2021-12-31T23:34:00Z",
26
      "user_id": "fbdf5a53-161e-4460-98ad-0e39408d8689"
27
    }
28
  ],
29
  "invited_at": "2021-12-31T23:34:00Z",
30
  "last_sign_in_at": "2021-12-31T23:34:00Z",
31
  "new_email": "lorem",
32
  "new_phone": "lorem",
33
  "phone": "lorem",
34
  "phone_change_sent_at": "2021-12-31T23:34:00Z",
35
  "phone_confirmed_at": "2021-12-31T23:34:00Z",
36
  "reauthentication_sent_at": "2021-12-31T23:34:00Z",
37
  "recovery_sent_at": "2021-12-31T23:34:00Z",
38
  "role": "lorem",
39
  "updated_at": "2021-12-31T23:34:00Z",
40
  "user_metadata": {
41
    "property1": null,
42
    "property2": null
43
  }
44
}

1
{
2
  "description": "User respresents a registered user with email/password authentication",
3
  "type": "object",
4
  "properties": {
5
    "app_metadata": {
6
      "type": "object",
7
      "additionalProperties": {},
8
      "x-go-package": "github.com/netlify/gotrue/models"
9
    },
10
    "aud": {
11
      "type": "string",
12
      "x-go-name": "Aud"
13
    },
14
    "banned_until": {
15
      "type": "string",
16
      "format": "date-time",
17
      "x-go-name": "BannedUntil"
18
    },
19
    "confirmation_sent_at": {
20
      "type": "string",
21
      "format": "date-time",
22
      "x-go-name": "ConfirmationSentAt"
23
    },
24
    "confirmed_at": {
25
      "description": "For backward compatibility only. Use EmailConfirmedAt or PhoneConfirmedAt instead.",
26
      "type": "string",
27
      "format": "date-time",
28
      "x-go-name": "ConfirmedAt"
29
    },
30
    "created_at": {
31
      "type": "string",
32
      "format": "date-time",
33
      "x-go-name": "CreatedAt"
34
    },
35
    "email": {
36
      "type": "string",
37
      "x-go-package": "github.com/netlify/gotrue/storage"
38
    },
39
    "email_change_sent_at": {
40
      "type": "string",
41
      "format": "date-time",
42
      "x-go-name": "EmailChangeSentAt"
43
    },
44
    "email_confirmed_at": {
45
      "type": "string",
46
      "format": "date-time",
47
      "x-go-name": "EmailConfirmedAt"
48
    },
49
    "id": {
50
      "type": "string",
51
      "format": "uuid",
52
      "x-go-name": "ID"
53
    },
54
    "identities": {
55
      "type": "array",
56
      "items": {
57
        "type": "object",
58
        "properties": {
59
          "created_at": {
60
            "type": "string",
61
            "format": "date-time",
62
            "x-go-name": "CreatedAt"
63
          },
64
          "id": {
65
            "type": "string",
66
            "x-go-name": "ID"
67
          },
68
          "identity_data": {
69
            "type": "object",
70
            "additionalProperties": {},
71
            "x-go-package": "github.com/netlify/gotrue/models"
72
          },
73
          "last_sign_in_at": {
74
            "type": "string",
75
            "format": "date-time",
76
            "x-go-name": "LastSignInAt"
77
          },
78
          "provider": {
79
            "type": "string",
80
            "x-go-name": "Provider"
81
          },
82
          "updated_at": {
83
            "type": "string",
84
            "format": "date-time",
85
            "x-go-name": "UpdatedAt"
86
          },
87
          "user_id": {
88
            "type": "string",
89
            "format": "uuid",
90
            "x-go-name": "UserID"
91
          }
92
        },
93
        "x-go-package": "github.com/netlify/gotrue/models"
94
      },
95
      "x-go-name": "Identities"
96
    },
97
    "invited_at": {
98
      "type": "string",
99
      "format": "date-time",
100
      "x-go-name": "InvitedAt"
101
    },
102
    "last_sign_in_at": {
103
      "type": "string",
104
      "format": "date-time",
105
      "x-go-name": "LastSignInAt"
106
    },
107
    "new_email": {
108
      "type": "string",
109
      "x-go-name": "EmailChange"
110
    },
111
    "new_phone": {
112
      "type": "string",
113
      "x-go-name": "PhoneChange"
114
    },
115
    "phone": {
116
      "type": "string",
117
      "x-go-package": "github.com/netlify/gotrue/storage"
118
    },
119
    "phone_change_sent_at": {
120
      "type": "string",
121
      "format": "date-time",
122
      "x-go-name": "PhoneChangeSentAt"
123
    },
124
    "phone_confirmed_at": {
125
      "type": "string",
126
      "format": "date-time",
127
      "x-go-name": "PhoneConfirmedAt"
128
    },
129
    "reauthentication_sent_at": {
130
      "type": "string",
131
      "format": "date-time",
132
      "x-go-name": "ReauthenticationSentAt"
133
    },
134
    "recovery_sent_at": {
135
      "type": "string",
136
      "format": "date-time",
137
      "x-go-name": "RecoverySentAt"
138
    },
139
    "role": {
140
      "type": "string",
141
      "x-go-name": "Role"
142
    },
143
    "updated_at": {
144
      "type": "string",
145
      "format": "date-time",
146
      "x-go-name": "UpdatedAt"
147
    },
148
    "user_metadata": {
149
      "type": "object",
150
      "additionalProperties": {},
151
      "x-go-package": "github.com/netlify/gotrue/models"
152
    }
153
  },
154
  "x-go-package": "github.com/netlify/gotrue/models"
155
}

Returns the updated user.

put/user

Body

app_metadata
Optional
object
data
Optional
object
email
Optional
string
nonce
Optional
string
password
Optional
string
phone
Optional
string

Response codes

Response (200)

1
{
2
  "app_metadata": {
3
    "property1": null,
4
    "property2": null
5
  },
6
  "aud": "lorem",
7
  "banned_until": "2021-12-31T23:34:00Z",
8
  "confirmation_sent_at": "2021-12-31T23:34:00Z",
9
  "confirmed_at": "2021-12-31T23:34:00Z",
10
  "created_at": "2021-12-31T23:34:00Z",
11
  "email": "lorem",
12
  "email_change_sent_at": "2021-12-31T23:34:00Z",
13
  "email_confirmed_at": "2021-12-31T23:34:00Z",
14
  "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
15
  "identities": [
16
    {
17
      "created_at": "2021-12-31T23:34:00Z",
18
      "id": "lorem",
19
      "identity_data": {
20
        "property1": null,
21
        "property2": null
22
      },
23
      "last_sign_in_at": "2021-12-31T23:34:00Z",
24
      "provider": "lorem",
25
      "updated_at": "2021-12-31T23:34:00Z",
26
      "user_id": "fbdf5a53-161e-4460-98ad-0e39408d8689"
27
    }
28
  ],
29
  "invited_at": "2021-12-31T23:34:00Z",
30
  "last_sign_in_at": "2021-12-31T23:34:00Z",
31
  "new_email": "lorem",
32
  "new_phone": "lorem",
33
  "phone": "lorem",
34
  "phone_change_sent_at": "2021-12-31T23:34:00Z",
35
  "phone_confirmed_at": "2021-12-31T23:34:00Z",
36
  "reauthentication_sent_at": "2021-12-31T23:34:00Z",
37
  "recovery_sent_at": "2021-12-31T23:34:00Z",
38
  "role": "lorem",
39
  "updated_at": "2021-12-31T23:34:00Z",
40
  "user_metadata": {
41
    "property1": null,
42
    "property2": null
43
  }
44
}

1
{
2
  "description": "User respresents a registered user with email/password authentication",
3
  "type": "object",
4
  "properties": {
5
    "app_metadata": {
6
      "type": "object",
7
      "additionalProperties": {},
8
      "x-go-package": "github.com/netlify/gotrue/models"
9
    },
10
    "aud": {
11
      "type": "string",
12
      "x-go-name": "Aud"
13
    },
14
    "banned_until": {
15
      "type": "string",
16
      "format": "date-time",
17
      "x-go-name": "BannedUntil"
18
    },
19
    "confirmation_sent_at": {
20
      "type": "string",
21
      "format": "date-time",
22
      "x-go-name": "ConfirmationSentAt"
23
    },
24
    "confirmed_at": {
25
      "description": "For backward compatibility only. Use EmailConfirmedAt or PhoneConfirmedAt instead.",
26
      "type": "string",
27
      "format": "date-time",
28
      "x-go-name": "ConfirmedAt"
29
    },
30
    "created_at": {
31
      "type": "string",
32
      "format": "date-time",
33
      "x-go-name": "CreatedAt"
34
    },
35
    "email": {
36
      "type": "string",
37
      "x-go-package": "github.com/netlify/gotrue/storage"
38
    },
39
    "email_change_sent_at": {
40
      "type": "string",
41
      "format": "date-time",
42
      "x-go-name": "EmailChangeSentAt"
43
    },
44
    "email_confirmed_at": {
45
      "type": "string",
46
      "format": "date-time",
47
      "x-go-name": "EmailConfirmedAt"
48
    },
49
    "id": {
50
      "type": "string",
51
      "format": "uuid",
52
      "x-go-name": "ID"
53
    },
54
    "identities": {
55
      "type": "array",
56
      "items": {
57
        "type": "object",
58
        "properties": {
59
          "created_at": {
60
            "type": "string",
61
            "format": "date-time",
62
            "x-go-name": "CreatedAt"
63
          },
64
          "id": {
65
            "type": "string",
66
            "x-go-name": "ID"
67
          },
68
          "identity_data": {
69
            "type": "object",
70
            "additionalProperties": {},
71
            "x-go-package": "github.com/netlify/gotrue/models"
72
          },
73
          "last_sign_in_at": {
74
            "type": "string",
75
            "format": "date-time",
76
            "x-go-name": "LastSignInAt"
77
          },
78
          "provider": {
79
            "type": "string",
80
            "x-go-name": "Provider"
81
          },
82
          "updated_at": {
83
            "type": "string",
84
            "format": "date-time",
85
            "x-go-name": "UpdatedAt"
86
          },
87
          "user_id": {
88
            "type": "string",
89
            "format": "uuid",
90
            "x-go-name": "UserID"
91
          }
92
        },
93
        "x-go-package": "github.com/netlify/gotrue/models"
94
      },
95
      "x-go-name": "Identities"
96
    },
97
    "invited_at": {
98
      "type": "string",
99
      "format": "date-time",
100
      "x-go-name": "InvitedAt"
101
    },
102
    "last_sign_in_at": {
103
      "type": "string",
104
      "format": "date-time",
105
      "x-go-name": "LastSignInAt"
106
    },
107
    "new_email": {
108
      "type": "string",
109
      "x-go-name": "EmailChange"
110
    },
111
    "new_phone": {
112
      "type": "string",
113
      "x-go-name": "PhoneChange"
114
    },
115
    "phone": {
116
      "type": "string",
117
      "x-go-package": "github.com/netlify/gotrue/storage"
118
    },
119
    "phone_change_sent_at": {
120
      "type": "string",
121
      "format": "date-time",
122
      "x-go-name": "PhoneChangeSentAt"
123
    },
124
    "phone_confirmed_at": {
125
      "type": "string",
126
      "format": "date-time",
127
      "x-go-name": "PhoneConfirmedAt"
128
    },
129
    "reauthentication_sent_at": {
130
      "type": "string",
131
      "format": "date-time",
132
      "x-go-name": "ReauthenticationSentAt"
133
    },
134
    "recovery_sent_at": {
135
      "type": "string",
136
      "format": "date-time",
137
      "x-go-name": "RecoverySentAt"
138
    },
139
    "role": {
140
      "type": "string",
141
      "x-go-name": "Role"
142
    },
143
    "updated_at": {
144
      "type": "string",
145
      "format": "date-time",
146
      "x-go-name": "UpdatedAt"
147
    },
148
    "user_metadata": {
149
      "type": "object",
150
      "additionalProperties": {},
151
      "x-go-package": "github.com/netlify/gotrue/models"
152
    }
153
  },
154
  "x-go-package": "github.com/netlify/gotrue/models"
155
}

Self-Hosting Auth

Client libraries

Additional links

Generates an email action link.

Body

Response codes

Response (200)

Get a user.

Path parameters

Response codes

Response (200)

Update a user.

Path parameters

Response codes

Response (200)

Deletes a user.

Path parameters

Response codes

Response (200)

List all users.

Response codes

Response (200)

Returns the created user.

Body

Response codes

Response (200)

Receives the redirect from an external provider during the OAuth authentication process. Starts the process of creating an access and refresh token.

Response codes

The healthcheck endpoint for gotrue. Returns the current gotrue version.

Response codes

Response (200)

Sends an invite link to the user.

Body

Response codes

Response (200)

Logs out the user.

Response codes

Response (204)

Passwordless sign-in method for email or phone.

Body

Response codes

Response (200)

Sends a password recovery email link to the user's email.

Body

Response codes

Response (200)

Returns the configuration settings for the gotrue server.

Response codes

Response (200)

Password-based signup with either email or phone.

Body

Response codes

Response (200)

Signs in a user with a password.

Body

Response codes

Response (200)

Refreshes a user's refresh token.

Body

Response codes

Response (200)

Get information for the logged-in user.

Response codes

Response (200)

Returns the updated user.

Body

Response codes

Response (200)

Verifies a sign up.

Body