align text

clerk · Dec 18, 2024 · b0a6c9a · b0a6c9a
1 parent 872d48e
commit b0a6c9a
Show file tree

Hide file tree

Showing 31 changed files with 42 additions and 42 deletions.
diff --git a/docs/references/astro/auth-store.mdx b/docs/references/astro/auth-store.mdx
@@ -11,35 +11,35 @@ The `$authStore` store provides a convenient way to access the current auth stat
   - `userId`
   - `string`
 
-  The current user's ID.
+  The unique identifier of the current user.
 
   ---
 
   - `sessionId`
   - `string`
 
-  The current user's session ID.
+  The unique identifier of the current session.
 
   ---
 
   - `orgId`
   - `string`
 
-  The current user's active organization ID.
+  The unique identifier of the user's active organization.
 
   ---
 
   - `orgRole`
   - `string`
 
-  The current user's active organization role.
+  The current user's role in their active organization.
 
   ---
 
   - `orgSlug`
   - `string`
 
-  The current user's active organization slug.
+  The URL-friendly identifier of the user's active organization.
 </Properties>
 
 ## How to use the `$authStore` store

diff --git a/docs/references/backend/email-addresses/create-email-address.mdx b/docs/references/backend/email-addresses/create-email-address.mdx
@@ -17,7 +17,7 @@ function createEmailAddress(params: CreateEmailAddressParams): Promise<EmailAddr
   - `userId`
   - `string`
 
-  The ID of the user to create the email address for.
+  The unique identifier of the user to create the email address for.
 
   ---
 

diff --git a/docs/references/backend/organization/create-organization-membership.mdx b/docs/references/backend/organization/create-organization-membership.mdx
@@ -26,7 +26,7 @@ function createOrganizationMembership(
   - `userId`
   - `string`
 
-  The user ID of the user being added to the organization.
+  The unique identifier of the user to be added to the organization.
 
   ---
 

diff --git a/docs/references/backend/organization/delete-organization-membership.mdx b/docs/references/backend/organization/delete-organization-membership.mdx
@@ -26,7 +26,7 @@ function getOrganizationList(
   - `userId`
   - `string`
 
-  The user ID to remove from the organization.
+  The unique identifier of the user to be removed from the organization.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/organization/update-organization-membership-metadata.mdx b/docs/references/backend/organization/update-organization-membership-metadata.mdx
@@ -26,7 +26,7 @@ function updateOrganizationMembershipMetadata(
   - `userId`
   - `string`
 
-  The ID of the user that this membership belongs to.
+  The unique identifier of the user that this membership belongs to.
 
   ---
 

diff --git a/docs/references/backend/organization/update-organization-membership.mdx b/docs/references/backend/organization/update-organization-membership.mdx
@@ -26,7 +26,7 @@ function updateOrganizationMembership(
   - `userId`
   - `string`
 
-  The ID of the user.
+  The unique identifier of the user to update.
 
   ---
 

diff --git a/docs/references/backend/phone-numbers/create-phone-number.mdx b/docs/references/backend/phone-numbers/create-phone-number.mdx
@@ -17,7 +17,7 @@ function createPhoneNumber(params: CreatePhoneNumberParams): Promise<PhoneNumber
   - `userId`
   - `string`
 
-  The ID of the user to create the phone number for.
+  The unique identifier of the user to create the phone number for.
 
   ---
 

diff --git a/docs/references/backend/sessions/get-session.mdx b/docs/references/backend/sessions/get-session.mdx
@@ -17,7 +17,7 @@ function getSession(sessionId: string): Promise<Session>
   - `sessionId`
   - `string`
 
-  The ID of the session to retrieve.
+  The unique identifier of the session to retrieve.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/sessions/get-token.mdx b/docs/references/backend/sessions/get-token.mdx
@@ -17,7 +17,7 @@ function getToken(sessionId: string, template: string): Promise<Token>
   - `sessionId`
   - `string`
 
-  The ID of the session to retrieve a token for.
+  The unique identifier of the session to retrieve a token for.
 
   ---
 

diff --git a/docs/references/backend/sessions/revoke-session.mdx b/docs/references/backend/sessions/revoke-session.mdx
@@ -19,7 +19,7 @@ function revokeSession(sessionId: string): Promise<Session>
   - `sessionId`
   - `string`
 
-  The ID of the session to revoke.
+  The unique identifier of the session to revoke.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/sessions/verify-session.mdx b/docs/references/backend/sessions/verify-session.mdx
@@ -27,7 +27,7 @@ const session = await clerkClient.sessions.verifySession(sessionId, token)
   - `sessionId`
   - `string`
 
-  The ID of the session to verify.
+  The unique identifier of the session to verify.
 
   ---
 

diff --git a/docs/references/backend/sign-in-tokens/create-sign-in-token.mdx b/docs/references/backend/sign-in-tokens/create-sign-in-token.mdx
@@ -15,7 +15,7 @@ function createSignInToken(params: CreateSignInTokensParams): Promise<SignInToke
   - `userId`
   - `string`
 
-  The ID of the user that can use the newly created sign in token
+  The unique identifier of the user who can use the newly created sign-in token.
 
   ---
 

diff --git a/docs/references/backend/types/backend-organization-membership.mdx b/docs/references/backend/types/backend-organization-membership.mdx
@@ -104,5 +104,5 @@ The Backend `OrganizationMembership` object is similar to the [`OrganizationMemb
   - `userId`
   - `string`
 
-  The ID of the user that this public data belongs to.
+  The unique identifier of the user that this public data belongs to.
 </Properties>
diff --git a/docs/references/backend/types/backend-session.mdx b/docs/references/backend/types/backend-session.mdx
@@ -25,7 +25,7 @@ The Backend `Session` object is similar to the [`Session`](/docs/references/java
   - `userId`
   - `string`
 
-  The ID of the user associated with the `Session`.
+  The unique identifier of the current user associated with the `Session`.
 
   ---
 

diff --git a/docs/references/backend/user/ban-user.mdx b/docs/references/backend/user/ban-user.mdx
@@ -17,7 +17,7 @@ function banUser(userId: string): Promise<User>
   - `userId`
   - `string`
 
-  The ID of the user to ban.
+  The unique identifier of the user to ban.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/user/delete-user.mdx b/docs/references/backend/user/delete-user.mdx
@@ -17,7 +17,7 @@ function deleteUser(userId: string): Promise<User>
   - `userId`
   - `string`
 
-  The ID of the user to delete.
+  The unique identifier of the user to delete.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/user/disable-user-mfa.mdx b/docs/references/backend/user/disable-user-mfa.mdx
@@ -17,7 +17,7 @@ function disableUserMFA(userId: string): Promise<User>
   - `userId`
   - `string`
 
-  The ID of the user to disable MFA for.
+  The unique identifier of the user to disable MFA for.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/user/get-organization-membership-list.mdx b/docs/references/backend/user/get-organization-membership-list.mdx
@@ -19,7 +19,7 @@ function getOrganizationMembershipList(
   - `userId`
   - `string`
 
-  The ID of the user to retrieve the list of organization memberships for.
+  The unique identifier of the user to retrieve the list of organization memberships for.
 
   ---
 

diff --git a/docs/references/backend/user/get-user-oauth-access-token.mdx b/docs/references/backend/user/get-user-oauth-access-token.mdx
@@ -20,7 +20,7 @@ function getUserOauthAccessToken(
   - `userId`
   - `string`
 
-  The ID of the user to retrieve.
+  The unique identifier of the user to retrieve.
 
   ---
 

diff --git a/docs/references/backend/user/get-user.mdx b/docs/references/backend/user/get-user.mdx
@@ -17,7 +17,7 @@ function getUser(userId: string): Promise<User>
   - `userId`
   - `string`
 
-  The ID of the user to retrieve.
+  The unique identifier of the user to retrieve.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/user/lock-user.mdx b/docs/references/backend/user/lock-user.mdx
@@ -19,7 +19,7 @@ function lockUser(userId: string): Promise<User>
   - `userId`
   - `string`
 
-  The ID of the user to lockout.
+  The unique identifier of the user to lockout.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/user/unban-user.mdx b/docs/references/backend/user/unban-user.mdx
@@ -17,7 +17,7 @@ function unbanUser(userId: string): Promise<User>
   - `userId`
   - `string`
 
-  The ID of the user to unban.
+  The unique identifier of the user to unban.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/user/unlock-user.mdx b/docs/references/backend/user/unlock-user.mdx
@@ -17,7 +17,7 @@ function unlockUser(userId: string): Promise<User>
   - `userId`
   - `string`
 
-  The ID of the user to unlock.
+  The unique identifier of the user to unlock.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/user/update-user-metadata.mdx b/docs/references/backend/user/update-user-metadata.mdx
@@ -19,7 +19,7 @@ function updateUserMetadata(userId: string, params: UpdateUserMetadataParams): P
   - `userId`
   - `string`
 
-  The ID of the organization to update.
+  The unique identifier of the user to update.
 
   ---
 

diff --git a/docs/references/backend/user/update-user.mdx b/docs/references/backend/user/update-user.mdx
@@ -17,7 +17,7 @@ function updateUser(userId: string, params: UpdateUserParams): Promise<User>
   - `userId`
   - `string`
 
-  The ID of the user to update.
+  The unique identifier of the user to update.
 
   ---
 

diff --git a/docs/references/backend/user/verify-password.mdx b/docs/references/backend/user/verify-password.mdx
@@ -17,7 +17,7 @@ function verifyPassword(params: VerifyPasswordParams): Promise<{ verified: true
   - `userId`
   - `string`
 
-  The ID of the user to verify the password for.
+  The unique identifier of the user to verify the password for.
 
   ---
 

diff --git a/docs/references/backend/user/verify-totp.mdx b/docs/references/backend/user/verify-totp.mdx
@@ -17,7 +17,7 @@ function verifyTOTP(params: VerifyTOTPParams): Promise<{ verified: true; code_ty
   - `userId`
   - `string`
 
-  The ID of the user to verify the TOTP for.
+  The unique identifier of the user to verify the TOTP for.
 
   ---
 

diff --git a/docs/references/javascript/organization/members.mdx b/docs/references/javascript/organization/members.mdx
@@ -69,7 +69,7 @@ function addMember(params: AddMemberParams): Promise<OrganizationMembership>
   - `userId`
   - `string`
 
-  The ID of the user that will be added as a member to the organization.
+  The unique identifier of the user to be added as a member to the organization.
 
   ---
 
@@ -99,7 +99,7 @@ function updateMember(params: UpdateMembershipParams): Promise<OrganizationMembe
   - `userId`
   - `string`
 
-  The user identifier.
+  The unique identifier of the user to update.
 
   ---
 
@@ -129,7 +129,7 @@ function removeMember(userId: string): Promise<OrganizationMembership>
   - `userId`
   - `string`
 
-  The user identifier.
+  The unique identifier of the user to remove from the organization.
 </Properties>
 
 ### Returns

diff --git a/docs/references/nextjs/auth-object.mdx b/docs/references/nextjs/auth-object.mdx
@@ -11,35 +11,35 @@ The `Auth` object contains important information like the current user's session
   - `sessionId`
   - `string`
 
-  The current user's session ID.
+  The unique identifier of the current session.
 
   ---
 
   - `userId`
   - `string`
 
-  The current user's unique identifier.
+  The unique identifier of the current user.
 
   ---
 
   - `orgId`
   - `string | undefined`
 
-  The current user's active organization ID.
+  The unique identifier of the user's active organization.
 
   ---
 
   - `orgRole`
   - <code>[OrganizationCustomRoleKey](#organization-custom-role-key) | undefined</code>
 
-  The current user's active organization role.
+  The current user's role in their active organization.
 
   ---
 
   - `orgSlug`
   - `string |undefined`
 
-  The current user's active organization slug.
+  The URL-friendly identifier of the user's active organization.
 
   ---
 

diff --git a/docs/references/react/use-auth.mdx b/docs/references/react/use-auth.mdx
@@ -25,7 +25,7 @@ The `useAuth()` hook provides access to the current user's authentication state
   - `userId`
   - `string`
 
-  The unique identifier for the current user.
+  The unique identifier of the current user.
 
   ---
 
@@ -39,7 +39,7 @@ The `useAuth()` hook provides access to the current user's authentication state
   - `orgId`
   - `string`
 
-  The unique identifier for the user's active organization.
+  The unique identifier of the user's active organization.
 
   ---
 

diff --git a/docs/references/react/use-user.mdx b/docs/references/react/use-user.mdx
@@ -23,7 +23,7 @@ The `useUser()` hook provides access to the current user's [`User`](/docs/refere
   ---
 
   - `user`
-  - <code>[User](/docs/references/javascript/user/user) \| null</code>
+  - <code>[User](/docs/references/javascript/user/user) | null</code>
 
   The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 </Properties>