User - API | Coredination

The User object

Example

Get a user account

Get a specific user account by ID, UUID or e-mail address

Example

GET /user/john@example.com

Response

A user object.

Method: GET
URL: /customer/:id
Authentication: Key/Token
Response: User object

Update or create a user account

Update an existing user account or create it (if it doesn't exist and :id is a UUID).

When creating a user, it will become a member of the calling user's primary group or API key's authorized group.

Example

PUT /user/0847ed17-b060-4599-a38c-be9a8b9cbb34

{
	"fullName": "John Doe",
	"emailAddress": "john@example.com",
	"userName": "johnny",
	"phoneNo": "012-3456789",
	"avatarUrl": "http://url.to/avatar/image.png",
	"timeZone": "Australia/Sydney"
}

Response

The created/updated user object.

Method: PUT
URL: /customer/:id
Authentication: Key/Token
Request: User object
Response: User object

Delete a user account

Delete a user account.

Example

DELETE /user/0847ed17-b060-4599-a38c-be9a8b9cbb34

Method: DELETE
URL: /user/:id
Authentication: Key/Token
Response: Status code only