Skip to main content
GET
/
organizations
/
{organization}
/
oauth-applications
/
{application_id}
Get an OAuth application
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/oauth-applications/{application_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "redirect_uri": "<string>",
  "domain": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "scopes": [
    "<string>"
  ],
  "avatar": "<string>",
  "client_id": "<string>",
  "tokens": 123,
  "dcr": true,
  "scopes_by_resource": {},
  "all_scopes_by_resource": {}
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
organization
string
required

The name of the organization the OAuth application belongs to

​
application_id
string
required

The ID of the OAuth application

Response

Returns information abuot an OAuth application

​
id
string
required

The ID of the app

​
name
string
required

The name of the app

​
redirect_uri
string
required

The redirect URI of the OAuth application

​
domain
string
required

The domain of the OAuth application. Used for verification of a valid redirect uri

​
created_at
string
required

When the OAuth application was created

​
updated_at
string
required

When the OAuth application was last updated

​
scopes
string[]
required

The scopes that the OAuth application requires on a user account

​
avatar
string
required

The image source for the OAuth application's avatar

​
client_id
string
required

The OAuth application's unique client id

​
tokens
integer
required

The number of tokens issued by the OAuth application

​
dcr
boolean
required

Whether the OAuth application was created via Dynamic Client Registration

​
scopes_by_resource
object
required

Scopes grouped by resource type (database, organization, branch, user) with scope, description, and admin flag

​
all_scopes_by_resource
object
required

All available scopes grouped by resource type with scope, description, selected, and admin flags