{"_id":"56b5123585a6922300d1c506","user":"5582e90181672a3900bb4fc7","version":{"_id":"569f9cf6650e1d1900f96b5e","project":"569f9cf6650e1d1900f96b5b","__v":12,"createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","56abdd81d4432d1900eed235","56abe0558beeff0d003b8118","56ad2f8b1c09150d00a183a8","56ad4e1cd21f1b0d00fd2f97","56b00ad88f7a4f0d0029dc92","56b2432e9621f20d00efb2bd","56b25826147e900d00d6497a","56b7af2a4b372d2100722c48","56b8c4d938b1070d0028920f","56b8cdab14feef0d0082415d","58599813cf9e112d0032cdab"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":25,"category":{"_id":"56b25826147e900d00d6497a","project":"569f9cf6650e1d1900f96b5b","version":"569f9cf6650e1d1900f96b5e","pages":["56b2583a9621f20d00efb31c","56b25a3965ddf50d0076baa2","56b2738894ab060d0006743c","56b4d1cf5f1cf00d00cc46d7","56b4f4e2b1a8690d00a59369","56b4f6925f1cf00d00cc4704","56b4fa3d5997532100bc6bcc","56b50ba8eed075230097d71e","56b5123585a6922300d1c506","56b51e475997532100bc6c08","56b5220b7719bb1900143055","56b524cc3d5f130d00dad1b8","56b5265b168b5c1700c15996","56b774438fb4420d006a618b","56b78012eb783a0d007894f3","56b78292a6c10c0d00a2d65d","56b7863aeb783a0d007894f8","56b78f68a6c10c0d00a2d66b","56b794566c2a240d0094ae8a","56b7a85dd22adc0d0053f4c2","56b7ac118fb4420d006a61b7"],"__v":21,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-03T19:42:30.051Z","from_sync":false,"order":7,"slug":"user-methods","title":"User methods"},"githubsync":"","project":"569f9cf6650e1d1900f96b5b","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-05T21:20:53.992Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"## Syntax \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    <credentials object>, \\n    \\\"user\\\": <mailbox_name>, \\n    \\\"range\\\": {\\n       \\\"first\\\": <number>,\\n       \\\"limit\\\": <number> \\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request fields for get_user_changes\"\n}\n[/block]\nThe following fields can be used in the **get_user_changes** method:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Definition/Value\",\n    \"0-0\": \"range\",\n    \"0-1\": \"Optional\",\n    \"0-2\": \"The range of results to return. Allowed values are:\\n\\n  * **first**—The 0-based index of the first result to return.\\n\\n  * **limit**—The maximum number of results to return.\",\n    \"1-0\": \"user\",\n    \"1-1\": \"Required\",\n    \"1-2\": \"The name of the user's account.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response fields for get_user_changes\"\n}\n[/block]\nThe following fields may be returned in response to the **get_user_changes** method:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Description/Value\",\n    \"0-0\": \"changes\",\n    \"0-1\": \"Returned if **success = true**\",\n    \"0-2\": \"An array of hashes, one hash for each change returned. The array is sorted by the time of the change, with the earliest change listed first. For each change the following information is returned:\\n\\n  * **application**—The name of the application used to perform the change. \\n\\n  * **msg**—A brief summary of the change made. If the changed data is short, it is shown;; otherwise, the number of bytes in the new value is shown\\n  \\n  * **time**—The time that the change was made, in UNIX Epoch time.\\n  \\n  * **user**—The name of the user that performed the change. If the change was performed by the system, the user \\\"OpenSRS\\\" is shown.\",\n    \"1-0\": \"count\",\n    \"1-1\": \"Returned if **success = true**\",\n    \"1-2\": \"The number of items (changes) in the array.\",\n    \"2-0\": \"error\",\n    \"2-1\": \"Returned if **success = false**\",\n    \"2-2\": \"A text string that explains the error.\",\n    \"3-0\": \"error_number\",\n    \"3-1\": \"Returned if **success = false**\",\n    \"3-2\": \"A number that represents the error.\",\n    \"4-0\": \"success\",\n    \"4-1\": \"Always returned\",\n    \"4-2\": \"Indicates whether the request was successful or not. Allowed values are **true** and **false**.\",\n    \"5-0\": \"total_count\",\n    \"5-1\": \"Returned if **success = true**\",\n    \"5-2\": \"The total number of changes available.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples for get_user_changes\"\n}\n[/block]\n**Request** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"credentials\\\": {\\n    \\\"user\\\": \\\"domain_admin:::at:::example.com\\\",\\n    \\\"password\\\": \\\"pencil75\\\"\\n  },\\n  \\\"range\\\": {\\n    \\\"first\\\": 20,\\n    \\\"limit\\\": 10\\n  },\\n  \\\"user\\\": \\\"jane_user@example.com\\\"\\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n**Response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"success\\\": true,\\n  \\\"total_count\\\": 29,\\n  \\\"count\\\": 9,\\n  \\\"changes\\\": [\\n\\t\\t{\\n\\t\\t\\t\\\"msg\\\": \\\"changed default_sort_order [descending]\\\", \\n      \\\"time\\\": \\\"1321903552\\\",\\n\\t\\t\\t\\\"application\\\": \\\"OMA\\\",\\n\\t\\t\\t\\\"user\\\": \\\"domain_admin@example.com\\\"\\n\\t\\t}, \\n\\t\\t{\\n    \\t\\\"msg\\\": \\\"changed timezone [America/Montreal]\\\", \\n      \\\"time\\\": \\\"1321903552\\\",\\n\\t\\t\\t\\\"application\\\": \\\"OMA\\\",\\n\\t\\t\\t\\\"user\\\": \\\"domain_admin@example.com\\\"\\n    }, \\n\\t\\t{\\n    \\t\\\"msg\\\": \\\"changed language [en]\\\",\\n\\t\\t\\t\\\"time\\\": \\\"1321903552\\\",\\n\\t\\t\\t\\\"application\\\": \\\"OMA\\\",\\n\\t\\t\\t\\\"user\\\": \\\"domain_admin@example.com\\\"\\n    }, \\n\\t\\t{\\n    \\t\\\"msg\\\": \\\"changed name [Janet User]\\\",\\n\\t\\t\\t\\\"time\\\": \\\"1321903552\\\",\\n\\t\\t\\t\\\"application\\\": \\\"OMA\\\",\\n\\t\\t\\t\\\"user\\\": \\\"domain_admin@example.com\\\"\\n    }, \\n\\t\\t{\\n    \\t\\\"msg\\\": \\\"changed confirm_send [false]\\\", \\n      \\\"time\\\": \\\"1321903552\\\",\\n\\t\\t\\t\\\"application\\\": \\\"OMA\\\",\\n\\t\\t\\t\\\"user\\\": \\\"domain_admin@example.com\\\"\\n    }, \\n\\t\\t{\\n    \\t\\\"msg\\\": \\\"changed msgs_per_page [20]\\\", \\n      \\\"time\\\": \\\"1321903552\\\",\\n      \\\"application\\\": \\\"OMA\\\",\\n      \\\"user\\\": \\\"domain_admin@example.com\\\"\\n    }, \\n\\t\\t{\\n    \\t\\\"msg\\\": \\\"changed spamtag [[JUNK]]\\\",\\n\\t\\t\\t\\\"time\\\": \\\"1321903721\\\",\\n\\t\\t\\t\\\"application\\\": \\\"OMA\\\",\\n\\t\\t\\t\\\"user\\\": \\\"jane_user@example.com\\\"\\n    }, \\n\\t\\t{\\n    \\t\\\"msg\\\": \\\"changed sessions [32 bytes]\\\",\\n\\t\\t\\t\\\"time\\\": \\\"1321907872\\\",\\n\\t\\t\\t\\\"application\\\": \\\"OMA\\\",\\n\\t\\t\\t\\\"user\\\": \\\"domain_admin@example.com\\\"\\n    }, \\n\\t\\t{\\n    \\t\\\"msg\\\": \\\"changed block [*@badmail.com]\\\", \\n      \\\"time\\\": \\\"1327005780\\\",\\n\\t\\t\\t\\\"application\\\": \\\"mac:OMA\\\",\\n\\t\\t\\t\\\"user\\\": \\\"company_admin@example.adm\\\"\\n    } \\n  ]\\n}\\n\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]","excerpt":"The **get_user_changes** method retrieves a summary of the changes made to a user account.","slug":"get_user_changes","type":"basic","title":"get_user_changes"}

get_user_changes

The **get_user_changes** method retrieves a summary of the changes made to a user account.

## Syntax [block:code] { "codes": [ { "code": "{\n <credentials object>, \n \"user\": <mailbox_name>, \n \"range\": {\n \"first\": <number>,\n \"limit\": <number> \n}", "language": "perl", "name": " " } ] } [/block] [block:api-header] { "type": "basic", "title": "Request fields for get_user_changes" } [/block] The following fields can be used in the **get_user_changes** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Definition/Value", "0-0": "range", "0-1": "Optional", "0-2": "The range of results to return. Allowed values are:\n\n * **first**—The 0-based index of the first result to return.\n\n * **limit**—The maximum number of results to return.", "1-0": "user", "1-1": "Required", "1-2": "The name of the user's account." }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Response fields for get_user_changes" } [/block] The following fields may be returned in response to the **get_user_changes** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Description/Value", "0-0": "changes", "0-1": "Returned if **success = true**", "0-2": "An array of hashes, one hash for each change returned. The array is sorted by the time of the change, with the earliest change listed first. For each change the following information is returned:\n\n * **application**—The name of the application used to perform the change. \n\n * **msg**—A brief summary of the change made. If the changed data is short, it is shown;; otherwise, the number of bytes in the new value is shown\n \n * **time**—The time that the change was made, in UNIX Epoch time.\n \n * **user**—The name of the user that performed the change. If the change was performed by the system, the user \"OpenSRS\" is shown.", "1-0": "count", "1-1": "Returned if **success = true**", "1-2": "The number of items (changes) in the array.", "2-0": "error", "2-1": "Returned if **success = false**", "2-2": "A text string that explains the error.", "3-0": "error_number", "3-1": "Returned if **success = false**", "3-2": "A number that represents the error.", "4-0": "success", "4-1": "Always returned", "4-2": "Indicates whether the request was successful or not. Allowed values are **true** and **false**.", "5-0": "total_count", "5-1": "Returned if **success = true**", "5-2": "The total number of changes available." }, "cols": 3, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Examples for get_user_changes" } [/block] **Request** [block:code] { "codes": [ { "code": "{\n \"credentials\": {\n \"user\": \"domain_admin@example.com\",\n \"password\": \"pencil75\"\n },\n \"range\": {\n \"first\": 20,\n \"limit\": 10\n },\n \"user\": \"jane_user@example.com\"\n}", "language": "perl", "name": " " } ] } [/block] **Response** [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"total_count\": 29,\n \"count\": 9,\n \"changes\": [\n\t\t{\n\t\t\t\"msg\": \"changed default_sort_order [descending]\", \n \"time\": \"1321903552\",\n\t\t\t\"application\": \"OMA\",\n\t\t\t\"user\": \"domain_admin@example.com\"\n\t\t}, \n\t\t{\n \t\"msg\": \"changed timezone [America/Montreal]\", \n \"time\": \"1321903552\",\n\t\t\t\"application\": \"OMA\",\n\t\t\t\"user\": \"domain_admin@example.com\"\n }, \n\t\t{\n \t\"msg\": \"changed language [en]\",\n\t\t\t\"time\": \"1321903552\",\n\t\t\t\"application\": \"OMA\",\n\t\t\t\"user\": \"domain_admin@example.com\"\n }, \n\t\t{\n \t\"msg\": \"changed name [Janet User]\",\n\t\t\t\"time\": \"1321903552\",\n\t\t\t\"application\": \"OMA\",\n\t\t\t\"user\": \"domain_admin@example.com\"\n }, \n\t\t{\n \t\"msg\": \"changed confirm_send [false]\", \n \"time\": \"1321903552\",\n\t\t\t\"application\": \"OMA\",\n\t\t\t\"user\": \"domain_admin@example.com\"\n }, \n\t\t{\n \t\"msg\": \"changed msgs_per_page [20]\", \n \"time\": \"1321903552\",\n \"application\": \"OMA\",\n \"user\": \"domain_admin@example.com\"\n }, \n\t\t{\n \t\"msg\": \"changed spamtag [[JUNK]]\",\n\t\t\t\"time\": \"1321903721\",\n\t\t\t\"application\": \"OMA\",\n\t\t\t\"user\": \"jane_user@example.com\"\n }, \n\t\t{\n \t\"msg\": \"changed sessions [32 bytes]\",\n\t\t\t\"time\": \"1321907872\",\n\t\t\t\"application\": \"OMA\",\n\t\t\t\"user\": \"domain_admin@example.com\"\n }, \n\t\t{\n \t\"msg\": \"changed block [*@badmail.com]\", \n \"time\": \"1327005780\",\n\t\t\t\"application\": \"mac:OMA\",\n\t\t\t\"user\": \"company_admin@example.adm\"\n } \n ]\n}\n", "language": "perl", "name": " " } ] } [/block]