Create a system user
"This endpoint allows you to create a new system user.
Default User State
The state of the user can be explicitly passed in or omitted. If state is omitted from the request, then the user will get created using the value returned from the Get an Organization endpoint. The default user state for manually created users is stored in settings.newSystemUserStateDefaults.manualEntry
These default state values can be changed in the admin portal settings or by using the Update an Organization endpoint.
Sample Request
curl -X POST https://console.jumpcloud.com/api/systemusers \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"username":"{username}",
"email":"{email_address}",
"firstname":"{Name}",
"lastname":"{Name}"
}'
Request
- Base URLhttps://console.jumpcloud.com/api
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Pass this query parameter when a client wants all validation errors to be returned with a detailed error response for the form field specified. The current form fields are allowed:
- password
Password validation flag
Use the password validation flag to receive details on a possible bad request response
?fullValidationDetails=password
Without the flag, default behavior will be a normal 400 with only a single validation string error
Expected Behavior
Clients can expect a list of validation error mappings for the validation query field in the details provided on the response:
{
"code": 400,
"message": "Password validation fail",
"status": "INVALID_ARGUMENT",
"details": [
{
"fieldViolationsList": [
{"field": "password", "description": "specialCharacter"}
],
'@type': 'type.googleapis.com/google.rpc.BadRequest',
},
],
},
Headers
Request body
Response
User added successfully
Changes
No recorded changes to this operation across all 1 revision of this API.