Creating a User

This documentation is an older version of JasperReports Server Administration Guide. View the latest documentation.

Overview of JasperReports Server Administration
- Overview of Organizations
- Overview of the Repository
- Overview of Users and Roles
- Overview of Security
- Administrator Login
- Administrator Pages
Organization, User, and Role Management
- Managing Organizations
- Managing Users
- Managing Roles
Repository Administration
- Resource Types
- JasperReport Structure
- Managing Folders and Resources
- Multiple Organizations in the Repository
- Permissions
Resources in the Repository
- Data Sources
- Queries
- Input Controls
- Query-based Input Controls
- File Resources
Themes
- Introduction
- How Themes Work
- Administering Themes
- Working With CSS Files
Import and Export
- Import and Export Catalogs
- Setting the Import-Export Encryption Key
- Importing Unencrypted Catalogs
- Import and Export through the Web UI
- Import and Export through the Command Line
System Configuration
- Configuration Settings in the User Interface
- Configuring User Password Options
- Configuring the User Session Timeout
- Encrypting User Session Login
- Configuring CSRF Prevention
- Configuring Input Validation
- Defining a Cross-Domain Policy for Flash
- Configuring Ad Hoc
- Enabling Data Snapshots
- Configuring System Logs
- Configuring Amazon Web Services
- Configuring Domains
- Configuring JasperReports Library
- Configuring Input Control Behavior
- Configuring the Scheduler
- Configuring the Heartbeat
- Configuring the Online Help
Server Diagnostics
- Events Being Audited and Monitored
- Configuring Auditing and Monitoring
- Using the Audit Data
- Using the Monitoring Data
- Importing and Exporting Event Data
- Real-Time Diagnostics
- Exposing Diagnostics Through Jaspersoft’s JMX Agent
- Using the Diagnostic Data In Reports
- Excluding Diagnostic Attributes
- Disabling the Diagnostic Subsystem
Troubleshooting
Localization
Introduction
- REST Web Services Overview
- REST Authentication
- REST Server Information
- SOAP Web Services Overview
- SOAP Authentication
- Syntax of resourceDescriptor
REST v2 - Repository Services
- The v2/resources Service
- The_v2_domains_metadata_Service
- The v2/permissions Service
- The v2/export Service
  - Checking the Export State
  - Fetching the Export Output
- The v2/import Service
REST v2 - Report Services
- The v2/reports Service
- The v2/reportExecutions Service
- The v2/inputControls Service
- The v2/options Service
- The v2/jobs Service
- The v2/queryExecutor Service
- The v2/caches Service
REST v2 - Administration Services
- The v2/organizations Service
- The v2/users Service
- The v2/attributes Service
- The v2/roles Service
page
- The resources Service
- The resource Service
- Working with Dashboards
- Working with Virtual Data Sources
- Working with Domains
- The permission Service
  - Viewing Permissions
  - Setting Permissions
page
- The report Service
- The jobsummary Service
- The job Service
REST v1 - Administration Services
- The organization Service
- The user Service
- The attribute Service
- The role Service
page
- Request and Operation Result
- List Operation
- Get Operation
- Put Operation
- Delete Operation
- Move Operation
- Copy Operation
- Errors
- Implementation Suggestions
page
- Types Defined in the WSDL
- Operations in the Scheduling Service
  - Example Request and Operation Result
- Java Client Classes
SOAP - Domain Web Service
- Types Defined in the WSDL
- Operations in the Domain Service
SOAP - Web Services for Administration
- Types Defined in the WSDL
- Users and Roles
  - findUsers
  - page

To create a user account, put all required information in a user descriptor, and include it in a PUT request to the rest_v2/users service, with the intended user ID (username) specified in the URL.

•

In the community edition of the server, or commercial editions without organizations, use the first form of the URL.

•

In commercial editions with organizations, use the second URL to specify the user’s organization. When specifying the organization, use its unique ID, not its path. When logged in as the system admin (superuser), use the first URL to create users in the root organization.

To create a user, the user ID in the URL must be unique on the server or in the organization. If the user ID already exists, that user account will be modified, as described in section Modifying User Properties.

Method	URL
PUT	http://<host>:<port>/jasperserver[-pro]/rest_v2/users/userID http://<host>:<port>/jasperserver[-pro]/rest_v2/organizations/orgID/users/userID
Content-Type		Content
application/xml application/json		A user descriptor that includes at least the fullName and password for the user. The role ROLE_USER is automatically assigned to all users, so it does not need to be specified. Do not specify the following properties: username – Specified in the URL and cannot be modified in the descriptor. tenantID – Specified in the URL and cannot be modified in the descriptor. externallyDefined – Computed automatically by the server. previousPasswordChangeTime – Computed automatically by the server.
Return Value on Success			Typical Return Values on Failure
201 Created – The user was successfully created using the values in the descriptor. The response contains the full descriptor of the new user.			404 Not Found – When the organization ID cannot be resolved.

The descriptor sent in the request should contain all the properties you want to set on the new user, except for the username that is specified in the URL. To set roles on the user, specify them as a list of roles. The following example shows the descriptor in JSON format: