Skip to main content

How to Get my Tenant Id

This documentation shows you how to get your tenant id.

A Tenant Id is required when you are a multi tenant user.

How To​

Use the /user/tenants endpoint to get your available tenants

note

The api-key header is required

Learn more about api key authentication here

The /user/tenants endpoint returns a list of Tenants. Each tenant has the following structure

  • TenantId:
    The id that should be used for authentication.

  • TenantName:
    The name of the Tenant. Human friendly. Helps determine which tenant to use.

Using Tenant Id​

To begin authenticating against a tenant, you must include the TenantId in a header called tenant-id like so

curl --location --request GET 'https://api.user.zentrypass/user/me' --header 'api-key: [YOUR_API_KEY]' --header 'tenant-id: [YOUR_TENANT_ID]'

Workspace Users​

For Workspace users, when calling Zentry Pass APIs and there is a "Workspace Id" property, provide your Tenant Id.

All other users​

For all other users (Employers and Marketplace users), when calling Zentry Pass APIs and there is a "Tenant Id" property, provide your Tenant Id.

warning

If you manage multiple tenants, be sure to choose the correct tenant id.