Apps

Update an existing app by ID

Required scope - write_app. Assigning the root scope additionally requires the caller to hold the root scope.

put/api/v1/apps/{id}

Path parameters

idnumber required

The unique ID of the app

Request body

redirectUrisstring[]
namestring
isActiveboolean
scopesstring[]
useSystemMfaConfigboolean
requireEmailMfaboolean
requireOtpMfaboolean
requireSmsMfaboolean
allowEmailMfaAsBackupboolean

Response

Changes

Changed in 4 of the 50 revisions of this API.16522

    • removed the required property app/allOf[App]/secret from the response with the 200 status

      response-required-property-removed

    • added the new optional request property allowEmailMfaAsBackup

      new-optional-request-property

    • added the new optional request property requireEmailMfa

      new-optional-request-property

    • added the new optional request property requireOtpMfa

      new-optional-request-property

    • added the new optional request property requireSmsMfa

      new-optional-request-property

    • added the new optional request property useSystemMfaConfig

      new-optional-request-property

    • added the required property app/allOf[App]/allowEmailMfaAsBackup to the response with the 200 status

      response-required-property-added

    • added the required property app/allOf[App]/requireEmailMfa to the response with the 200 status

      response-required-property-added

    • added the required property app/allOf[App]/requireOtpMfa to the response with the 200 status

      response-required-property-added

    • added the required property app/allOf[App]/requireSmsMfa to the response with the 200 status

      response-required-property-added

    • added the required property app/allOf[App]/useSystemMfaConfig to the response with the 200 status

      response-required-property-added

    • the response property app/allOf[App]/clientId became required for the status 200

      response-property-became-required

    • the response property app/allOf[App]/createdAt became required for the status 200

      response-property-became-required

    • the response property app/allOf[App]/deletedAt became required for the status 200

      response-property-became-required

    • the response property app/allOf[App]/id became required for the status 200

      response-property-became-required

    • the response property app/allOf[App]/isActive became required for the status 200

      response-property-became-required

    • the response property app/allOf[App]/name became required for the status 200

      response-property-became-required

    • the response property app/allOf[App]/redirectUris became required for the status 200

      response-property-became-required

    • the response property app/allOf[App]/secret became required for the status 200

      response-property-became-required

    • the response property app/allOf[App]/type became required for the status 200

      response-property-became-required

    • the response property app/allOf[App]/updatedAt became required for the status 200

      response-property-became-required

    • the response property app/allOf[subschema #2]/scopes became required for the status 200

      response-property-became-required

  • 11e2773b3a1e1551See the full diff
    • the response property app/allOf[App]/clientId became optional for the status 200

      response-property-became-optional

    • the response property app/allOf[App]/createdAt became optional for the status 200

      response-property-became-optional

    • the response property app/allOf[App]/deletedAt became optional for the status 200

      response-property-became-optional

    • the response property app/allOf[App]/id became optional for the status 200

      response-property-became-optional

    • the response property app/allOf[App]/isActive became optional for the status 200

      response-property-became-optional

    • the response property app/allOf[App]/name became optional for the status 200

      response-property-became-optional

    • the response property app/allOf[App]/redirectUris became optional for the status 200

      response-property-became-optional

    • the response property app/allOf[App]/type became optional for the status 200

      response-property-became-optional

    • the response property app/allOf[App]/updatedAt became optional for the status 200

      response-property-became-optional

    • the response property app/allOf[subschema #2]/scopes became optional for the status 200

      response-property-became-optional

    • removed the required property app/allOf[App]/allowEmailMfaAsBackup from the response with the 200 status

      response-required-property-removed

    • removed the required property app/allOf[App]/requireEmailMfa from the response with the 200 status

      response-required-property-removed

    • removed the required property app/allOf[App]/requireOtpMfa from the response with the 200 status

      response-required-property-removed

    • removed the required property app/allOf[App]/requireSmsMfa from the response with the 200 status

      response-required-property-removed

    • removed the required property app/allOf[App]/useSystemMfaConfig from the response with the 200 status

      response-required-property-removed

    • removed the request property allowEmailMfaAsBackup

      request-property-removed

    • removed the request property requireEmailMfa

      request-property-removed

    • removed the request property requireOtpMfa

      request-property-removed

    • removed the request property requireSmsMfa

      request-property-removed

    • removed the request property useSystemMfaConfig

      request-property-removed

    • added the optional property app/allOf[App]/secret to the response with the 200 status

      response-optional-property-added

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