Sign in
Applications

Create application

Creates a new Application - a software system with an identity that can access Resources

post/zones/{zoneId}/applications

Path parameters

zoneIdstring required

Request body

namestring safe-text required

Human-readable name. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

identifierstring safe-text required

User specified identifier, unique within the zone. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

descriptionstring safe-text nullable

Human-readable description. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

consent'implicit' | 'required'

Consent mode for the application. Defaults to 'required'.

Response

An Application is a software system with an associated identity that can access Resources. It may act on its own behalf (machine-to-machine) or on behalf of a user (delegated access).

idstring required

Unique identifier of the application

organization_idstring required

Organization that owns this application

zone_idstring required

Zone this application belongs to

slugstring required

URL-safe identifier, unique within the zone

identifierstring required

User specified identifier, unique within the zone

namestring required

Human-readable name

descriptionstring nullable

Human-readable description

dependencies_countinteger required

Number of resource dependencies

owner_type'platform' | 'customer' required

Who owns this application. Platform-owned applications cannot be modified via API.

consent'implicit' | 'required' required

Consent mode for the application. 'implicit' means consent is automatically granted, 'required' means explicit user consent is needed.

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

Changes

Changed in 5 of the 23 revisions of this API.3211

  • d65d51379d933See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

  • 2f5033ed44912See the full diff
    • ○

      added the new optional request property metadata/icon_url

      new-optional-request-property

    • ○

      added the optional property metadata/icon_url to the response with the 200 status

      response-optional-property-added

  • 932699a5ea1632See the full diff
    • ▲

      the description request property type/format changed from string/ to string/safe-text

      request-property-type-changed

    • ▲

      the identifier request property type/format changed from string/ to string/safe-text

      request-property-type-changed

    • ▲

      the name request property type/format changed from string/ to string/safe-text

      request-property-type-changed

    • ○

      added the new optional request property consent

      new-optional-request-property

    • ○

      added the required property consent to the response with the 200 status

      response-required-property-added

  • d3d69f45bfed23See the full diff
    • ●

      removed the request property traits

      request-property-removed

    • ●

      removed the optional property traits from the response with the 200 status

      response-optional-property-removed

    • ○

      the endpoint scheme security OAuth2 was added to the API

      api-security-added

    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security iam_bearerAuth was removed from the API

      api-security-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cb43483cd1b31See the full diff
    • ○

      added the required property owner_type to the response with the 200 status

      response-required-property-added