List Access Profile Members

View all members of a specific access profile version

Endpoint

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

Description

Lists all identities that are currently members of a specific Access Profile version. Members are identities that will receive (or have received) the entitlements defined in the Access Profile.

This endpoint returns details about each member, including:

  • Which identity is a member

  • How the membership was created (manually added, from birthright policy, etc.)

  • Associated workflow information

API Reference

get
Authorizations
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
Responses
200

OK

application/json
get
/api/private/lifecycle_management/access_profiles/{access_profile_id}/versions/{version_number}/members

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 Examples

Response Examples

Response Fields

Field
Type
Description

access_profile_id

string

ID of the access profile

access_profile_name

string

Name of the access profile

created_from

string

How the membership was created (typically "ACCESS_PROFILE_MEMBERSHIP")

identity_id

string

Unique identifier of the identity/user

identity_name

string

Display name of the identity/user

workflow

string

Associated workflow information (if any)

Member Sources: The created_from field indicates how the identity became a member of the access profile. Most manual additions show "ACCESS_PROFILE_MEMBERSHIP".

Response Structure: The complete API response also includes a values array containing full PolicyIdentity objects. This documentation focuses on the member_details array as it provides the most relevant information for managing access profile membership.

Last updated

Was this helpful?