v2

latestOpenAPI 3.0.02026-07-31172752.6 KB

applications

Update an application

Updates an application's top-level attributes. Supports optimistic locking: include the current lock_version to guard against concurrent edits, which returns a conflict if the application has changed since you read it. To modify resources and permissions, use the update-structure endpoint.

put/api/v1/applications/{id}

Path parameters

idstring required

Headers

Idempotency-Keystring

Optional key (1–255 chars) for safely retrying a request. Reusing the same key for the same request returns 409 Conflict and is not processed again — this confirms the request was already received. Keys are retained for 14 days.

Request body

admin_user_idsstring[]

User IDs of the application's admins. Send [] to clear; unknown IDs return 422.

Authentication method used to sign in

data_locationstring nullable

Where the vendor stores data

descriptionstring nullable

last_vendor_review_atstring date nullable

Date of the last vendor security review

lock_versioninteger

Optimistic lock version. Optional; if stale, returns 409.

mfa_activatedboolean nullable

Whether MFA is activated for this application

notesstring nullable

Internal notes

owner_user_idstring uuid nullable

processed_data_typesstring[]

Data-processing-scope slugs. Send [] to clear; unknown slugs return 422.

risk_level'low' | 'medium' | 'high' nullable

status'ignored' | 'approved' | 'requestable'

Needs a set owner for "approved" and "requestable"

tagsstring[]

Tag titles. New titles are created automatically; send [] to clear.

titlestring

urlstring nullable

user_setup_urlstring nullable

URL where existing users are shown and new users are invited

vendor_certificatesstring[]

Security/compliance certifications held by the vendor

Response

Application

admin_user_idsstring[]

User IDs of the application's admins

Authentication method used to sign in

data_locationstring nullable

Where the vendor stores data

descriptionstring nullable

Description

idstring uuid required

Application ID

inserted_atstring date-time

Creation timestamp

last_vendor_review_atstring date nullable

Date of the last vendor security review

mfa_activatedboolean nullable

Whether MFA is activated for this application

notesstring nullable

Internal notes

owner_user_idstring uuid nullable

Owner user ID

permanent_access_allowedboolean

Whether the application allows permanent (non-expiring) access

processed_data_typesstring[]

Types of data this application processes

provisioning_type'application_admin' | 'automatic'

Provisioning type

risk_level'low' | 'medium' | 'high' nullable

Risk level assessment

status'ignored' | 'discovered' | 'approved' | 'requestable' required

Application status

time_based_access_durationsstring[]

Configured time-based access durations as ISO 8601 durations (e.g. "PT1H", "P7D"); empty when the app offers only permanent access

titlestring required

Application title

updated_atstring date-time

Last update timestamp

urlstring nullable

Application URL

user_countinteger nullable

Number of users with access

user_setup_urlstring nullable

URL where existing users are shown and new users are invited

vendor_certificatesstring[]

Security/compliance certifications held by the vendor

Example response

{
  "admin_user_ids": [
    "7488a646-e31f-11e4-aace-600308960665"
  ],
  "auth_method": "okta",
  "data_location": "EU",
  "description": "Team communication platform",
  "id": "7488a646-e31f-11e4-aace-600308960662",
  "inserted_at": "2023-01-01T00:00:00Z",
  "last_vendor_review_at": "2026-01-15",
  "mfa_activated": true,
  "notes": "Reviewed in Q4",
  "owner_user_id": "7488a646-e31f-11e4-aace-600308960663",
  "permanent_access_allowed": true,
  "processed_data_types": [
    "customer_data"
  ],
  "provisioning_type": "automatic",
  "risk_level": "medium",
  "status": "requestable",
  "tags": [
    {
      "id": "7488a646-e31f-11e4-aace-600308960666",
      "title": "Communication"
    }
  ],
  "time_based_access_durations": [
    "PT1H",
    "P7D"
  ],
  "title": "Slack",
  "updated_at": "2023-01-01T00:00:00Z",
  "url": "https://slack.com",
  "user_count": 150,
  "user_setup_url": "https://slack.com/get-started",
  "vendor_certificates": [
    "soc2_t2",
    "iso_27001"
  ]
}