# Zip

### Overview

The Veza Zip integration enables you to discover and analyze Zip users, groups, and roles within the procurement orchestration platform.

The integration enables:

* Discovery of Zip users, groups, and roles
* Analysis of permission assignments and relationships
* Integration with Veza's unified identity security platform for Access Reviews, Access Intelligence, Separation of Duties, and more.

See [notes and supported entities](#notes-and-supported-entities) for more details.

### Configuring Zip

Before connecting to Veza, you need to generate an API key in Zip with the appropriate permissions:

1. Go to your Zip instance and log in.
2. Follow the instructions on the [Zip documentation](https://developers.ziphq.com/zipapidocs/docs/rest-api-info-authentication-api-key-creation-and-webhooks) to generate an API key.
3. When creating the API key, ensure it has read-only access to the following resources:
   * Users
   * User groups
   * Roles

#### Required Permissions

The API key must have the following permissions:

* `ReadOnlyUsers` - Allows read-only access to user information
* `ReadOnlyGroups` - Allows read-only access to group information
* `ReadOnlyRoles` - Allows read-only access to role information

These limited access permissions follow the principle of least privilege, ensuring the integration only has access to the specific data needed for identity analysis.

### Configuring Zip on the Veza Platform

To enable Veza to gather data from the Zip platform:

1. In Veza, go to the **Integrations** page.
2. Click *Add Integration* and search for Zip. Click on it and click **Next** to add an integration.
3. Enter the required information.
4. Click *Create Integration* to save the configuration.

| Field   | Notes                                              |
| ------- | -------------------------------------------------- |
| Name    | A friendly name to identify the unique integration |
| API Key | The API key created in the previous steps          |

### Notes and Supported Entities

The Zip integration supports the discovery of users, groups, and roles within your Zip environment. The integration extracts available attributes for these entities to provide comprehensive visibility into your Zip permissions structure.

#### Zip User

Zip users represent individual accounts in the Zip platform.

| Attribute    | Notes                       |
| ------------ | --------------------------- |
| `email`      | User email address          |
| `is_active`  | Account active status       |
| `managers`   | List of managers (if exist) |
| `department` | Department name (if exist)  |

#### Zip Group

Zip groups allow organization of users into logical collections for permission assignment.

Zip API does not provide additional group properties beyond basic identification information.

#### Zip Role

Zip roles define sets of permissions that can be assigned to users or groups.

Zip API does not provide additional role properties beyond basic identification information.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.veza.com/4yItIzMvkpAvMVFAamTf/integrations/integrations/zip.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.