ONonetrust
Entity Management

Modify Entity

Use this API to partially update an existing entity record.

🗒 Things to Know

  • This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).
  • AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
patch/api/ai-governance/v1/entities/{entityId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/ai-governance/v1/entities/{entityId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: AI_GOVERNANCE, AI_GOVERNANCE_WRITE

Path parameters

entityIdstring uuid required

Entity Identifier

Query parameters

entityTypeIdstring uuid

Identifier of the entity type

entityTypeNamestring

Name of the entity type

Request body

namestring

The updated name of the entity. If not provided, the existing name will be retained.

attributesobject

Custom attributes to update on the entity. Only the attributes provided will be updated; others will retain their existing values.

Example request

{
  "name": "OneTrust Updated",
  "attributes": {
    "textAttributeName": [
      {
        "value": "New Text Value"
      }
    ]
  }
}

Response

OK - The entity was successfully updated

idstring uuid required

The unique identifier of the entity. Auto-generated when a new entity is created.

numberinteger required

The numerical order in which the entity was created. Used for reference and sorting.

namestring required

The name of the entity. Used as the primary identifier for users.

orgGroupIdstring uuid

The unique identifier of the organization that owns this entity.

schemaIdstring uuid required

The unique identifier of the schema that defines the structure of this entity.

attributesobject

The custom attributes of the entity defined by the entity type schema. Contains attribute paths and corresponding values. The number of attributes can vary based on the entity type definition.

Example response

{
  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "name": "OneTrust",
  "entityType": {
    "id": "d1119953-b4b5-4042-8cb9-b78038cc2c46",
    "name": "Vendor"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.