OPopal
apps

Update app

Changed on

Updates an App. Currently supports only Push-only apps (CUSTOM) and Custom Connector apps (CUSTOM_CONNECTOR).

put/apps/{app_id}

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Path parameters

app_idstring uuid required

The ID of the app.

Request body

namestring

The updated name of the app.

descriptionstring

The updated description of the app.

admin_owner_idstring uuid

The updated ID of the owner of the app.

visibility'GLOBAL' | 'LIMITED'

The visibility level of the entity.

visibility_group_idsstring[]

The IDs of groups that can see this app when visibility is LIMITED. Must be empty when the effective visibility is GLOBAL (either sent explicitly on this request or already stored on the app); the server returns 400 otherwise. Deprecated in favor of PUT /v1/apps/{app_id}/visibility.

import_visibility'GLOBAL' | 'LIMITED'

The visibility level of the entity.

Example request

{
  "visibility": "GLOBAL",
  "import_visibility": "GLOBAL"
}

Response

The updated app.

app_idstring uuid required

The ID of the app.

namestring required

The name of the app.

descriptionstring required

A description of the app.

admin_owner_idstring uuid required

The ID of the owner of the app.

app_type'ACTIVE_DIRECTORY' | 'ANTHROPIC' | 'AZURE_AD' | 'AWS' | 'AWS_SSO' | 'CLICKHOUSE' | 'COUPA' | 'CURSOR' | 'CUSTOM' | 'CONFLUENCE' | 'CUSTOM_CONNECTOR' | 'DATABRICKS' | 'DATASTAX_ASTRA' | 'ALICLOUD' | 'DEVIN' | 'DOCUSIGN' | 'DUO' | 'GCP' | 'GIT_HUB' | 'GIT_LAB' | 'GOOGLE_GROUPS' | 'GOOGLE_WORKSPACE' | 'GRAFANA' | 'HUBSPOT' | 'ILEVEL' | 'INCIDENTIO' | 'JIRA' | 'LDAP' | 'LINEAR' | 'MARIADB' | 'MONGO' | 'MONGO_ATLAS' | 'MYSQL' | 'NETSUITE' | 'DATADOG' | 'OKTA_CIAM' | 'OKTA_DIRECTORY' | 'OPENAI_PLATFORM' | 'OPAL' | 'ORACLE_FUSION' | 'PAGERDUTY' | 'POSTGRES' | 'ROOTLY' | 'SALESFORCE' | 'SNOWFLAKE' | 'SLACK' | 'TABLEAU' | 'TAILSCALE' | 'TELEPORT' | 'TWINGATE' | 'VAULT' | 'WORKDAY' | 'ZENDESK' | 'ZOOM' | 'RAMP' | 'WRIKE' | 'VERCEL' | 'AXIOM' | 'ACTIVECAMPAIGN' | 'ASANA' | 'BITWARDEN' | 'BOX' | 'CALENDLY' | 'ONELOGIN' | 'SQUARE' | 'RIPPLING' required

The type of an app.

visibility'GLOBAL' | 'LIMITED'

The visibility level of the entity.

visibility_group_idsstring[]

The IDs of groups that can see this app when visibility is LIMITED. Must be empty when visibility is GLOBAL.

import_visibility'GLOBAL' | 'LIMITED'

The visibility level of the entity.

Example response

{
  "app_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "name": "Okta Org",
  "description": "Okta directory for the engineering team.",
  "admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "app_type": "OKTA_DIRECTORY"
}

Changes

  • e7877ea96eabRevision changes
    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value GLOBAL of the request property

    • breaking

      removed the enum value GLOBAL of the request property

    • breaking

      removed the enum value LIMITED of the request property

    • breaking

      removed the enum value LIMITED of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • warning

      added the new ACTIVECAMPAIGN enum value to the response property for the response status

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property deprecated

  • c54b1c07fcdbRevision changes
    • warning

      added the new ONELOGIN enum value to the response property for the response status