ابدأ في بيئة الاختبار

التوثيق منشور باللغة الإنجليزية.

DocumentationReference

Applications

Create, read, update, enable, disable and delete applications; environments, quickstart, activity, reach and the scope catalogue.

18 routes

An application belongs to a project; a project holds at most one sandbox and one production record. {applicationId} is either record's public id.

The guide for this family is Create an application.

GET /v1/developer/access-status

GET /v1/developer/access-status
Authentication
Developer console session

GET /v1/developer/applications

GET /v1/developer/applications
Authentication
Developer console session

POST /v1/developer/applications

POST /v1/developer/applications
Authentication
Developer console session

Request body — CreateDeveloperApplicationDto

environmentoptional
'sandbox' | 'production' — IsIn(['sandbox', 'production'])
namerequired
string — IsString, Length(1, 150)
descriptionoptional
string — IsString, MaxLength(250)
websiteUrloptional
string — WebAddress('The website')
supportEmailoptional
string — IsEmail
redirectUrisrequired
string[] — IsArray, ArrayNotEmpty, IsString({ each: true })
allowedClaimScopesrequired
string[] — IsArray, ArrayNotEmpty, IsString({ each: true })
allowedDataCategoriesoptional
string[] — IsArray, IsString({ each: true })
termsUrloptional
string — WebAddress('The terms of service address')
privacyPolicyUrloptional
string — WebAddress('The privacy policy address')

DELETE /v1/developer/applications/{applicationId}

DELETE /v1/developer/applications/{applicationId}
Authentication
Developer console session

Request body — DeleteDeveloperApplicationDto

confirmationrequired
'DELETE' — IsIn(['DELETE'])

GET /v1/developer/applications/{applicationId}

GET /v1/developer/applications/{applicationId}
Authentication
Developer console session

PATCH /v1/developer/applications/{applicationId}

PATCH /v1/developer/applications/{applicationId}
Authentication
Developer console session

Request body — UpdateDeveloperApplicationDto

nameoptional
string — IsString, Length(1, 150)
descriptionoptional
string — IsString, MaxLength(250)
websiteUrloptional
string — WebAddress('The website')
supportEmailoptional
string — IsEmail
redirectUrisoptional
string[] — IsArray, ArrayNotEmpty, IsString({ each: true })
allowedClaimScopesoptional
string[] — IsArray, ArrayNotEmpty, IsString({ each: true })
allowedDataCategoriesoptional
string[] — IsArray, ArrayNotEmpty, IsString({ each: true })
termsUrloptional
string — WebAddress('The terms of service address')
privacyPolicyUrloptional
string — WebAddress('The privacy policy address')

GET /v1/developer/applications/{applicationId}/activity

GET /v1/developer/applications/{applicationId}/activity
Authentication
Developer console session

GET /v1/developer/applications/{applicationId}/branding

GET /v1/developer/applications/{applicationId}/branding
Authentication
Developer console session
DELETE /v1/developer/applications/{applicationId}/branding/logo
Authentication
Developer console session
POST /v1/developer/applications/{applicationId}/branding/logo
Authentication
Developer console session

POST /v1/developer/applications/{applicationId}/disable

POST /v1/developer/applications/{applicationId}/disable
Authentication
Developer console session

Request body — DisableDeveloperApplicationDto

reasonoptional
string — IsString, MaxLength(500)

POST /v1/developer/applications/{applicationId}/enable

POST /v1/developer/applications/{applicationId}/enable
Authentication
Developer console session

GET /v1/developer/applications/{applicationId}/environments

GET /v1/developer/applications/{applicationId}/environments
Authentication
Developer console session

POST /v1/developer/applications/{applicationId}/environments/production

POST /v1/developer/applications/{applicationId}/environments/production
Authentication
Developer console session

GET /v1/developer/applications/{applicationId}/quickstart

GET /v1/developer/applications/{applicationId}/quickstart
Authentication
Developer console session

GET /v1/developer/applications/{applicationId}/reach

GET /v1/developer/applications/{applicationId}/reach
Authentication
Developer console session

The canonical document object, so the console shows the developer the shape they will actually receive rather than a hand-written copy of it that drifts.

GET /v1/developer/applications/identity-scope-catalogue

GET /v1/developer/applications/identity-scope-catalogue
Authentication
Developer console session

GET /v1/developer/applications/reach

GET /v1/developer/applications/reach
Authentication
Developer console session

The canonical document object, so the console shows the developer the shape they will actually receive rather than a hand-written copy of it that drifts.

What this does not do

  • Responses are not listed. The API declares no response types, so this page describes what to send and who may send it. Recorded response shapes are on the guides.
  • This page is generated. It was read from the API at commit 234dba22. Editing it by hand changes nothing; the next sync overwrites it.

Verified against API commit 234dba22 on 2026-10-18. The routes, scopes, checklist, events and limits on these pages are read from that export, not typed.