Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

/ admin / userProfileGetList

  • Article
  • 1 minutes to read

Description

Invoke this operation to get a list of user profiles

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is slave
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The userProfileGetList method takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Attributes Description
name xs:string Optional Filter list by user’s Id or login Id or display name (handle) or first name or last name or group name or site name that starts with the specified string.
userType Array<accountUserType> Optional Filter list by type of user, can be any of ‘user’, ‘msp’, ‘basic’ or ‘guest’. If not specified then ‘user’, ‘msp’ and ‘basic’ types are returned.
accountStatus Array<accountStatusType> Optional Filter list by the specified account status type(s). If none specified then there is no filtering by account status type.
availabilityStatus numberType Optional Filter list by the specified availability status of the user.
onlineStatus onlineStatusType Optional Filter list by the specified online status of the user.
order userProfileListOrderBy Optional Specify the order of users in the list
pageInfo pageInfoType Optional Controls the paging. If element is not specified, paging is disabled.

Response Parameters

Name Type Attributes Description
userListItem Array<userProfileData> Optional The list of users
maxPages numberType Optional A number indicating the maximum number of pages that could be returned
maxItems numberType Optional A number indicating the maximum number of users in the whole resultset after applying the filters
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document