---
title: "[LRO] Onboard Key-based PCG in network policy"
method: POST
path: "/pcgs/key-based/network-policy-{policyId}/:onboard"
tags: ["Configuration - User Management"]
---

# [LRO] Onboard Key-based PCG in network policy

`POST /pcgs/key-based/network-policy-{policyId}/:onboard`

Onboard a Key-based Private Client Group for a specific network policy.

## Path parameters

- `policyId` integer, required

## Query parameters

- `async` boolean

## Request body

- XiqOnboardKeyBasedPcgRequest — The payload to create Key Based PCG data(from exist network policy and SSID)
  - `ssid_name` string, required
  - `enabled` boolean, required — Enable the key based PCG
  - `user_ids` integer[], required — The request user IDs

## Response `200`

OK

- XiqOnboardKeyBasedPcgResponse — The response of key based pcg onboard
  - `policy_id` integer, required — The network policy ID
  - `ssid_name` string, required — The SSID name
  - `status` string, required — The status response

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/revisions/5ff7ab84e8e8/schema)