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}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

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

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ admin / userGetProps

  • Article
  • 1 minutes to read

Description

Return the extensible properties currently set on a user account. With no name filter the full list is returned; if one or more name elements are supplied only those properties (if present) are returned.

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
sys.a.manageUsers
 --- --- ---

Request Parameters

The userGetProps 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
userId accountIdType Required The ID of the user whose properties are being requested.
name Array<xs:string> Optional Optional filter. Repeat to request a specific set of properties by name. When omitted, all properties on the user are returned.

Response Parameters

Name Type Attributes Description
properties Array<userPropType> Optional The properties matching the request. Empty if the user has no properties (or none of the requested names are present).
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document