RegisterAppAsDraftResponse

Response from POST /applications/1.0/drafts. Returns the non-secret production-draft credentials and, on the happy path, the non-secret sandbox credentials. No clientSecret is returned inline (ITD 9): the secret(s) are revealed once via the single SSO-gated secretClaimUrl.

On a sandbox transient failure the production side still commits: sandboxCredentials is null and sandboxStatus is pending; the App is reconciled by the hourly sandbox-provisioning reconciler.

  • applicationId
    Type: stringFormat: uuid
    required

    Unique identifier of the newly registered draft application.

  • appUrn
    Type:
    required

    Canonical URN identifying your registered application.

    Format: urn:uuid:{applicationId} (RFC 4122). Use this value as Caliper edApp.id when emitting events from your app.

  • productionCredentials
    Type:
    required

    One non-secret OAuth credential set (client credentials flow). The clientSecret is NOT returned inline (ITD 9): it is revealed once via the SSO-gated secretClaimUrl on the parent response.

    Properties: 3
  • publisherId
    Type: stringFormat: uuid
    required

    Publisher that owns this application (assigned automatically or from your request).

  • sandboxStatus
    Type: "provisioned" or "pending"enum
    required

    provisioned when both credential sets are returned; pending when this response carries no sandbox credentials — either the sandbox side has not completed (the hourly sandbox-provisioning reconciler finishes it) or it was provisioned concurrently and the secret must be claimed via rotate_credentials (get_app_credentials then reports awaiting_secret_claim).

  • secretClaimUrl
    Type: stringFormat: uri
    required

    Single signed, single-use URL that reveals every minted client secret once, behind a Google-IdP SSO gate. The developer must open it in their own browser.

  • securityNote
    Type: string
    required

    Warning that the agent must not open secretClaimUrl on the developer's behalf; the secret is shown only to the authenticated developer and never returned through the API.

  • sandboxCredentials
    Type: nullable

    Sandbox credentials valid against sandbox.platform.timeback.com. Null when sandboxStatus is pending.

    Properties: 3
Previous
RegisterAppAsDraftRequest
Next
RegisteredCredentials