SimpleUser REST API endpoint

GET

Get a sv:simpleUser for an external id.

Requires that the caller is the sv:simpleUser or is authorized to MANAGE_USERS on the sv:site.

Name	Type	Description
externalId	string	The external id for the sv:simpleUser

POST

Creates a sv:simpleUser with the provided external id.

Requires that the caller is authorized to MANAGE_USERS on the sv:site

Name	Type	Description	Since
externalId	string	The external id for the sv:simpleUser
properties	map	Optional key/value properties for the created user. Null valued properties will be ignored (since 8). Note that some keys are reserved, see Authentication properties section below.	4.5.2

Authentication properties

A sv:simpleUser can be a "web user" that has local authentication credentials. Such authentication data/settings can be set as properties using the reserved names described below.

Note! Two base requirements must also be met in order for the local authentication to actually be set:

1. The site must have creation of web users enabled (i.e. "allowWebUsers" property on sv:site must be true).
2. The request must be secure (https).

Property name	Type	Description
useLocalAuthentication	boolean	Whether or not to allow local authentication
localAuthenticationPassword	string	The local authentication password

Also note that it might take a short while (typically max 30 seconds) before a newly created web user will be able to login/authenticate for the first time.

Example URL

2.6cc338af1604bfd297cb489_externalPrincipalRepository/simpleuser

Example input (also using local authentication)

{
   "externalId": "lightsaberdude",
   "properties": {
      "name": "Boba Fett",
      "givenName": "Boba",
      "sn": "Fett",
      "title": "Hunter",
      "mail": "boba@fett.com",
      "useLocalAuthentication": true,
      "localAuthenticationPassword": "bf-starwars_78!"
   }
}