List OAuth Clients
Retrieve a paginated list of all OAuth clients in the project.
OAuth clients enable secure API access through different grant types:
Grant Types:
-
Client Credentials
- For server-to-server API access
- No user interaction required
- No redirect URIs needed
- Returns access token directly
- Best for automated processes and service accounts
-
Authorization Code
- For user-based access to the API
- Requires redirect URIs for OAuth flow
- Most secure for web applications
- Flow:
- User is redirected to authorization server
- After consent, redirects back to your app with auth code
- Your app exchanges code for tokens
- Required for web applications accessing user data
-
Refresh Token
- Enables long-term API access
- Used with authorization code flow
- Allows getting new access tokens without user interaction
- No redirect URIs needed for refresh flow itself
- Best for maintaining persistent access
-
Implicit (Legacy)
- For browser-based applications
- Requires redirect URIs
- Returns token in URL fragment
- Less secure than authorization code
- Not recommended for new applications
Redirect URIs:
- Required for authorization code and implicit flows
- Must be exact match when used
- Common formats:
- Web apps: https://app.example.com/oauth/callback
- Local development: http://localhost:3000/callback
- Mobile apps: myapp://oauth/callback
- Security requirements:
- Must use HTTPS in production
- Cannot contain fragments (#)
- Should be specific paths, not generic domains
- Maximum length: 2048 characters
Each client in the list includes:
- Unique client ID
- Name and description
- Configured redirect URIs
- Supported grant types
- Creation and modification timestamps
Path parameters
The unique identifier of the organization.
The unique identifier of the project.
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
The maximum number of items to return per page. Defaults to 100
if not specified.
A cursor for pagination. Use the next_cursor
value from the previous response to get the next page of results.
Response
Successfully retrieved list of OAuth clients
The list of items returned for the current page.
Contains pagination information for the result set.