Date: Fri, 29 Mar 2024 15:20:37 +0000 (UTC) Message-ID: <1404870865.12695.1711725637141@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_12694_26693482.1711725637139" ------=_Part_12694_26693482.1711725637139 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Allows the search and retrieval of users.
Root Relation: Users
This resource supports the following methods: GET, POST
Retrieves all (or a subset) of users.
This method supports the OData parameters $filter, $top, $take, $orderby= and $inlinecount. See = OData Topic for more details.
For more details on expansions, please see the Expand help topic.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
An example of fetching all users.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
[ { "Id": "3464e9da-f1b7-49aa-87db-7e1eebfd17a5", "UserName": "joeb", "Email": "joeb@unknown.net", "FirstName": "Joe", "LastName": "Bloggs", "Phone": "(09)-555-999", "LastLogIn": null, "Enabled": true, "IsExternal": false, "Self": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5= ", "Links": [ { "Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd= 17a5/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd= 17a5/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd= 17a5/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd= 17a5/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd= 17a5/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd= 17a5/mailmessages", "Rel": "MailMessages" } ] }, { "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "UserName": "janed", "Email": "janed@unknown.net", "FirstName": "Jane", "LastName": "Doe", "Phone": "(09)-555-999", "LastLogIn": null, "Enabled": true, "IsExternal": false, "Self": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a9610= ", "Links": [ { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/mailmessages", "Rel": "MailMessages" } ] } ]
Status Code
200 - OK
An example of fetching a set of users by first name, by using the ODATA = $filter query parameter.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
$filter | FirstName eq 'Jane' | The ODATA $filter parameter, this query paramete= r should be url encoded i.e. $filter=3DFirstName%20eq%20'Jane'. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
[ { "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "UserName": "janed", "Email": "janed@unknown.net", "FirstName": "Jane", "LastName": "Doe", "Phone": "(09)-555-999", "LastLogIn": null, "Enabled": true, "IsExternal": false, "Self": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a9610= ", "Links": [ { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/mailmessages", "Rel": "MailMessages" } ] } ]
Status Code
200 - OK
Create a new user
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if request contained invalid data or wo= uld cause a conflict with an existing user record. |
404 - NotFound | Returned if user does not exists. |
An example of creating a new user.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Body
{ "UserName": "janed", "Email": "janed@unknown.net" }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 | |
Location | http://localhost/api/user/4bb709c2-e0e7-4a= f3-9f60-a045016a9610 |
Response Body
[ { "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "UserName": "janed", "Email": "janed@unknown.net", "FirstName": null, "LastName": null, "Phone": null, "LastLogIn": null, "Enabled": true, "IsExternal": false, "Self": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a9610= ", "Links": [ { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/mailmessages", "Rel": "MailMessages" } ] } ]
Status Code
201 - Created
An example of creating a new user.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Body
{ "UserName": "janed", "Email": "janed@unknown.net", "FirstName": "Jane", "LastName": "Doe", "Phone": "(09)-555-999", "Password": "Password123", "IsExternal": true }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 | |
Location | http://localhost/api/user/4bb709c2-e0e7-4a= f3-9f60-a045016a9610 |
Response Body
[ { "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "UserName": "janed", "Email": "janed@unknown.net", "FirstName": "Jane", "LastName": "Doe", "Phone": "(09)-555-999", "LastLogIn": null, "Enabled": true, "IsExternal": false, "Self": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a9610= ", "Links": [ { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/4bb709c2-e0e7-4af3-9f60-a045016a= 9610/mailmessages", "Rel": "MailMessages" } ] } ]
Status Code
201 - Created