Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

All API calls require a valid access token to be provided in the Authorization field

Users controller

GET /odata/Users(id)

Retrieve the User object for the given id.

Returns:

200 on success, User object as JSON payload

404 on user not found

403 on unauthorized request

500 on exception


GET /odata/Users

Get all accessible user objects.  Administrators can see all users but otherwise only users in teams managed by the authenticated user will be visible.

OData query parameters can be used to filter results.

Returns:

200 on success, OData query result as JSON payload

403 on unauthorized request

500 on exception


POST /odata/Users

Create a new user object.  Body of request is a User object in JSON format.

Returns:

200 on success, body of response is the newly created User object (with populated Id field)

400 on invalid request: duplicate username or invalid fields

403 on unauthorized request

500 on exception


PATCH /odata/Users(id)

PUT /odata/Users(id)

Update the existing user object with the given id.  Body of request is a User object with the updated fields.  Id must be populated.

Returns:

204 on success

400 on invalid request: invalid fields or Id in body doesn't match the one provided in the URL.

403 on unauthorized request

404 on no such user

500 on exception


  • No labels