Getting Started
Documentation
Authentication
How to retrieve access tokens to get access to the API
Introduction
Squidex uses OpenID Connect and OAuth2.0 as authentication protocols. Both are state of the art specifications and adopted by a lot of internet services. You have already used it when you logged in with your Google account to a third-party website.
Basic authentication flow
Lets talk about the general authentication flow first.
1. Generate Clients
Before you get an access token you have to create a client first. A client is just another name for an application and could be a mobile app, a public website, single page application or a backend server.
If you create a new app, it has already a default client.
Create a new client
Each client has also a role assigned to define which updates or queries can be performance with the client. This is particularly useful when your client is a public application that can easily be reversed engineer like a mobile app or single page application. You can store your client credentials (client id and client secret) in the application but you have to ensure, that you give your client only the necessary permissions and not more.
Read more about permissions:
2. Request a token
The client id and secret cannot be used directly in the API calls. You have to make an additional request to identity-server first to get an access token. This token is then valid for 30 days.
post
https://cloud.squidex.io/identity-server/connect/token
Get access token
Or just make a request with curl:
1
curl
2
-X POST 'https://cloud.squidex.io/identity-server/connect/token'
3
-H 'Content-Type: application/x-www-form-urlencoded'
4
-d 'grant_type=client_credentials&
5
client_id=<YOUR_CLIENT_ID>&
6
client_secret=<YOUR_CLIENT_SECRET>&
7
scope=squidex-api
Copied!
3. Use the token
Add the returned token to all consecutive requests:
1
Authorization: Bearer <YOUR_ACCESS_TOKEN>
Copied!
How to deal with the access token
An often asked question is how to deal with the access token, because there are a few challenges:
- 1.The token is only valid for 30 days.
- 2.The token might expire sooner, for example when a certificate is replaced on the server.
- 3.You need an additional request to get the token.
Our recommendation is to use the following pattern (pseudo code):
1
function makeRequest(url, body) {
2
const token = getTokenFromCache();
3
4
if (!token) {
5
token = getToken(clientId, clientSecret);
6
7
storeTokenInCache(token, days: 30);
8
}
9
10
const response = makeRequestToSquidex(url, body);
11
12
// Token has probably expired.
13
if (response.status == 401) {
14
// Request the token again.
15
token = getToken(clientId, clientSecret);
16
17
storeTokenInCache(token, days: 30);
18
19
// Try the request again.
20
response = makeRequestToSquidex(url, body);
21
}
22
23
// You can still have a 401 here, but this very likely not an epxired token then.
24
return response;
25
}
Copied!
As you can see, we use a simple memory cache to keep our token. We request a new token when it has been expired in the cache or on the server and before the first request after our application started.
You can also request multiple tokens in parallel, for example when you have a cluster of servers. There is no need to sync the access tokens between your servers or to keep them in a centralized cache.
Last modified 3mo ago