Skip to main content
POST
/
vault
/
oauth
/
apps
/
{appSlug}
/
custom
cURL
curl --request POST \
  --url https://api.useanima.sh/v1/vault/oauth/apps/{appSlug}/custom \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientId": "<string>",
  "clientSecret": "<string>",
  "customScopes": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "appDefinitionId": "<string>",
  "appSlug": "<string>",
  "orgId": "<string>",
  "clientId": "<string>",
  "customScopes": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Path Parameters

appSlug
string
required

App slug to create a custom app for

Body

application/json

Input for creating a custom OAuth app (BYOA)

clientId
string
required

Your OAuth client ID

clientSecret
string
required

Your OAuth client secret

customScopes
string[]

Override default scopes

Response

200 - application/json

OK

Custom OAuth app details (client secret is never returned)

id
string
required

Custom app identifier

appDefinitionId
string
required

Parent app definition ID

appSlug
string
required

App slug

orgId
string
required

Organization that owns this custom app

clientId
string
required

OAuth client ID (visible)

customScopes
string[]
required

Custom scopes

isActive
boolean
required

Whether the custom app is active

createdAt
string<date-time>
required

When the custom app was created