RegisterAppAsDraftResponse

Response from POST /applications/1.0/drafts. Returns both the production-draft credentials and, on the happy path, the sandbox credentials. Each clientSecret is returned exactly once at creation time and cannot be retrieved later through the API.

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

  • applicationId
    Type: string Format: uuid
    required

    Unique identifier of the newly registered draft application.

  • appUrn
    Type: string · AppUrnPattern: ^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
    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: object · RegisteredCredentials
    required

    One OAuth credential set (client credentials flow). The clientSecret is returned exactly once at creation time and cannot be retrieved later.

    • clientId
      Type: string
      required

      OAuth client ID for authenticating your application (client credentials flow).

    • clientSecret
      Type: string
      required

      OAuth client secret. Returned only in this response; store it securely now.

    • scopes
      Type: array string[]
      required

      OAuth scopes authorized on this client.

    • tokenUrl
      Type: string Format: uri
      required

      Token endpoint for this environment. POST client_id + client_secret with grant_type=client_credentials to mint an access token.

  • publisherId
    Type: string Format: uuid
    required

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

  • sandboxStatus
    Type: string enum
    required

    provisioned when both credential sets are returned; pending when the sandbox side has not completed and is reconciled by the backfill.

    values
    • provisioned
    • pending
  • sandboxCredentials
    Type: object · RegisteredCredentialsnullable

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

    One OAuth credential set (client credentials flow). The clientSecret is returned exactly once at creation time and cannot be retrieved later.

    • clientId
      Type: string
      required

      OAuth client ID for authenticating your application (client credentials flow).

    • clientSecret
      Type: string
      required

      OAuth client secret. Returned only in this response; store it securely now.

    • scopes
      Type: array string[]
      required

      OAuth scopes authorized on this client.

    • tokenUrl
      Type: string Format: uri
      required

      Token endpoint for this environment. POST client_id + client_secret with grant_type=client_credentials to mint an access token.