مرجع عام

Users

كل نقاط النهاية في هذه المجموعة. افتح أي واحدة لعرض معاملاتها ومثال عملي عليها.

92 نقاط النهاية

Users

GET /api/v1/users List subscribers prm_users_index

One page of subscribers under the caller's authority. A manager without tenant-wide visibility sees only subscribers owned by their own manager subtree, and that scope is injected server-side, so a filter can narrow within it but never widen past it.

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_users_index View users
حد المعدل: user_list

The per-subscriber scan token (lookup_token) is deliberately absent from list rows. It is served by GET /users/{id} and GET /users/resolve only, because a page of a thousand rows is a bulk harvest of codes that each unlock a subscriber record.

المعاملات

المعامل	الوصف
`q` query · string	Searches username, email, first and last name, phone, contract id, national id and static IP. A purely numeric term also matches the subscriber id exactly.
`filter[enabled]` query · boolean	The admin suspend flag. Not the same thing as expired.
`filter[expired]` query · boolean	Subscription window has passed.
`filter[online]` query · boolean	An open RADIUS session exists right now.
`filter[profile_id]` query · integer	Bound plan.
`filter[parent_id]` query · integer	Owning manager. Ignored, not honoured, when it would widen a restricted caller's scope.
`filter[username_exact]` query · string	Case-insensitive exact username, for a caller that already knows the identity and wants one deterministic row instead of a page of substring hits.
`filter[expiring_within_days]` query · integer	Future expiries only.
`filter[created_from]` query · string	yyyy-MM-dd HH:mm:ss in UTC. A malformed value is a 400, not an ignored filter.

المعامل	الوصف
`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.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`form_name` body · string	Which custom-field schema to validate custom_fields against. Defaults to the user form.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`request_id`مطلوب body · string	Idempotency key, up to 255 characters, no colon or pipe. Reuse the same one on every retry of one intent.
`money_collected` body · boolean	Defaults to true.
`card_code` body · string	Required when method is card. The voucher must be in the caller's subtree.
`issue_invoice` body · boolean	Also record an invoice document. Skipped on a replay so a retry never double-issues.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`bytes` body · integer	Bytes to add. At least one of bytes or seconds must be present and positive.
`seconds` body · integer	Seconds to add.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`order`مطلوب body · array	Bucket ids in drain order. 0 is the main quota, not a missing value.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`parent_id`مطلوب body · integer	The new owning manager.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`amount`مطلوب body · number	Major units, a bare JSON number. 150.50, not "150.50" and not 15050.
`request_id`مطلوب body · string	Idempotency key.
`issue_invoice` body · boolean	Also record an invoice document. Skipped on a replay.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`items`مطلوب body · array	At least one line item.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`invoiceId`مطلوب path · integer	Invoice id.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`clear_period` body · boolean	Also null the period quota counters. Defaults to false.
`reason` body · string	Free-text note recorded on the quota-history audit row.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`profile_id` body · integer	Plan to price. Defaults to the subscriber's current plan.
`operation` body · enum	activate or extend. Defaults to activate.
`method` body · enum	manager_balance, user_balance, reward_points or card.
`units` body · integer	How many periods to buy.
`user_price` body · number	Retail price override. Silently ignored for a caller without the price-override permission, which then falls back to the plan or pricing-tree price.

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`filter[status]` query · string	Narrows to open or closed sessions.

Users

Users

مكتوب لتقرأه الأدوات الآلية أيضًا

جرّبه على شبكتك.