Skip to content

Commit 3f950c4

Browse files
authored
Add missing sessionStatus claim to Auth object properties (#2670)
1 parent 3572619 commit 3f950c4

File tree

1 file changed

+39
-32
lines changed

1 file changed

+39
-32
lines changed

docs/reference/backend/types/auth-object.mdx

Lines changed: 39 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -19,38 +19,45 @@ The `Auth` object contains important information like the current user's session
1919
## Session properties
2020

2121
<Properties>
22-
- `sessionId`
23-
- `string`
22+
- `actor`
23+
- `ActClaim | undefined`
2424

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).
2626

2727
---
2828

29-
- `userId`
30-
- `string`
29+
- `debug`
30+
- `AuthObjectDebug`
3131

32-
The ID of the current user.
32+
Used to help debug issues when using Clerk in development.
3333

3434
---
3535

36-
- `orgId`
37-
- `string | undefined`
36+
- `factorVerificationAge`
37+
- `[number, number] | null`
3838

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]`.
4040

4141
---
4242

43-
- `orgRole`
44-
- <code>[OrganizationCustomRoleKey](/docs/reference/javascript/types/organization-custom-role-key) | undefined</code>
43+
- [`getToken()`](#get-token)
44+
- `ServerGetToken`
4545

46-
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).
4747

4848
---
4949

50-
- `orgSlug`
50+
- [`has()`](#has)
51+
- <code>(isAuthorizedParams: [CheckAuthorizationParamsWithCustomPermissions](#check-authorization-params-with-custom-permissions)) => boolean</code>
52+
53+
A function that checks if the user has an organization role or custom permission.
54+
55+
---
56+
57+
- `orgId`
5158
- `string | undefined`
5259

53-
The URL-friendly identifier of the user's [active organization](!active-organization).
60+
The ID of the user's [active organization](!active-organization).
5461

5562
---
5663

@@ -61,38 +68,38 @@ The `Auth` object contains important information like the current user's session
6168

6269
---
6370

64-
- `sessionClaims`
65-
- `JwtPayload`
71+
- `orgRole`
72+
- <code>[OrganizationCustomRoleKey](/docs/reference/javascript/types/organization-custom-role-key) | undefined</code>
6673

67-
The current user's [session claims](/docs/guides/sessions/session-tokens).
74+
The current user's role in their [active organization](!active-organization).
6875

6976
---
7077

71-
- `actor`
72-
- `ActClaim | undefined`
78+
- `orgSlug`
79+
- `string | undefined`
7380

74-
Holds identifier for the user that is impersonating the current user. Read more about [impersonation](/docs/guides/users/impersonation).
81+
The URL-friendly identifier of the user's [active organization](!active-organization).
7582

7683
---
7784

78-
- [`has()`](#has)
79-
- <code>(isAuthorizedParams: [CheckAuthorizationParamsWithCustomPermissions](#check-authorization-params-with-custom-permissions)) => boolean</code>
85+
- `sessionClaims`
86+
- `JwtPayload`
8087

81-
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).
8289

8390
---
8491

85-
- `factorVerificationAge`
86-
- `[number, number] | null`
92+
- `sessionStatus`
93+
- `'active' | 'pending'`
8794

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.
8996

9097
---
9198

92-
- [`getToken()`](#get-token)
93-
- `ServerGetToken`
99+
- `sessionId`
100+
- `string`
94101

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.
96103

97104
---
98105

@@ -103,10 +110,10 @@ The `Auth` object contains important information like the current user's session
103110

104111
---
105112

106-
- `debug`
107-
- `AuthObjectDebug`
113+
- `userId`
114+
- `string`
108115

109-
Used to help debug issues when using Clerk in development.
116+
The ID of the current user.
110117
</Properties>
111118

112119
### `has()`

0 commit comments

Comments
 (0)