> ## Documentation Index > Fetch the complete documentation index at: https://widgetic.com/llms.txt > Use this file to discover all available pages before exploring further. # widgetic api managed-users > 18 commands for the Managed Users operations of the REST API, generated from its OpenAPI description. `widgetic api managed-users ` runs the Managed Users operations of the REST API. It has 18 commands. Every command also takes [the flags every command takes](https://widgetic.com/docs/cli/commands/index.md). ## `widgetic api managed-users copy-preset-for-managed-user` Give a managed user a copy of one of your presets * Request: `POST /managed-users/{id}/presets/{key}/copy` * Operation: `copyPresetForManagedUser` (`widgetic api call copyPresetForManagedUser` runs it by that name) * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | The managed user to give the copy to (Widgetic's id for the user) | | `--key ` | text | yes | The key of the preset to copy | | `--idempotency-key ` | text | | Names this one request, so a repeat of it is carried out once. The CLI makes a key when this is left out and sends the same one on every try; give your own (a UUID is ideal) to repeat the call by hand later. | | `--name ` | text | | Names the copy. Left out, the copy is named after the preset's title, or the widget's own name. | | `--data ` | JSON, `@path` or `-` | | The whole request document as JSON, `@path` to a file that holds it, or `-` for standard input. The flags above override its keys. | The whole description and the schemas: `widgetic schema api managed-users copy-preset-for-managed-user`. ## `widgetic api managed-users create-composition-from-preset` Create a composition from one of your presets in one call * Request: `POST /managed-users/{id}/presets/{key}/composition` * Operation: `createCompositionFromPreset` (`widgetic api call createCompositionFromPreset` runs it by that name) * Works with any API key. | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | | | `--key ` | text | yes | | | `--idempotency-key ` | text | | Names this one request, so a repeat of it is carried out once. The CLI makes a key when this is left out and sends the same one on every try; give your own (a UUID is ideal) to repeat the call by hand later. | | `--name ` | text | | | | `--locale ` | text | | BCP-47 language tag stored on embed settings for the widget runtime | | `--data ` | JSON, `@path` or `-` | | The whole request document as JSON, `@path` to a file that holds it, or `-` for standard input. The flags above override its keys. | The whole description and the schemas: `widgetic schema api managed-users create-composition-from-preset`. ## `widgetic api managed-users create-managed-user` Create Managed User * Request: `POST /managed-users` * Operation: `createManagedUser` (`widgetic api call createManagedUser` runs it by that name) * Also written: `widgetic api managed-users create` * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--idempotency-key ` | text | | Names this one request, so a repeat of it is carried out once. The CLI makes a key when this is left out and sends the same one on every try; give your own (a UUID is ideal) to repeat the call by hand later. | | `--external-id ` | text | | Your own identifier for the managed user. Must be unique among the managed users you manage (409 otherwise); another partner using the same value does not matter. | | `--manager-id ` | uuid | | ID of the user who will manage this managed user. Defaults to your own user ID; a partner can only use their own ID (403 otherwise), only an admin can name another manager. | | `--data ` | JSON, `@path` or `-` | | The whole request document as JSON, `@path` to a file that holds it, or `-` for standard input. The flags above override its keys. | The whole description and the schemas: `widgetic schema api managed-users create-managed-user`. ## `widgetic api managed-users create-managed-user-editor-session` Create an editor session for a managed user * Request: `POST /managed-users/{id}/editor-sessions` * Operation: `createManagedUserEditorSession` (`widgetic api call createManagedUserEditorSession` runs it by that name) * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | The managed user the session is for (Widgetic's id for the user) | | `--surfaces ` | one of `files`, `editor`, `creator`, `workflows` | | The pieces of Widgetic's editor the session may drive. `files` is the media library (the File Browser: upload a file, list the files uploaded for this user); what a user uploads is kept in your own storage destination. | | `--expires-in-seconds ` | integer | | How long the session lasts, in seconds. It cannot be extended; make a new session when it ends. (default: 3600) | | `--allowed-origin ` | text | | Bind the session to one web page origin, such as `https://app.example.com` (no path; `http` is accepted only for `localhost`). | | `--max-credits ` | integer | | The most credits this session may spend on Widgetic's AI, one credit being one generation. Once the operations it ran have taken that many, the next one is refused (402, `EDITOR_SESSION_CREDIT_LIMIT_REACHED`) and the bro… | | `--data ` | JSON, `@path` or `-` | | The whole request document as JSON, `@path` to a file that holds it, or `-` for standard input. The flags above override its keys. | The whole description and the schemas: `widgetic schema api managed-users create-managed-user-editor-session`. ## `widgetic api managed-users delete-managed-user` Delete Managed User * Request: `DELETE /managed-users/{id}` * Operation: `deleteManagedUser` (`widgetic api call deleteManagedUser` runs it by that name) * Also written: `widgetic api managed-users delete` * Needs a partner API key (wgt\_prt\_…). * It deletes something, so it asks first; without a terminal it needs `--yes`. | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | ID of the managed user to delete | The whole description and the schemas: `widgetic schema api managed-users delete-managed-user`. ## `widgetic api managed-users get-all-managed-users` Get Managed Users * Request: `GET /managed-users` * Operation: `getAllManagedUsers` (`widgetic api call getAllManagedUsers` runs it by that name) * Also written: `widgetic api managed-users list` * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--page ` | integer | | Page number for pagination (default: 1) | | `--size ` | integer | | Number of items per page (default: 10) | | `--sort ` | text | | Sort field and direction, `:`. The field is `createdAt`, `updatedAt` or `externalId` (the snake\_case spellings `created_at`, `updated_at` and `external_id` work too); `asc` or `desc` alone sorts by… (default: createdAt:desc) | The whole description and the schemas: `widgetic schema api managed-users get-all-managed-users`. ## `widgetic api managed-users get-managed-user-by-id` Get Managed User By ID * Request: `GET /managed-users/{id}` * Operation: `getManagedUserById` (`widgetic api call getManagedUserById` runs it by that name) * Also written: `widgetic api managed-users get` * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | ID of the managed user to retrieve | The whole description and the schemas: `widgetic schema api managed-users get-managed-user-by-id`. ## `widgetic api managed-users get-managed-user-design-defaults` Read design defaults for one managed user * Request: `GET /managed-users/{id}/design-defaults` * Operation: `getManagedUserDesignDefaults` (`widgetic api call getManagedUserDesignDefaults` runs it by that name) * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | | The whole description and the schemas: `widgetic schema api managed-users get-managed-user-design-defaults`. ## `widgetic api managed-users get-managed-user-limits` Read monthly credit cap and usage for one managed user * Request: `GET /managed-users/{id}/limits` * Operation: `getManagedUserLimits` (`widgetic api call getManagedUserLimits` runs it by that name) * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | | The whole description and the schemas: `widgetic schema api managed-users get-managed-user-limits`. ## `widgetic api managed-users get-managed-user-storage-usage` Storage used by one managed user's uploads * Request: `GET /managed-users/{id}/storage-usage` * Operation: `getManagedUserStorageUsage` (`widgetic api call getManagedUserStorageUsage` runs it by that name) * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | | The whole description and the schemas: `widgetic schema api managed-users get-managed-user-storage-usage`. ## `widgetic api managed-users get-managed-user-usage` What a managed user's editor sessions spent * Request: `GET /managed-users/{id}/usage` * Operation: `getManagedUserUsage` (`widgetic api call getManagedUserUsage` runs it by that name) * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | The managed user whose usage you want (Widgetic's id for the user) | | `--start-date ` | text | | Start of the period, included: an ISO 8601 date (`2026-10-01`) or date-time with its offset (`2026-10-01T08:00:00Z`). Default: 30 days before `endDate`. | | `--end-date ` | text | | End of the period, not included, in the same forms. Default: now. It must be after `startDate`, by at most 366 days. | The whole description and the schemas: `widgetic schema api managed-users get-managed-user-usage`. ## `widgetic api managed-users get-managed-users-by-manager-id` Get Managed Users By Manager * Request: `GET /users/{managerId}/managed-users` * Operation: `getManagedUsersByManagerId` (`widgetic api call getManagedUsersByManagerId` runs it by that name) * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--manager-id ` | uuid | yes | ID of the manager | | `--page ` | integer | | Page number for pagination (default: 1) | | `--size ` | integer | | Number of items per page (default: 10) | | `--sort ` | text | | Sort field and direction, `:`. The field is `createdAt`, `updatedAt` or `externalId` (the snake\_case spellings `created_at`, `updated_at` and `external_id` work too); `asc` or `desc` alone sorts by… (default: createdAt:desc) | The whole description and the schemas: `widgetic schema api managed-users get-managed-users-by-manager-id`. ## `widgetic api managed-users list-managed-user-entries` List entries across a managed user's compositions * Request: `GET /managed-users/{id}/entries` * Operation: `listManagedUserEntries` (`widgetic api call listManagedUserEntries` runs it by that name) * Works with any API key. | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | | | `--composition-id ` | uuid | | | | `--table ` | text | | | | `--limit ` | integer | | (default: 25) | | `--order ` | one of `asc`, `desc` | | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same… (default: desc) | | `--since ` | date-time | | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. | | `--until ` | date-time | | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. | | `--cursor ` | text | | | | `--context ` | key=value (repeat the flag) | | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.=value` for columns whose names collide with reserved parameters. Repeat it for more than one. | | `--filter ` | key=value (repeat the flag) | | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). Repeat it for more than one. | The whole description and the schemas: `widgetic schema api managed-users list-managed-user-entries`. ## `widgetic api managed-users revoke-managed-user-editor-session` End one editor session of a managed user * Request: `DELETE /managed-users/{id}/editor-sessions/{sessionId}` * Operation: `revokeManagedUserEditorSession` (`widgetic api call revokeManagedUserEditorSession` runs it by that name) * Needs a partner API key (wgt\_prt\_…). * It deletes something, so it asks first; without a terminal it needs `--yes`. | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | The managed user the session is for | | `--session-id ` | uuid | yes | The `sessionId` of the session, from `createManagedUserEditorSession` | The whole description and the schemas: `widgetic schema api managed-users revoke-managed-user-editor-session`. ## `widgetic api managed-users revoke-managed-user-editor-sessions` End every editor session of a managed user * Request: `DELETE /managed-users/{id}/editor-sessions` * Operation: `revokeManagedUserEditorSessions` (`widgetic api call revokeManagedUserEditorSessions` runs it by that name) * Needs a partner API key (wgt\_prt\_…). * It deletes something, so it asks first; without a terminal it needs `--yes`. | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | The managed user whose sessions end | The whole description and the schemas: `widgetic schema api managed-users revoke-managed-user-editor-sessions`. ## `widgetic api managed-users set-managed-user-design-defaults` Set or clear design defaults for one managed user * Request: `PUT /managed-users/{id}/design-defaults` * Operation: `setManagedUserDesignDefaults` (`widgetic api call setManagedUserDesignDefaults` runs it by that name) * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | | | `--data ` | JSON, `@path` or `-` | | The whole request document as JSON, `@path` to a file that holds it, or `-` for standard input. The flags above override its keys. | The whole description and the schemas: `widgetic schema api managed-users set-managed-user-design-defaults`. ## `widgetic api managed-users set-managed-user-limits` Set or clear the monthly credit cap for one managed user * Request: `PUT /managed-users/{id}/limits` * Operation: `setManagedUserLimits` (`widgetic api call setManagedUserLimits` runs it by that name) * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | | | `--monthly-credits ` | integer | | | | `--data ` | JSON, `@path` or `-` | | The whole request document as JSON, `@path` to a file that holds it, or `-` for standard input. The flags above override its keys. | The whole description and the schemas: `widgetic schema api managed-users set-managed-user-limits`. ## `widgetic api managed-users update-managed-user` Update Managed User * Request: `PUT /managed-users/{id}` * Operation: `updateManagedUser` (`widgetic api call updateManagedUser` runs it by that name) * Also written: `widgetic api managed-users update` * Needs a partner API key (wgt\_prt\_…). | Flag | Takes | Required | What it does | | - | - | - | - | | `--id ` | uuid | yes | ID of the managed user to update | | `--idempotency-key ` | text | | Names this one request, so a repeat of it is carried out once. The CLI makes a key when this is left out and sends the same one on every try; give your own (a UUID is ideal) to repeat the call by hand later. | | `--external-id ` | text | | Updated external identifier for the managed user. Must be unique among the managed users you manage (409 otherwise). | | `--is-active` | switch | | Switch the managed user off (`false`) or back on (`true`). A managed user that is off keeps everything already filed under it, and that content can still be listed, but nothing new can be filed under it (… | | `--data ` | JSON, `@path` or `-` | | The whole request document as JSON, `@path` to a file that holds it, or `-` for standard input. The flags above override its keys. | The whole description and the schemas: `widgetic schema api managed-users update-managed-user`. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.