Access Profiles

Create, manage, and organize access profiles and profile types for identity lifecycle management

Veza Access Profiles are collections of entitlements that can be granted to users as part of their identity lifecycle management. These APIs enable you to create, manage, and organize access profiles and their types, which define what access should be granted in different roles or scenarios across your organization.

Access Profiles help you automate consistent access provisioning with:

• Reusable collections of entitlements across multiple systems

• Organized access by business roles, departments, or functions

• Managed access profile types with distinct configurations

• Versioned profiles for profile lifecycle management

Access Profile Types

Access Profile Types define categories of access profiles and their capabilities within Veza. They determine how access profiles can be configured and used.

Access Profiles

Access Profiles define specific sets of entitlements that can be granted to users. Each profile contains versions that allow for drafting and managing changes over time.

Version Handling

When retrieving Access Profiles via the API without specifying a version, Veza returns the published version by default.

To retrieve a specific version (including draft versions), include the version parameter in your API request.

Integrations

Integrations represent the available systems and platforms that can be used with Access Profiles for access management operations.

Endpoints

Use the following endpoints to interact with Access Profiles, Access Profile Types, and available integrations:

Access Profile Type Operations

Method	Endpoint	Description
POST	Create Access Profile Type	Creates a new access profile type
GET	List Access Profile Types	Retrieves all access profile types

Access Profile Operations

Method	Endpoint	Description
POST	Create Access Profile	Creates a new access profile
GET	List Access Profiles	Retrieves all access profiles with filtering options
PATCH	Update Access Profile Labels	Updates labels assigned to an access profile
PATCH	Update Access Profile Version	Updates a specific version of an access profile

Member Management Operations

Method	Endpoint	Description
GET	List Access Profile Members	Lists all members of a specific access profile version
PUT	Update Access Profile Members	Adds or removes members from an access profile version

Integration Operations

Method	Endpoint	Description
GET	List Available Integrations	Lists all integrations available for use with access profiles

Authentication

All Access Profile API requests require authentication. See API Authentication for details on how to authenticate with Veza APIs.

Getting Started

To get started with Access Profile APIs:

1. List available integrations to see what systems you can manage

2. List lifecycle management datasources to view enabled systems

3. Create an access profile type to define how access profiles will be configured

4. Create access profiles with the entitlements your users need

5. Add members to access profiles to grant access to users

6. Use policy APIs to automate when access profiles are assigned

Prerequisites: Before creating Access Profiles, ensure you have Access Profile Types configured and lifecycle management datasources enabled for your target systems.

Related Documentation

For more information about Access Profile concepts and features, see:

• Access Profiles

• Lifecycle Management Implementation

• Policy APIs