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/topics/authorization.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -129,6 +129,33 @@ It may also be used in the future as a foundation for a new Application Service
129
129
This works by presenting the client credentials to get back an access token.
130
130
The simplest type of client credentials is a client ID and client secret pair, but MAS also supports client authentication with a JWT ([RFC 7523]), which is a robust way to authenticate clients without a shared secret.
131
131
132
+
## Personal sessions (personal access tokens)
133
+
134
+
Personal access tokens are a credential that can be issued to give access to a user,
135
+
with predefined scopes and a predefined expiry time.
136
+
Either before or after expiry, the owner of the token can regenerate it, which produces a new
137
+
access token with the same scopes but a new expiry time.
138
+
139
+
Personal access tokens are intended to fulfill two basic use cases:
140
+
141
+
1. an easy way to obtain a clean token for your own user, for use in automation and scripts;
142
+
2. a way to obtain a token for administrative access of another user, either for ad-hoc administrative operations or to set up a bot or similar service.
143
+
144
+
In the future, users will be able to create their own personal access tokens, but this is currently not implemented
145
+
so (1) is currently not supported.
146
+
147
+
For now, personal access tokens must be created, regenerated and revoked by administrators through the [Admin API], satisfying use case (2).
148
+
[Element Admin](https://github.com/element-hq/element-admin), available by default in Element Server Suite, can be used to do this interactively.
149
+
You can also use the online beta deployment at [admin-beta.element.dev](https://admin-beta.element.dev/). <!--- TODO stable deployment -->
150
+
151
+
### Validity
152
+
153
+
Personal sessions can be used so long as:
154
+
155
+
- the owner (creator) of the token is still an active and unlocked user (or static OAuth 2 client); and
156
+
- the actor (target user, or user being controlled by the token) has not been deactivated. Though the actor is allowed to be locked.
0 commit comments