Create a subscriber
POST
/api/v1/users
prm_users_create
Creates the account and its identity only. It does not activate a plan, take money or grant quota — binding profile_id here is metadata. Use the activation endpoint for the paid part.
debt_limit is tri-state and the two falsy values mean opposite things. Omitted or null is unlimited credit; 0 is no credit at all. Sending 0 to mean "no opinion" silently blocks every future debit.
نظرة سريعة
- المصادقة
- رمز موظّف أو جلسة
- تتطلب صلاحية
-
prm_users_createCreate users - حد المعدل
t_mutate
المعاملات
| المعامل | الوصف |
|---|---|
usernameمطلوب
body · string
|
Unique within the tenant, not globally. |
passwordمطلوب
body · string
|
The RADIUS password. Stored recoverable, because CHAP and MS-CHAPv2 need it that way. |
parent_id
body · integer
|
Owning manager. Defaults to the caller. A subscriber is never parent-less, and a named owner must be a manager the caller may act on. |
profile_id
body · integer
|
Plan to bind. Must be one the acting manager may actually assign. |
expiration
body · string
|
yyyy-MM-dd HH:mm:ss in UTC. |
debt_limit
body · number
|
Credit ceiling. Omitted or null is unlimited, 0 is no credit. |
portal_password
body · string
|
Optional portal-only password, hashed before storage and distinct from the RADIUS password above. |
custom_fields
body · object
|
Tenant-defined form values, validated against the user form schema. |
الأخطاء
| الرمز | متى تُرجَع |
|---|---|
ERR_VALIDATION400
|
username or password missing, bad expiration, unassignable or inactive plan, unknown parent or group |
ERR_CONFLICT409
|
the username is taken in this tenant, or the licence subscriber cap is reached |
ERR_LICENSE_BLOCKED403
|
the tenant's licence has expired |