[JS SDK] : Auth info update (#1025)

surrealdb · Nov 21, 2024 · 720bfda · 720bfda
1 parent a5443f5
commit 720bfda
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 7 deletions.
diff --git a/src/content/doc-sdk-javascript/core/handling-authentication.mdx b/src/content/doc-sdk-javascript/core/handling-authentication.mdx
@@ -131,13 +131,22 @@ async db.signup({`{ namespace, database, [ scope | access ], [...] }`})
         </tr>
         <tr>
             <td colspan="2" scope="row" data-label="Arguments">
-                <code>access</code>
+                <code>access  </code>
                 <Label label="required" />
             </td>
             <td colspan="2" scope="row" data-label="Description">
                 The access to sign up to. Also pass any variables used in the access under the `variables` key. Only supported from SurrealDB 2.x onwards
             </td>
         </tr>
+        <tr>
+            <td colspan="2" scope="row" data-label="Arguments">
+                <code>variables</code>
+                <Label label="optional" />
+            </td>
+            <td colspan="2" scope="row" data-label="Description">
+                The variables to pass to the access definition
+            </td>
+        </tr>
     </tbody>
 </table>
 
@@ -475,4 +484,4 @@ await db.authenticate('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJTdXJyZWFs
 
 ## Learn more
 
-Learn more about authentication in SurrealDB in our [security best practices](/docs/surrealdb/reference-guide/security-best-practices#authentication) documentation and in the [security](/docs/surrealdb/security/authentication#expiration) section of the SurrealDB documentation.
+Learn more about authentication in SurrealDB in our [security best practices](/docs/surrealdb/reference-guide/security-best-practices#authentication) documentation and in the [security](/docs/surrealdb/security/authentication#expiration) section of the SurrealDB documentation.  
diff --git a/src/content/doc-sdk-javascript/methods/signin.mdx b/src/content/doc-sdk-javascript/methods/signin.mdx
@@ -109,9 +109,9 @@ const token = await db.signin({
 const token = await db.signin({
 	namespace: 'surrealdb',
 	database: 'docs',
-	scope: 'user',
+	access: 'user',
 
-    // Also pass any properties required by the scope definition
+    // Also pass any properties required by the access definition
 	variables: {
     	email: 'info@surrealdb.com',
     	pass: '123456',
@@ -130,4 +130,4 @@ const token = await db.signin({
 });
 ```
 
-You can invalidate the authentication for the current connection using the [`invalidate()` method](/docs/sdk/javascript/methods/invalidate).
+You can invalidate the authentication for the current connection using the [`invalidate()` method](/docs/sdk/javascript/methods/invalidate). Learn more about [handling authentication](/docs/sdk/javascript/core/handling-authentication).  
diff --git a/src/content/doc-sdk-javascript/methods/signup.mdx b/src/content/doc-sdk-javascript/methods/signup.mdx
@@ -72,7 +72,7 @@ async db.signup({`{ namespace, database, [ scope | access ], [...] }`})
 const token = await db.signup({
 	namespace: 'surrealdb',
 	database: 'docs',
-	scope: 'user',
+	access: 'user',
 
     // Also pass any properties required by the scope definition
 	variables: {
@@ -93,4 +93,4 @@ const token = await db.signup({
 });
 ```
 
-You can invalidate the authentication for the current connection using the [`invalidate()` method](/docs/sdk/javascript/methods/invalidate).
+You can invalidate the authentication for the current connection using the [`invalidate()` method](/docs/sdk/javascript/methods/invalidate). Learn more about [handling authentication](/docs/sdk/javascript/core/handling-authentication).