Update Access Profile Labels

Update the labels assigned to an access profile

Endpoint

PATCH /api/private/lifecycle_management/access_profiles/{id}

Description

Updates the labels assigned to a specific access profile. Labels help categorize and organize access profiles for easier management and filtering.

Common label usage patterns:

• Categorization (e.g., "development", "production", "sensitive")

• Request workflow (e.g., "requestable", "auto-approved")

• Business function (e.g., "finance", "engineering", "sales")

Authentication Required

This endpoint requires a valid Veza API key for authentication.

See Authentication for more about creating and managing API keys.

All requests must include the API key as a Bearer token in the Authorization header.

Example:

curl -X GET "$BASE_URL/api/preview/keys" \
  -H "authorization: Bearer $VEZA_TOKEN"

API Reference

patch

Authorizations

Path parameters

value.idstringRequired

Query parameters

update_maskstring · field-maskOptional

Body

idstringRead-onlyOptional

namestringOptional

descriptionstringOptional

stateinteger · enumOptional

profile_typestringOptional

current_version_numberinteger · int32Read-onlyOptional

The version that is currently live and running

draft_version_numberinteger · int32Read-onlyOptional

The version that is being edited and in draft form (0 if there is none)

used_by_workflowbooleanRead-onlyOptional

integrationsstring[]Read-onlyOptional

current_versionall ofRead-onlyOptional

access_profiles_inheritedstring[]Read-onlyOptional

access_profiles_inherited_bystring[]Read-onlyOptional

inherits_from_other_profilesbooleanRead-onlyOptional

inherited_by_other_profilesbooleanRead-onlyOptional

labelsstring[]Optional

provider_idsstring[]Read-onlyOptional

provider_external_idsstring[]Read-onlyOptional

datasource_idsstring[]Optional

rbac_idstringRead-onlyOptional

requestablebooleanRead-onlyOptional

require_approval_to_startbooleanOptional

started_atstring · date-timeRead-onlyOptional

started_bystringRead-onlyOptional

access_request_policy_idstringRead-onlyOptional

The access request policy that is associated with the access profile

last_synced_atstring · date-timeRead-onlyOptional

Last time the profile was synced with the target

sync_allowedbooleanRead-onlyOptional

Sets if this profile is allowed to sync or not, this is only allowed if the type's create_entitlement_based_on_profile is true

last_sync_job_idsstring[]Read-onlyOptional

The Job IDs for the last time it was synced

identity_created_bystringRead-onlyOptional

The identity that created the access profile

last_sync_error_messagestringRead-onlyOptional

If the sync job failed what is the error message

profile_type_rbac_idstringOptional

created_bystringRead-onlyOptional

created_atstring · date-timeRead-onlyOptional

updated_atstring · date-timeRead-onlyOptional

Responses

200

OK

application/json

default

Default error response

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/private/lifecycle_management/access_profiles/{value.id} HTTP/1.1
Host: your-tenant.cookiecloud.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 350

{
  "name": "text",
  "description": "text",
  "state": 1,
  "profile_type": "text",
  "labels": [
    "text"
  ],
  "datasource_ids": [
    "text"
  ],
  "require_approval_to_start": true,
  "catalog_item_info": {
    "name": "text",
    "description": "text",
    "markdown_description": "text",
    "icon": "text",
    "recommended": true
  },
  "profile_type_rbac_id": "text",
  "custom_properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "value": {
    "id": "text",
    "name": "text",
    "description": "text",
    "state": 1,
    "profile_type": "text",
    "current_version_number": 1,
    "draft_version_number": 1,
    "used_by_workflow": true,
    "integrations": [
      "text"
    ],
    "current_version": {
      "access_profile_id": "text",
      "version_number": 1,
      "state": 1,
      "entities_to_create_relationships_to": [
        {
          "entity_type": "text",
          "datasource_id": "text",
          "entity_id": "text",
          "assigned_to_entity_type": "text",
          "assigned_to_entity_id": "text",
          "extraction_datasource_id": "text",
          "provider_id": "text",
          "provider_external_id": "text",
          "entity_name": "text",
          "native_id": "text",
          "grant_by": 1,
          "created_by_access_profile": true,
          "custom_properties": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "sync_identity_action": {
            "policy_id": "text",
            "name": "text"
          },
          "condition": {
            "type": 1,
            "condition_string": "text"
          },
          "create_entitlement_detail_id": "text",
          "created_at": "2025-08-25T18:41:48.690Z"
        }
      ],
      "inherit_entities_from_access_profiles": [
        "text"
      ],
      "members": [
        "text"
      ],
      "rbac_id": "text",
      "access_request_policy_id": "text",
      "application_datasource_id": "text",
      "application_sync_identity_action": {
        "policy_id": "text",
        "name": "text"
      },
      "created_by": "text",
      "created_at": "2025-08-25T18:41:48.690Z",
      "updated_at": "2025-08-25T18:41:48.690Z",
      "published_by": "text",
      "published_at": "2025-08-25T18:41:48.690Z"
    },
    "access_profiles_inherited": [
      "text"
    ],
    "access_profiles_inherited_by": [
      "text"
    ],
    "inherits_from_other_profiles": true,
    "inherited_by_other_profiles": true,
    "labels": [
      "text"
    ],
    "provider_ids": [
      "text"
    ],
    "provider_external_ids": [
      "text"
    ],
    "datasource_ids": [
      "text"
    ],
    "rbac_id": "text",
    "member_details": [
      {
        "access_profile_id": "text",
        "access_profile_name": "text",
        "identity_id": "text",
        "identity_name": "text",
        "created_from": 1,
        "workflow": "text"
      }
    ],
    "requestable": true,
    "require_approval_to_start": true,
    "started_at": "2025-08-25T18:41:48.690Z",
    "started_by": "text",
    "catalog_item_info": {
      "name": "text",
      "description": "text",
      "markdown_description": "text",
      "icon": "text",
      "recommended": true
    },
    "access_request_policy_id": "text",
    "created_entitlements": [
      {
        "datasource_id": "text",
        "entity_type": "text",
        "attribute_transformers": {
          "values": [
            {
              "destination_attribute": "text",
              "destination_value_formatter": "text",
              "continuous_sync": true,
              "additional_value_formatter": [
                "text"
              ],
              "pipeline_functions": "text",
              "unique_identifier": true
            }
          ]
        },
        "add_member_condition": {
          "type": 1,
          "condition_string": "text"
        },
        "created_entity_id": "text",
        "access_request_id": "text",
        "id": "text",
        "last_sync_job_id": "text"
      }
    ],
    "last_synced_at": "2025-08-25T18:41:48.690Z",
    "sync_allowed": true,
    "last_sync_job_ids": [
      "text"
    ],
    "identity_created_by": "text",
    "last_sync_error_message": "text",
    "profile_type_rbac_id": "text",
    "created_by": "text",
    "created_at": "2025-08-25T18:41:48.690Z",
    "updated_at": "2025-08-25T18:41:48.690Z",
    "custom_properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}

Request schema

Path parameters

Path parameter	Type	Required?	Description
id	string	Required	Unique identifier of the access profile

Request body

Field	Type	Required?	Description
labels	array	Required	Array of label strings to assign to the access profile

Request Examples

curl -X PATCH "$BASE_URL/api/private/lifecycle_management/access_profiles/3a2371b6-95ec-4d9e-b95c-d75d51daa39b" \
  -H "authorization: Bearer $VEZA_TOKEN" \
  -H "Content-Type: application/json" \
  --data-raw '{
    "labels": ["requestable", "salesforce", "development"]
  }'

Response Examples

{
  "value": {
    "id": "3a2371b6-95ec-4d9e-b95c-d75d51daa39b",
    "name": "Salesforce Developer",
    "state": 1,
    "profile_type": "a730b9cd-d600-4fb7-a803-8ab5b697c0b9",
    "current_version": 1,
    "integrations": ["SALESFORCE"],
    "provider_ids": ["sf-dev-org-12345"],
    "labels": ["requestable", "salesforce", "development"],
    "created_at": "2024-07-15T16:20:15.123456789Z",
    "updated_at": "2024-07-15T16:35:22.456789123Z"
  }
}