docs: Update API docs (#4209)
* docs: Update API docs * docs: Update content * docs: Update content * docs: Update content * docs: Fix typos and word choice * docs: Revisions, add graphic * Apply batch of suggestions from code review Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * docs: Deleting unnecessary content * docs: Clarify deleted items * docs: Add new limitation * docs: Remove list tokens section * docs: Update `list` command pages * Update website/content/docs/api-clients/api/index.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * docs: Remove new options from worker doc --------- Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
This commit is contained in:
1 parent
fa38d37ba7
commit
cffcc30eda
23 files changed
+432
-192
No files matched your search
@@ -40,5 +40,11 @@ The default value is `false`.
|
||||
- `-scope-id=<string>` - The scope that contains the users you want to list.
|
||||
The default value is `global`.
|
||||
You can also specify this value using the **BOUNDARY_SCOPE_ID** environment variable.
|
||||
- `list_token` (optional) - An opaque token that is returned from the previous `list` response.
|
||||
If you do not supply a value, pagination starts from the beginning.
|
||||
- `page_size` (optional) - An unsigned integer that indicates the number of items that should be included on the page of search results.
|
||||
If you do not provide a value, or if you provide a value of `0`, Boundary uses the default page size of 1000 items.
|
||||
If you configure it, the `page_size` value overrides the default page size.
|
||||
Controller administrators can also configure a `max_page_size` option that constrains the maximum page size a user can request.
|
||||
|
||||
@include 'cmd-option-note.mdx'
|
||||
Reference in new issue
Block a user