Manage OAuth Clients

OAuth Clients enable external applications to authenticate with Relayter and request access to team data on behalf of users or service accounts. Each client is identified by a unique Client ID and protected by a Client Secret.

Create an OAuth client

1. Go to Settings → Connections and Authentication → OAuth Clients.
2. Click Add OAuth client.
3. Fill in the client details:
   • Name — A name for your OAuth client (required)
   • Grant types — Select one or more grant types that this client will use to obtain access tokens (required)
   • Scopes — Select which team permissions this client can access (optional)
4. Click Save.

Your new OAuth client is created. You'll receive a Client ID and Client Secret — keep the secret secure and do not share it.

Understand grant types

OAuth clients in Relayter support the following grant types for obtaining access tokens:

• Authorization Code — For web applications that redirect users to authorize the client
• Client Credentials — For server-to-server applications using the client ID and secret directly
• Password — For trusted applications that directly collect user credentials
• Device Code — For devices that cannot easily display a browser (like IoT devices)
• Refresh Token — For refreshing an existing access token without requiring the original grant flow

You must select at least one grant type when creating a client. You can select multiple grant types if your application needs them.

Configure OAuth scopes

Scopes determine which team permissions an OAuth client can access. When you configure scopes:

1. Go to Settings → Connections and Authentication → OAuth Clients.
2. Click the OAuth client name to view its details.
3. Click Edit.
4. In the Scopes section, select which team permissions this client should have access to.
5. Click Save.

The scopes you select limit what data and actions the OAuth client can perform. If you don't select any scopes, the client has no permissions. Your team's permission structure is defined by your team roles and custom permissions.

View OAuth client details

1. Go to Settings → Connections and Authentication → OAuth Clients.
2. Click the OAuth client name to view its details.

You'll see:

• Name — The client name
• Grant types — The grant types this client can use
• Client ID — The unique identifier for this client (click to reveal or copy)
• Client Secret — The client's secret key (click to reveal or copy; treat this as a password)

Edit an OAuth client

1. Go to Settings → Connections and Authentication → OAuth Clients.
2. Click the OAuth client name to view its details.
3. Click Edit.
4. Update the client:
   • Name — Rename the client
   • Grant types — Add or remove grant types
   • Scopes — Add or remove permissions
5. Click Save.

Your changes take effect immediately. Any applications using this client will respect the updated grant types and scopes.

Related

• Connections and Authentication