Date: Fri, 29 Mar 2024 11:30:54 +0000 (UTC) Message-ID: <1658719701.12003.1711711854125@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_12002_1653524455.1711711854123" ------=_Part_12002_1653524455.1711711854123 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Allows the retrieval of details for an individual user.
This resource supports the following methods: DELETE, GET, PUT
Deletes an existing user (requires that the user have no data associated= with them)
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 could not be completed (norm= ally if the user still has data associated with them). |
404 - NotFound | Returned if user does not exists. |
Delete a user (that has no data associated with them in Enterprise Teste= r).
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 96ED2FC6-BAB3-4AF3-9ADE-3C7039279A1D | ID of the user to delete |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Status Code
200 - OK
Retrieves a single user by ID.
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. |
404 - NotFound | Returned if user does not exists. |
Example of fetching a user
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Id": "96ed2fc6-bab3-4af3-9ade-3c7039279a1d", "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/96ed2fc6-bab3-4af3-9ade-3c7039279a1d", "Links": [ { "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/mailmessages", "Rel": "MailMessages" } ] }
Status Code
200 - OK
Updates an existing 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. |
Updating basic details of a user.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 96ED2FC6-BAB3-4AF3-9ADE-3C7039279A1D | ID of the user to update |
Request Body
{ "UserName": "joeb", "Email": "joeb@unknown.net", "FirstName": "Joe", "LastName": "Bloggs", "Phone": "(09)-555-999" }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Id": "96ed2fc6-bab3-4af3-9ade-3c7039279a1d", "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/96ed2fc6-bab3-4af3-9ade-3c7039279a1d", "Links": [ { "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/password", "Rel": "ChangePassword" }, { "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/permissions/global", "Rel": "GlobalPermissions" }, { "Title": "Group Memberships", "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/groups", "Rel": "Groups" }, { "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/notifications", "Rel": "Notifications" }, { "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/permissions/projects", "Rel": "ProjectPermissions" }, { "Href": "http://localhost/api/user/96ed2fc6-bab3-4af3-9ade-3c7039279a= 1d/mailmessages", "Rel": "MailMessages" } ] }
Status Code
200 - OK