Method FindUsersAsync
FindUsersAsync(PortalQueryParameters)
Finds portal users that match the query parameters specified.
Declaration
public Task<PortalQueryResultSet<PortalUser>> FindUsersAsync(PortalQueryParameters queryParams)Parameters
| Type | Name | Description |
|---|---|---|
| PortalQueryParameters | queryParams | The search parameters. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PortalQueryResultSet<PortalUser>> | The task object representing the asynchronous search users operation. |
Remarks
This method obtains a PortalQueryResultSet<T> object that contains PortalUser objects. Use the Results property to get the collection of PortalUser objects.
PortalUser objects are user accounts within ArcGIS Online (AGOL) or ArcGIS Portal. Users add content to AGOL/ArcGIS Portal in the form of maps, tools, and applications. This method allows searching for specific user accounts within ArcGIS Online (AGOL) or ArcGIS Portal and requires providing specific PortalQueryParameters to limit the scope of which users are returned.
You do not have to be a logged in user to get information from this method. You can gain this information from anonymous access. However, to obtain information about users in your organization that have a PortalAccess level of Private you need to use the AuthenticationManager by supplying the appropriate username/password credentials.
NOTE: While the FindUsersAsync(PortalQueryParameters) method does return an collection of PortalUser objects as result of the search operation, not all of the properties of the PortalUser objects will contain data. This is by design to protect certain confidential information about a user.
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.0 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 100.15 |
FindUsersAsync(PortalQueryParameters, CancellationToken)
Finds portal users that match the query parameters specified.
Declaration
public async Task<PortalQueryResultSet<PortalUser>> FindUsersAsync(PortalQueryParameters queryParams, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| PortalQueryParameters | queryParams | The search parameters. |
| CancellationToken | cancellationToken | A CancellationToken with which to cancel the operation if required. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PortalQueryResultSet<PortalUser>> | The task object representing the asynchronous search users operation. |
Remarks
This method obtains a PortalQueryResultSet<T> object that contains PortalUser objects. Use the Results property to get the collection of PortalUser objects.
PortalUser objects are user accounts within ArcGIS Online (AGOL) or ArcGIS Portal. Users add content to AGOL/ArcGIS Portal in the form of maps, tools, and applications. This method allows searching for specific user accounts within ArcGIS Online (AGOL) or ArcGIS Portal and requires providing specific PortalQueryParameters to limit the scope of which users are returned.
You do not have to be a logged in user to get information from this method. You can gain this information from anonymous access. However, to obtain information about users in your organization that have a PortalAccess level of Private you need to use the AuthenticationManager by supplying the appropriate username/password credentials.
NOTE: While the FindUsersAsync(PortalQueryParameters) method does return an collection of PortalUser objects as result of the search operation, not all of the properties of the PortalUser objects will contain data. This is by design to protect certain confidential information about a user.
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.0 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 100.14 |