Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Users Resource

Lauren Padia edited this page Mar 22, 2017 · 5 revisions

User Guide | Web Service API


Web API user Resources

Provides methods for users.

Endpoint Method Description
/users POST Creates a user.
/users/id/{userId} GET Returns the user having the given Id.
/users/username/{username} GET Returns the user having the given username
/users/{userId}/email PUT Update user email
/users/{userId}/privileged PUT Grants or revokes privileged permissions
/users/{userId}/preferences PUT User preferences

Create Users

Creates a new user.

Resource URL
/users

Available Version
2.0

HTTP Method
POST

Parameters

Name Type Description
body principaluser

User

Returns the user having the given Id.

Resource URL
/users/id/{userId}

Available Version
2.0

HTTP Method
GET

Parameters

Name Type Description
body principaluser

Username

Returns the user having the given username.

Resource URL
/users/id/{userId}

Available Version
2.0

HTTP Method
GET

Parameters

Name Type Description
body principaluser

Email

Update user email

Resource URL
/users/id/{userId}

Available Version
2.0

HTTP Method
PUT

Parameters

Name Type Description
body principaluser

Privileges

Grant or revoke privileged permissions

Resource URL
/users/id/{userId}

Available Version
2.0

HTTP Method
PUT

Parameters

Name Type Description
body principaluser

Preferences

User preferences

Resource URL
/users/id/{userId}

Available Version
2.0

HTTP Method
PUT

Parameters

Name Type Description
body principaluser