Query parameters

• types array[string] | string

  An array of application types to filter applications.

• excludeRoleId string
• excludeOrganizationId string
• isThirdParty string("true") | string("false")
• page integer

  Page number (starts from 1).

  Minimum value is 1. Default value is 1.

• page_size integer

  Entries per page.

  Minimum value is 1. Default value is 20.

• search_params object

  Search query parameters.

  Hide search_params attribute Show search_params attribute object

  • * string Additional properties

Responses

• 200 application/json

  A list of applications.

  Hide response attributes Show response attributes object

  • tenantId string Required

    Maximum length is 21.

  • id string Required

    Minimum length is 1, maximum length is 21.

  • name string Required

    Minimum length is 1, maximum length is 256.

  • secret string Required Deprecated

    The internal client secret. Note it is only used for internal validation, and the actual secrets should be retrieved from /api/applications/{id}/secrets endpoints.

  • description string | null Required
  • type string Required

    Values are Native, SPA, Traditional, MachineToMachine, Protected, or SAML.

  • oidcClientMetadata object Required

    Additional properties are allowed.

    Hide oidcClientMetadata attributes Show oidcClientMetadata attributes object

    • redirectUris array[object] Required
      One of:

      object-1 object object-2 object

      Validator function

      Additional properties are allowed.

      Validator function

      Additional properties are allowed.

    • postLogoutRedirectUris array[string(url)] Required
    • backchannelLogoutUri string(url)
    • backchannelLogoutSessionRequired boolean
    • logoUri string
  • customClientMetadata object Required

    Additional properties are allowed.

    Hide customClientMetadata attributes Show customClientMetadata attributes object

    • corsAllowedOrigins array[string]

      Minimum length of each is 1.

    • idTokenTtl number
    • refreshTokenTtl number
    • refreshTokenTtlInDays number
    • tenantId string
    • alwaysIssueRefreshToken boolean
    • rotateRefreshToken boolean
  • protectedAppMetadata object | null Required

    Additional properties are allowed.

    Hide protectedAppMetadata attributes Show protectedAppMetadata attributes object | null

    • host string Required
    • origin string Required
    • sessionDuration number Required
    • pageRules array[object] Required
      Hide pageRules attribute Show pageRules attribute object

      • path string Required
    • customDomains array[object]
      Hide customDomains attributes Show customDomains attributes object

      • domain string Required
      • status string Required

        Values are PendingVerification, PendingSsl, Active, or Error.

      • errorMessage string | null Required
      • dnsRecords array[object] Required
        Hide dnsRecords attributes Show dnsRecords attributes object

        • name string Required
        • type string Required
        • value string Required
      • cloudflareData object | null Required

        Additional properties are allowed.

        Hide cloudflareData attributes Show cloudflareData attributes object | null

        • id string Required
        • status string Required
        • ssl object Required

          Additional properties are allowed.

          Hide ssl attributes Show ssl attributes object

          • status string Required
          • validation_errors array[object]
            Hide validation_errors attribute Show validation_errors attribute object

            • message string Required
        • verification_errors array[string]
  • customData object Required

    arbitrary

    Additional properties are allowed.

  • isThirdParty boolean Required
  • createdAt number Required
• 400

  Bad Request

• 401

  Unauthorized

• 403

  Forbidden