Skip to main content
PUT
Register or change a provider's app

Authorizations

Authorization
string
header
required

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

Path Parameters

provider
enum<string>
required

The provider.

Available options:
google,
microsoft,
atlassian,
notion

Body

application/json

Register or change a provider's app.

client_id
string
required
Required string length: 1 - 512
client_secret
string | null

Leave empty to keep the stored secret.

Maximum string length: 4096
settings
Settings · object
enabled
boolean
default:true

Response

Successful Response

A provider's app registration, for document admins. No secret.

provider
enum<string>
required
Available options:
google,
microsoft,
atlassian,
notion
label
string
required
sources
string[]
required

The sources this app opens.

configured
boolean
required
console_url
string
required
setup_steps
string[]
required
scopes
string[]
required
setting_names
string[]
required

Settings besides the client id.

enabled
boolean
default:false
client_id
string | null
secret_set
boolean
default:false

Whether a secret is stored.

settings
Settings · object
connected_people
integer
default:0

People signed in with it.

updated_by
string | null
updated_at
string<date-time> | null
redirect_uri
string | null

Register this as the app's redirect URL.

redirect_error
string | null

Why the redirect URL isn't known.