Update Access Profile Members

Add or remove members from a specific access profile version

Endpoint

PUT /api/private/lifecycle_management/access_profiles/{id}/versions/{version}/members

Description

Adds or removes identities as members of a specific Access Profile version. Access Profiles define entitlements (such as group memberships, role assignments, or permission sets) in target applications.

When you add a member, Veza creates access requests to provision those entitlements to the identity. When you remove a member, Veza creates access requests to de-provision those entitlements from the identity.

Provisioning Behavior: Access requests for provisioning/de-provisioning are only created when the Access Profile is in a RUNNING state and the version is PUBLISHED.

Member Requirements: A member must be an LCM identity. Only identities managed by Lifecycle Management can be added to Access Profiles.

API Reference

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token authentication using a Veza Personal API key.

Header Format: Authorization: Bearer <your-api-key>

Creating an API Key:

1. Log into your Veza tenant
2. Navigate to Administration → API Keys
3. Generate a new API key and save the value securely

Path parameters

access_profile_idstringRequired

version_numberinteger · int32Required

Body

application/json

access_profile_idstringOptional

version_numberinteger · int32Optional

typeinteger · enumOptional

identity_idsstring[]Optional

Responses

200

OK

application/json

default

Default error response

application/json

put

/api/private/lifecycle_management/access_profiles/{access_profile_id}/versions/{version_number}/members

HTTPcURLJavaScriptPython

PUT /api/private/lifecycle_management/access_profiles/{access_profile_id}/versions/{version_number}/members HTTP/1.1
Host: your-tenant.cookiecloud.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "access_profile_id": "text",
  "version_number": 1,
  "type": 1,
  "identity_ids": [
    "text"
  ]
}

{
  "value": {
    "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-12-15T23:08:12.356Z"
      }
    ],
    "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-12-15T23:08:12.356Z",
    "updated_at": "2025-12-15T23:08:12.356Z",
    "published_by": "text",
    "published_at": "2025-12-15T23:08:12.356Z"
  },
  "access_request_id": "text",
  "access_request_error_message": "text",
  "access_requests": [
    {
      "id": "text",
      "error_message": "text"
    }
  ]
}

Request schema

Path parameters

Path parameter	Type	Required?	Description
access_profile_id	string	Required	Unique identifier of the access profile
version_number	integer	Required	Version number of the access profile

Request body

Field	Type	Required?	Description
access_profile_id	string	Required	ID of the access profile (same as path parameter)
identity_ids	array[string]	Required	Array of Veza identity IDs to add or remove
type	string	Required	Operation type: ADD or REMOVE
version_number	integer	Required	Version number of the access profile

Request Examples

Add Members

Add members to an access profile:

curl -X PUT "$BASE_URL/api/private/lifecycle_management/access_profiles/01964a45-6146-75ca-8fb7-6c4d01fc53f2/versions/1/members" \
  -H "authorization: Bearer $VEZA_TOKEN" \
  -H "Content-Type: application/json" \
  --data-raw '{
    "access_profile_id": "01964a45-6146-75ca-8fb7-6c4d01fc53f2",
    "identity_ids": [
      "01964514-3fa9-7d76-be82-ef9732de637d",
      "01964514-3fa9-7d76-be82-ef9732de638e"
    ],
    "type": "ADD",
    "version_number": 1
  }'

Remove Members

Response Examples

{
  "value": {
    "access_profile_id": "01964a45-6146-75ca-8fb7-6c4d01fc53f2",
    "version_number": 1,
    "state": "PUBLISHED",
    "members": [
      "01964514-3fa9-7d76-be82-ef9732de637d",
      "01964514-3fa9-7d76-be82-ef9732de638e"
    ]
  },
  "access_requests": [
    {
      "id": "01964a50-1234-5678-9abc-def012345678",
      "error_message": ""
    }
  ]
}

Response Fields:

• value: The updated access profile version object

• access_requests: Array of access request information created by this operation (if Lifecycle Management is running)

• Each access request includes an id (if successful) or error_message (if failed)

Related Operations

• List Access Profile Members - View current members of an access profile

• List Access Profiles - Get access profile details including version numbers