List Access Profiles

Retrieve all access profiles with optional filtering and detailed entity information

Endpoint

GET /api/private/lifecycle_management/access_profiles

Description

Lists all Veza Access Profiles in your organization with support for filtering and optional detailed entity information. You can filter results using SCIM-format filter expressions and request additional entity details to understand the relationships each profile contains.

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

get

Authorizations

Query parameters

filterstringOptional

order_bystringOptional

page_sizeinteger · int32Optional

page_tokenstringOptional

entity_extra_infobooleanOptional

include_requestablebooleanOptional

Responses

200

application/json

default

Default error response

application/json

get

/api/private/lifecycle_management/access_profiles

GET /api/private/lifecycle_management/access_profiles HTTP/1.1
Host: your-tenant.cookiecloud.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "values": [
    {
      "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-10-31T00:53:00.248Z"
          }
        ],
        "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-10-31T00:53:00.248Z",
        "updated_at": "2025-10-31T00:53:00.248Z",
        "published_by": "text",
        "published_at": "2025-10-31T00:53:00.248Z"
      },
      "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-10-31T00:53:00.248Z",
      "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-10-31T00:53:00.248Z",
      "sync_allowed": true,
      "last_sync_job_ids": [
        "text"
      ],
      "identity_created_by": "text",
      "last_sync_error_message": "text",
      "profile_type_rbac_id": "text",
      "not_allowed_for_managed_relationships": true,
      "created_by": "text",
      "created_at": "2025-10-31T00:53:00.248Z",
      "updated_at": "2025-10-31T00:53:00.248Z",
      "custom_properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "next_page_token": "text",
  "has_more": true
}

Request schema

Query parameters

Query parameter

Type

Required?

Description

filter

string

Optional

SCIM filter expression to filter results

entity_extra_info

boolean

Optional

When true, includes additional entity relationship details with provider names and external IDs

Filter Parameters

Veza uses the SCIM filter format including AND/OR logical operations. Examples:

Filter

Description

Example URL

integrations co "SALESFORCE"

Contains SALESFORCE in integrations

?filter=integrations+co+%22SALESFORCE%22

integrations eq "SALESFORCE"

Exact match on SALESFORCE

?filter=integrations+eq+%22SALESFORCE%22

provider_ids co "3cedc292-4014-45e9-b7d9-8cb1695e1454"

Contains provider ID

?filter=provider_ids+co+%223cedc292-4014-45e9-b7d9-8cb1695e1454%22

labels co "requestable"

Contains label

?filter=labels+co+%22requestable%22

profile_type eq "13ddf132-0868-4330-a0a3-41b088f6a4dc"

Exact match on profile type

?filter=profile_type+eq+%2213ddf132-0868-4330-a0a3-41b088f6a4dc%22

Complex filters can be created using logical operators:

(integrations co "SALESFORCE" or integrations co "AWS") and profile_type eq "13ddf132-0868-4330-a0a3-41b088f6a4dc"

Filters use SCIM format with URL encoding. The co operator checks if a value is contained within an array, while eq requires an exact match.

Request Examples

List all access profiles:

curl -X GET "$BASE_URL/api/private/lifecycle_management/access_profiles" \
  -H "authorization: Bearer $VEZA_TOKEN"

Filter by integration type:

curl -X GET "$BASE_URL/api/private/lifecycle_management/access_profiles?filter=integrations+co+%22SALESFORCE%22" \
  -H "authorization: Bearer $VEZA_TOKEN"

Filter by multiple criteria:

curl -X GET "$BASE_URL/api/private/lifecycle_management/access_profiles?filter=%28integrations+co+%22SALESFORCE%22+or+integrations+co+%22AWS%22%29+and+profile_type+eq+%22a730b9cd-d600-4fb7-a803-8ab5b697c0b9%22" \
  -H "authorization: Bearer $VEZA_TOKEN"

Filter by labels:

curl -X GET "$BASE_URL/api/private/lifecycle_management/access_profiles?filter=labels+co+%22requestable%22" \
  -H "authorization: Bearer $VEZA_TOKEN"

Response Examples

Standard list response:

{
  "has_more": false,
  "next_page_token": "",
  "values": [
    {
      "id": "3a2371b6-95ec-4d9e-b95c-d75d51daa39b",
      "name": "Developer",
      "current_version_number": 1,
      "state": "RUNNING",
      "profile_type": "a730b9cd-d600-4fb7-a803-8ab5b697c0b9",
      "access_profiles_inherited": [
        "software-developers-profile-id"
      ],
      "access_profiles_inherited_by": [],
      "created_at": "2024-04-12T15:29:36.709931506Z",
      "created_by": "3cedc292-4014-45e9-b7d9-8cb1695e1454",
      "current_version": {
        "access_profile_id": "3a2371b6-95ec-4d9e-b95c-d75d51daa39b",
        "created_at": "2024-04-12T15:29:36.711717422Z",
        "created_by": "3cedc292-4014-45e9-b7d9-8cb1695e1454",
        "entities_to_create_relationships_to": [
          {
            "entity_type": "SalesforceGroup",
            "datasource_id": "sf-datasource-id",
            "entity_id": "veza-dev-ed:00GDp0000019laeMAA"
          }
        ],
        "inherit_entities_from_access_profiles": [
          "software-developers-profile-id"
        ],
        "state": "PUBLISHED",
        "updated_at": "2024-04-12T15:29:36.711717422Z",
        "version_number": 1
      },
      "description": "",
      "draft_version_number": 0,
      "inherited_by_other_profiles": false,
      "inherits_from_other_profiles": true,
      "integrations": [
        "SALESFORCE"
      ],
      "provider_ids": ["sf-provider-id"],
      "provider_external_ids": ["external-sf-id"],
      "labels": ["requestable", "development"],
      "updated_at": "2024-04-12T15:29:36.743000797Z",
      "used_by_workflow": false
    }
  ]
}

Response with entity_extra_info=true:

Detailed Response Structure

{
  "has_more": false,
  "next_page_token": "",
  "values": [
    {
      "id": "3a2371b6-95ec-4d9e-b95c-d75d51daa39b",
      "name": "Developer",
      "current_version_number": 1,
      "state": "RUNNING",
      "profile_type": "a730b9cd-d600-4fb7-a803-8ab5b697c0b9",
      "access_profiles_inherited": [
        "software-developers-profile-id"
      ],
      "access_profiles_inherited_by": [],
      "created_at": "2024-04-12T15:29:36.709931506Z",
      "created_by": "3cedc292-4014-45e9-b7d9-8cb1695e1454",
      "current_version": {
        "access_profile_id": "3a2371b6-95ec-4d9e-b95c-d75d51daa39b",
        "created_at": "2024-04-12T15:29:36.711717422Z",
        "created_by": "3cedc292-4014-45e9-b7d9-8cb1695e1454",
        "entities_to_create_relationships_to": [
          {
            "entity_type": "SalesforceGroup",
            "datasource_id": "lifecycle-manager-datasource-id",
            "extraction_datasource_id": "extraction-datasource-id", 
            "provider_id": "provider-id",
            "entity_name": "Developer Group",
            "provider_external_id": "external-provider-id",
            "sync_identity_action": {
              "policy_id": "policy-12345",
              "name": "salesforce_sync_action"
            }
          }
        ],
        "inherit_entities_from_access_profiles": [
          "software-developers-profile-id"
        ],
        "state": "PUBLISHED",
        "updated_at": "2024-04-12T15:29:36.711717422Z",
        "version_number": 1
      },
      "description": "",
      "draft_version_number": 0,
      "inherited_by_other_profiles": false,
      "inherits_from_other_profiles": true,
      "integrations": [
        "SALESFORCE"
      ],
      "provider_ids": ["provider-id"],
      "provider_external_ids": ["external-provider-id"],
      "labels": ["requestable", "development"],
      "updated_at": "2024-04-12T15:29:36.743000797Z",
      "used_by_workflow": false
    }
  ],
  "entities_to_create_relationships_to": [
    {
      "entity_type": "SalesforceGroup",
      "datasource_id": "lifecycle-manager-datasource-id",
      "extraction_datasource_id": "extraction-datasource-id",
      "provider_id": "provider-id",
      "entity_name": "Developer Group",
      "provider_external_id": "external-provider-id"
    }
  ]
}

PreviousCreate Access Profile NextUpdate Access Profile Labels

Last updated 2 months ago

Was this helpful?