Register a draft application

​

Registers a new application in draft status and provisions OAuth client credentials (clientId and clientSecret) for the client credentials flow.

The response includes applicationId, appUrn, clientId, clientSecret, and publisherId. The clientSecret is returned only in this response; store it securely now — it cannot be retrieved again through the API.

If your account is linked to more than one publisher, include publisherId in the request body. If you belong to zero or one publisher, omit publisherId and the platform assigns or creates the appropriate publisher.

Body·
required
application/json

Request body for POST /applications/1.0/drafts.

  • description
    Type: string
    min length:  
    1
    max length:  
    1024
    required

    Short description (max 1024 chars).

  • launchUrl
    Type: string
    max length:  
    512    Format: uri
    required

    URL to which LTI launch messages will be posted.

  • name
    Type: string
    min length:  
    1
    max length:  
    256
    required

    Display name of the App; must be unique across the developer platform.

  • applicationType
    Type: stringenum

    Type of the LTI application

    values
    • learning_app
    • assessment
    • internal
  • publisherId
    Type: string | nullFormat: uuid

    Optional Publisher ID. Omit when the caller belongs to zero or one Publisher. Required when multiple memberships exist; the service returns 400 with a nextAction otherwise.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/applications/1.0/drafts
curl https://platform.dev.timeback.com/applications/1.0/drafts \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "description": "",
  "launchUrl": "",
  "applicationType": "learning_app",
  "publisherId": null
}'

{
  "appUrn": "urn:uuid:53f0d94d-786d-409a-b5eb-7a6c1db8957b",
  "applicationId": "123e4567-e89b-12d3-a456-426614174000",
  "clientId": "string",
  "clientSecret": "string",
  "publisherId": "123e4567-e89b-12d3-a456-426614174000"
}

Draft App registered