OAuth clients

This page registers a program that lets people sign in with their platform account, such as a website or mobile app your organization built. One program uses one OAuth client.

Your role needs Can create credential, Can edit credential or Can delete credential, depending on the task.

An App installed from the Apps page already has its own OAuth client, and it is not shown on this page (Apps and Marketplace). A client a user made in the Account App is not shown here either.

Add a clientCopy Anchor Link

First ask the developer for two things: whether the program is a web or a mobile app, and the address people must return to after they sign in.

1. Open OAuth clients and press Add client.
2. Fill in Name. People see this name on the sign-in page. You can also add a logo.
3. Under Scopes, tick what the program may ask for (Scopes).
4. Choose a Type and fill in the list that appears (Type).
5. Press Save.
6. Copy the Client ID and Secret and send them to the developer (Client ID and secret).

Client ID and secretCopy Anchor Link

After you save, the Client ID and Secret appear under Details. The platform makes both. You cannot set them yourself.

• Press the copy icon at the end of the box to copy the value.
• If the secret leaks, press the refresh icon at the end of the Secret box, then press Reset. The old secret stops working at once, so send the new secret to every program that uses this client.

People without Can edit credential do not see the secret.

ScopesCopy Anchor Link

The scopes are the same as for an API key, with two more: Read basic user profile lets the program read a user's basic profile, and Manage basic user profile lets it change it too.

TypeCopy Anchor Link

Type a value under Add item and press Enter. You can add several. If the address the program asks to return to does not start with one of the values in the list, the platform does not let the person sign in. The Origins box of Web has no effect in this Release.

Trusted clientCopy Anchor Link

If Trusted client is off, the Choose an account page tells the person "If you continue," then the platform name, then "will share your name, email and profile picture with", followed by the client's name. If it is on, this message does not appear. Either way, the person does not have to press anything more to allow it.

LogoCopy Anchor Link

Press Choose picture under Logo at the top of the form and choose an image file. The sign-in page shows this client's logo and name above the form, so people know which app they are signing in to. The platform's own logo is set on the Sign-in page. To remove the image, press Remove picture.

Extended propertiesCopy Anchor Link

The Extended properties box adjusts how sign-in works for this client only. Edit it as JSON (JSON editor).

{
  "forgotPassword": { "enabled": true },
  "idleDetection": { "cookieExpires": "session" }
}

Edit or delete a clientCopy Anchor Link

Find the client in the Search clients box and press Edit or Delete in its row. If you delete, press Delete again in the confirmation box.