Data Types

CreateUser Method

Description

Creates a user.

Usernames and email addresses must be unique across all users of all Skeddly accounts. Many email servers support "+ notation" to support unique passwords for a single inbox. For example, if the real email address was "user@example.com", then "user+skeddly@example.com" would forward to the same inbox. Essentially, everything between the "+" and "@" characters is ignored. Check with your IT team to see if your email servers support "+ notation".

HTTP Request

POST https://api.skeddly.com/api/Users/

Body

The body is a JSON structure with the following properties.

emailAddress

Email address for the new user. It must not already be used by another user.

Type: string

Required: Yes

managedPolicyIds

List of Managed Policy IDs to apply to the new user.

Type: Array of string

Required: No

password

Password for the new user.

Type: string

Required: Yes

username

Username for the new user.

Type: string

Required: Yes

Returns

A User object.

Sample Request

HTTP
Bash
HTTP
POST /api/Users HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>
Content-Type: application/json
‚Äč
{
"emailAddress": "user@example.com",
"managedPolicyIds": [
"full"
],
"username": "user1",
"password": "reallygoodpassword"
}
Bash
curl -X POST "https://api.skeddly.com/api/Users" \
-H "Authorization: AccessKey <api key>" \
-d emailAddress="user@example.com" \
-d username="user1" \
-d password="reallygoodpassword" \
-d managedPolicyIds[]=full

Sample Response

{
"emailAddress": "user@example.com",
"lastAccessDate": "2016-06-09T11:00:00Z",
"managedPolicies": [
{
"managedPolicyId": "full",
"name": "Full Access"
}
],
"mfaType": "none",
"status": "enabled",
"userId": "u-00000001",
"username": "user1"
}