---
source_url: https://www.pubnub.com/docs/admin-api/oem-customer-introduction
title: OEM Customer Introduction
---

# OEM Customer Introduction

> For AI agents: documentation index at https://www.pubnub.com/llms-full.txt

## Overview

PubNub's OEM (Original Equipment Manufacturer) Customer API enables partners to manage their end customers and their access to PubNub resources. This API is designed for partners who want to embed, rebrand, and offer PubNub capabilities as part of their own products.

## Key Concepts

### Customers

An OEM customer represents one of your end-users or organizations. Each customer is identified by:

* A unique internal customer ID assigned by PubNub
* An `externalId` that you define (URL-safe identifier from your system)
* A display name for organizational purposes

### Keysets

Keysets are PubNub's publish/subscribe key pairs. In the OEM model, you assign keysets to customers to grant them access to specific PubNub resources. Each customer can have multiple keysets assigned across different applications.

## Typical Workflow

1. **Create a customer** using the `POST /oem/customers` endpoint with your own `externalId`
2. **Assign keysets** to the customer either during creation or later via `POST /oem/customers/:customerId/keysets`
3. **Generate access tokens** for customer users to access embedded UI features (if using Illuminate or other embeddable interfaces)
4. **Manage customer resources** by listing, updating, or filtering by application

## Authorization

All endpoints in this group require partner-level authorizatoion. The authorized account must be added by Pubnub Team to OEM partner program. Please, contact Support to enroll.

For more information about PubNub OEM capabilities, visit: [https://www.pubnub.com/docs/illuminate/embed-illuminate-ui](https://www.pubnub.com/docs/illuminate/embed-illuminate-ui)

## [GET List all customers](https://www.pubnub.com/docs/admin-api/list-all-customers.md)

Retrieves a list of all OEM customers in your partner account with summary information.

## [POST Create a new customer](https://www.pubnub.com/docs/admin-api/create-a-new-customer.md)

Creates a new OEM customer record in your partner account.

## [GET Get customer by ID](https://www.pubnub.com/docs/admin-api/get-customer-by-id.md)

Retrieves detailed information about a specific OEM customer, including all their assigned keysets.

## [PUT Update customer](https://www.pubnub.com/docs/admin-api/update-customer.md)

Updates an existing OEM customer's display name.

## [GET List keysets for customer](https://www.pubnub.com/docs/admin-api/list-keysets-for-customer.md)

Retrieves all keysets assigned to a specific OEM customer.

## [GET Get customer by keyset](https://www.pubnub.com/docs/admin-api/get-customer-by-keyset.md)

Returns the owner of a specific keyset.

## [GET List applications for customer](https://www.pubnub.com/docs/admin-api/list-applications-for-customer.md)

Retrieves all PubNub applications that contain keysets assigned to a specific OEM customer.

## [POST Assign keysets to customer](https://www.pubnub.com/docs/admin-api/assign-keysets-to-customer.md)

Assigns one or more keysets to an existing OEM customer.

## [POST Issue customer access token](https://www.pubnub.com/docs/admin-api/issue-customer-access-token.md)

Issues a secure access token for an OEM customer user.
