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 / userAddRole

  • Article
  • 1 minutes to read

Description

Invoke this operation to assign one or more roles to the specified user. When adding one or more roles for the application, if there are enough free subscriptions available for the application then this will also add application subscription for this user.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
  • Transactional database functions are used during this method when supported by the target database.
System Rights Database Rights Mail Rights Calendar Rights
sys.a.manageUsers
sys.a.updateUser
 --- --- ---

Request Parameters

The userAddRole method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
userId accountIdType Required The ID of the user you wish to assign roles to.
role Array<nameType> Required The name of the role to assign. If the application associated to the role(s) requires a user subscription, then each user being added will consume a subscription. If there are not enough free subscriptions available for assigment for the given application associated to the role(s), this operation will fail with an appropriate error.

Response Parameters

This method returns no response parameters.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document