OAuth client | PageSeeder User Guide

Key point: An external app using the PageSeeder API.

In OAuth terminology, a external app accessing the PageSeeder API using OAuth protocol is referred to as a client.

You can create and manage clients in the OAuth clients page. There is a limit to the number of clients that each account can be associated with.

The “client” always refers to a specific instance of an app and its name and ID are unique. As there might be multiple instances of the same app, PageSeeder also provides a field to save the name of the app as opposed to the instance.

For example, different instances might be used for different environments (‘production’ and ‘staging’), different grant types, different locations, different datasets, or different accounts.

Fields

Client ID – a unique immutable identifier for the client assigned when registering a client.
Client name – a unique name for the client app (required).
Description – an optional informational field to document the purpose of the app.
Website – the URL of the website if the app is a Web app. This is informational only to help administrators and developers identify and locate the app.
Redirect URI – the OAuth redirect URI required for the Authorization code grant type. PageSeeder uses this value in OAuth redirection.
Requires consent – Whether the client requires user consent (current always “No”).
Confidential – Whether the client is capable of maintaining confidentiality of credentials.
Member – the member associated with this client.
Access token max age – how long an access token is valid for.
Refresh token max age – how long a refresh token is valid for (if the selected grant type supports refresh tokens).
Webhook secret – secret shared between PageSeeder and the app to verify the authenticity of Webhook posts (optional).
Grant type – the OAuth grant type that the client is allowed to use. This defines the way the app can get access tokens.
Scope – the scope values that the client is allowed to request.
App name – the generic name for the app (useful to group/distinguish apps that might have multiple instances).
Secret – the OAuth 2.0 secret used by the client to authenticate itself with PageSeeder.

For security reasons, you only select one grant type per client. If your app requires a different grant type, register it using multiple clients.

For developers

The PageSeeder API includes several services to manage clients.

You also need to define your app as a client to use CORS, Webhooks or Single-Sign On (SSO).