You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/backend/types/auth-object.mdx
+39-32Lines changed: 39 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,38 +19,45 @@ The `Auth` object contains important information like the current user's session
19
19
## Session properties
20
20
21
21
<Properties>
22
-
-`sessionId`
23
-
-`string`
22
+
-`actor`
23
+
-`ActClaim | undefined`
24
24
25
-
The ID of the current session.
25
+
Holds identifier for the user that is impersonating the current user. Read more about [impersonation](/docs/guides/users/impersonation).
26
26
27
27
---
28
28
29
-
-`userId`
30
-
-`string`
29
+
-`debug`
30
+
-`AuthObjectDebug`
31
31
32
-
The ID of the current user.
32
+
Used to help debug issues when using Clerk in development.
33
33
34
34
---
35
35
36
-
-`orgId`
37
-
-`string | undefined`
36
+
-`factorVerificationAge`
37
+
-`[number, number] | null`
38
38
39
-
The ID of the user's [active organization](!active-organization).
39
+
An array where each item represents the number of minutes since the last verification of a first or second factor: `[firstFactorAge, secondFactorAge]`.
The current user's role in their [active organization](!active-organization).
46
+
A function that gets the current user's [session token](/docs/guides/sessions/session-tokens) or a [custom JWT template](/docs/guides/sessions/jwt-templates).
A function that checks if the user has an organization role or custom permission.
88
+
The current user's [session claims](/docs/guides/sessions/session-tokens).
82
89
83
90
---
84
91
85
-
-`factorVerificationAge`
86
-
-`[number, number] | null`
92
+
-`sessionStatus`
93
+
-`'active' | 'pending'`
87
94
88
-
An array where each item represents the number of minutes since the last verification of a first or second factor: `[firstFactorAge, secondFactorAge]`.
95
+
The current state of the session.
89
96
90
97
---
91
98
92
-
-[`getToken()`](#get-token)
93
-
-`ServerGetToken`
99
+
-`sessionId`
100
+
-`string`
94
101
95
-
A function that gets the current user's [session token](/docs/guides/sessions/session-tokens) or a [custom JWT template](/docs/guides/sessions/jwt-templates).
102
+
The ID of the current session.
96
103
97
104
---
98
105
@@ -103,10 +110,10 @@ The `Auth` object contains important information like the current user's session
103
110
104
111
---
105
112
106
-
-`debug`
107
-
-`AuthObjectDebug`
113
+
-`userId`
114
+
-`string`
108
115
109
-
Used to help debug issues when using Clerk in development.
0 commit comments