Skip to content

Commit 5420d14

Browse files
Small change to auth docs (#3329)
# Description of Changes Minor docs change # API and ABI breaking changes None # Expected complexity level and risk 1 # Testing None, trivial change
1 parent bc43362 commit 5420d14

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

docs/docs/spacetimeauth/index.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@
55
SpacetimeAuth is a service for managing authentication for your SpacetimeDB
66
applications. This allows you to authenticate users without needing
77
an external authentication service or even a hosting server.
8-
SpacetimeAuth is an OpenID Connect (OIDC) provider, which means it can be used with
8+
SpacetimeAuth is an [OpenID Connect (OIDC)](https://openid.net/developers/how-connect-works/) provider, which means it can be used with
99
any OIDC-compatible client library.
1010

1111
At the end of the authentication flow, your application receives an ID token
12-
containing identity claims (such as email, username, and roles). This token can
13-
then be used with any SpacetimeDB SDK to authenticate and authorize users.
12+
containing identity claims (such as email, username, and roles). Your
13+
application can then use this token with any SpacetimeDB SDK to authenticate and
14+
authorize users with the SpacetimeDB server.
1415

1516
## Features
1617

@@ -72,15 +73,21 @@ more roles assigned to them.
7273

7374
> ⚠️ Clients must not be confused with Users.
7475
75-
Clients (from OpenID Connect) are the applications that will be using
76-
SpacetimeAuth for authentication. Each client is associated with a single
77-
project and has its own client ID and client secret.
76+
Clients, also known as Relying Parties in OpenID Connect terminology, are the
77+
applications that are relying on SpacetimeAuth for authentication. Each client
78+
is associated with a single project and has its own client ID and client
79+
secret.
80+
81+
Clients are applications that request an OpenID Connect ID token from
82+
SpacetimeAuth, which can then be used to authenticate with the SpacetimeDB
83+
server.
7884

7985
### Roles
8086

8187
Roles are used to manage access control within your application. Each role is
8288
represented by a string (e.g. "admin", "user") that can be assigned to one or
8389
more users.
90+
8491
Roles are included as claims in the ID token that is issued to the user upon
8592
authentication.
8693

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
},
1919
"scripts": {
2020
"build": "tsc --project ./tsconfig.build.json && pnpm fix-markdown && prettier --write docs/nav.js",
21-
"fix-markdown": "scripts/markdown-fix.mjs docs/cli-reference.md",
21+
"fix-markdown": "node scripts/markdown-fix.mjs docs/cli-reference.md",
2222
"format": "pnpm fix-markdown && prettier . --write --ignore-path .prettierignore",
2323
"lint": "eslint . && prettier . --check --ignore-path .prettierignore",
2424
"check-links": "tsx scripts/checkLinks.ts"

0 commit comments

Comments
 (0)