Get-FilesUser
List Users, or get one user by Id.
Syntax
List (Default)
Page
Continuation
Id
Description
List Users.
Show User.
Without -Page or -Continuation, the command writes each user of every page, loading one page at a time as the pipeline consumes them. -First and -Skip bound what it writes, and stopping the pipeline early, as Select-Object -First does, loads no further page. A failure on any page stops the command, so a partial listing is never taken for a complete one.
Examples
Example 1: List all users
Writes every user, loading one page at a time as the pipeline consumes them.
Example 2: Get one page at a time
Writes the first page as a FilesPage object, then the next page from its continuation.
Example 3: Get one user
Writes the user with that Id.
Parameters
-Cursor
Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
- Type:
System.String - Parameter sets:
List,Page
-PerPage
Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
- Type:
System.Int64 - Parameter sets:
List,Page
-SortBy
If set, sort records by the specified field in either asc or desc direction. Valid fields are site_id, workspace_id, company, name, disabled, authenticate_until, username, email, site_admin, last_desktop_login_at, last_login_at, password_validity_days or ssl_required. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-Filter
If set, return records where the specified field is equal to the supplied value. Valid fields are username, name, email, company, site_admin, password_validity_days, ssl_required, last_login_at, authenticate_until, not_site_admin, disabled, partner_id, primary_group_id or workspace_id. Valid field combinations are [ site_admin, username ], [ not_site_admin, username ], [ workspace_id, username ], [ company, name ], [ workspace_id, name ], [ workspace_id, email ], [ workspace_id, company ], [ workspace_id, site_admin ], [ workspace_id, not_site_admin ], [ workspace_id, disabled ], [ workspace_id, partner_id ], [ workspace_id, site_admin, username ], [ workspace_id, not_site_admin, username ], [ workspace_id, disabled, username ], [ workspace_id, partner_id, username ] or [ workspace_id, company, name ]. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-FilterGt
If set, return records where the specified field is greater than the supplied value. Valid fields are password_validity_days, last_login_at or authenticate_until. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-FilterGteq
If set, return records where the specified field is greater than or equal the supplied value. Valid fields are password_validity_days, last_login_at or authenticate_until. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-FilterPrefix
If set, return records where the specified field is prefixed by the supplied value. Valid fields are username, name, email or company. Valid field combinations are [ company, name ]. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-FilterLt
If set, return records where the specified field is less than the supplied value. Valid fields are password_validity_days, last_login_at or authenticate_until. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-FilterLteq
If set, return records where the specified field is less than or equal the supplied value. Valid fields are password_validity_days, last_login_at or authenticate_until. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-Ids
comma-separated list of User IDs Give the values as an array; the module joins them as the API expects.
- Type:
System.Int64[] - Parameter sets:
List,Page
-IncludeParentSiteUsers
Include users from the parent site.
- Type:
System.Boolean - Parameter sets:
List,Page
-Search
Searches for partial matches of name, username, or email.
- Type:
System.String - Parameter sets:
List,Page
-Id
User ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
-NoWorkspaceScope
Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
-Page
Writes the first page as one FilesPage object instead of writing every object. Pass its Continuation to -Continuation for the next page.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
Page(required)
-Continuation
Writes the page after the one this continuation came from, as one FilesPage object. A continuation loads its page once and belongs to the command, query and connection that produced it.
- Type:
FilesCom.PowerShell.FilesContinuation - Parameter sets:
Continuation(required)
-First
Writes at most this many objects. Once they are written, no further page is loaded.
- Type:
System.UInt64 - Parameter sets:
(All)
-Skip
Skips this many objects before writing any. The skipped objects are still loaded.
- Type:
System.UInt64 - Parameter sets:
(All)
-IncludeTotalCount
Writes a total count first. Files.com does not report list totals, so the count is marked as unknown.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
None. The command takes no pipeline input.
Outputs
FilesCom.PowerShell.Models.User: the user as Files.com returned it.FilesCom.PowerShell.FilesPage`1: with-Pageor-Continuation, one page of results and the continuation for the next.
Notes
Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.