---
title: "[LRO] Create a Key-based Private Client Group"
method: POST
path: "/pcgs/key-based"
tags: ["Configuration - User Management"]
---

# [LRO] Create a Key-based Private Client Group

`POST /pcgs/key-based`

Create a Key-based Private Client Group, including network policy, user, user group, SSID, etc.

## Query parameters

- `async` boolean

## Request body

- XiqInitKeyBasedPcgNetworkPolicyRequest — The request to create Key-based Private Client Group
  - `policy_name` string, required — The network policy name
  - `ssid_name` string, required — The SSID name
  - `users` XiqKeyBasedPcgUserBaseInfo[], required — The Key-based PCG users
    - `name` string, required — The user name of key based PCG, which could not share with other exist key based PCG
    - `email` string, required — The email for deliver key based PCG user password
    - `user_group_name` string, required — The user group name

## Response `200`

OK

- XiqKeyBasedPcg — The response of key based PCG data
  - `id` integer, required — The unique identifier
  - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
  - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
  - `org_id` integer — The organization identifier, valid when enabling HIQ feature
  - `policy_id` integer, required — The network policy ID
  - `policy_name` string, required — The network policy name
  - `ssid_name` string, required — The SSID name
  - `enabled` boolean, required — Enabled Key Based PCG
  - `users` XiqKeyBasedPcgUser[] — The XIQ key based PCG users
    - `name` string, required — The user name of key based PCG, which could not share with other exist key based PCG
    - `email` string, required — The email for deliver key based PCG user password
    - `user_group_name` string, required — The user group name
    - `id` integer, required — The user ID
    - `create_time` string, date-time, required — The create timestamp
    - `update_time` string, date-time, required — The create timestamp
    - `org_id` integer — The organization ID

---

[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/versions/5ff7ab84e8e8/schema)