{"_id":"5b27be73ba1565000322328b","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5b197473be7bb50003d5dbd6","project":"57336fd5a6a9c40e00e13a0b","__v":2,"forked_from":"5addf90f94fe9d0003cd9d29","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z","categories":["5b197473be7bb50003d5db9c","5b197473be7bb50003d5db9d","5b197473be7bb50003d5db9e","5b197473be7bb50003d5db9f","5b197473be7bb50003d5dba0","5b197473be7bb50003d5dba1","5b197473be7bb50003d5dba2","5b197473be7bb50003d5dba3","5b197473be7bb50003d5dba4","5b197473be7bb50003d5dba5","5b197473be7bb50003d5dba6","5b27bded4799c70003f36389","5b34c737e0dca2000311de6a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"8976.0.0-Tools","version":"8976-Tools"},"category":{"_id":"5b27bded4799c70003f36389","project":"57336fd5a6a9c40e00e13a0b","version":"5b197473be7bb50003d5dbd6","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-06-18T14:13:01.902Z","from_sync":false,"order":11,"slug":"merchant-single-signon","title":"User Management"},"user":"5b155c2c3fbcd30003e76908","__v":56,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-06-18T14:15:15.954Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"method":"put","auth":"optional","params":[],"url":""},"isReference":false,"order":5,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/cp/user/<userId>?onbehalfofmid=</span>\n\n<hr>\n\n##Documentation\n\nThe Update User API enables you to update a user in your BlueSnap account or any of your linked accounts. As part of the update functionality you can add or remove [permissions](doc:user-permissions) from the user.\n\n###Request Content\n\nSend a JSON object, with the following:\n\n `firstName` *string* optional\n\n `lastName` *string* optional\n\n `email` *string* optional\n\n `password` *string* optional (if empty, a new password is generated)\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"Any of the permissions described in [User Permissions](doc:user-permissions) can be included with a value of \\\"true.\\\"\",\n \"title\": \"Note:\"\n}\n[/block]\n###Response Details\n\nIf successful, the response HTTP status code is 200 OK.\n\n<hr>\n\n##Examples\n\n###Request Example\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"If you need to manage an operation on behalf of a linked BlueSnap account, use the \\\"onbehalfofmid\\\" parameter.\",\n \"title\": \"Note:\"\n}\n[/block]\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/cp/userId \\\\\\n-H 'Content-Type: application/json' \\n-H 'Accept: application/json' \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\\n{\\n\\t\\\"userfirstName\\\": \\\"New\\\",\\n\\t\\\"userlastName\\\": \\\"User\\\",\\n\\t\\\"userEmail\\\": \\\"new.email:::at:::email.com\\\" ,\\n\\t\\\"userName\\\": \\\"finance 1234\\\", \\n\\t\\\"allowViewFinancialInfo\\\": true,\\n\\t\\\"allowReports\\\": false\\n}\",\n \"language\": \"curl\",\n \"name\": \"Update User\"\n },\n {\n \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/cp/user/23645623?onbehalfofmid=34234\\n-H 'Content-Type: application/json' \\n-H 'Accept: application/json' \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\\n{\\n\\t\\\"userEmail\\\": \\\"new.email@email.com\\\" ,\\n\\t\\\"allowViewFinancialInfo\\\": true,\\n\\t\\\"allowReports\\\": false\\n}\",\n \"language\": \"curl\",\n \"name\": \"Update User on behalf of linked BlueSnap account\"\n }\n ]\n}\n[/block]\n###Response Example\n\nIf successful, the response HTTP status code is 200 OK.\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n\\t\\\"userId\\\": \\\"1111001\\\",\\n\\t\\\"merchantId\\\": \\\"1111111111\\\",\\n\\t\\\"userfirstName\\\": \\\"New\\\",\\n\\t\\\"userlastName\\\": \\\"User\\\",\\n\\t\\\"userEmail\\\": \\\"new.email@email.com\\\",\\n\\t\\\"userName\\\": \\\"finance 1234\\\",\\n\\t\\\"allowViewFinancialInfo\\\": true\\n}\",\n \"language\": \"json\",\n \"name\": \"Update User Response: 200 OK\"\n }\n ]\n}\n[/block]\n##Example Descriptions\n\nFor details about the above examples, see:\n\n* [Update User](https://developers.bluesnap.com/v8976-Tools/docs/update-user-api#section-update-user)\n* [Update User on behalf of linked BlueSnap account](https://developers.bluesnap.com/v8976-Tools/docs/update-user-api#section-update-user-on-behalf-of-linked-bluesnap-account) \n\n###Update User\nThis example shows an Update User request with the `userId`, `merchantId`, `userfirstName`, `userlastName`, `userEmail`, and `userName` values set. You will want to use these values to update your user's information. This example also has the `allowViewFinancialInfo` permissions value set to \"true.\"\n\n###Update User on behalf of linked BlueSnap account\nThis example shows an Update User request on behalf of a linked BlueSnap account.\n\n###Parameter Reference\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Description\",\n \"0-0\": \"onbehalfofmid\",\n \"2-0\": \"lastName\",\n \"3-0\": \"email\",\n \"4-0\": \"password\",\n \"0-1\": \"Creates, updates, retrieves, or deletes users on behalf of a linked BlueSnap account\\n\\n**Note:** This parameter specifies the ID of the BlueSnap account that owns the user, which should be linked to the BlueSnap account executing the call.\",\n \"2-1\": \"Consists of 2 to 100 characters\\n\\n**Note:** Cannot contain the following symbols: <>!\\n\",\n \"3-1\": \"Consists of 4 to 100 characters\",\n \"4-1\": \"Consists of 6 to 20 characters, in any letter or number combination\\n\\n**Note:** The password is only returned in the response, if it was included in the request.\",\n \"1-0\": \"firstName\",\n \"1-1\": \"Consists of 2 to 100 characters\\n\\n**Note:** Cannot contain the following symbols: <>!\"\n },\n \"cols\": 2,\n \"rows\": 5\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"* Username: Unique name; 4 to 20 characters \\n* Password: 6 to 20 characters; allowed characters: a-z A-Z 0-9 _~!@#&$%^*()|'-\\n* Email: 4 to 100 characters\",\n \"title\": \"Parameter rules\"\n}\n[/block]","excerpt":"","slug":"update-user-api","type":"endpoint","title":"Update User"}putUpdate User
Definition
https://sandbox.bluesnap.com/services/2/cp/user/<userId>?onbehalfofmid=
Documentation
The Update User API enables you to update a user in your BlueSnap account or any of your linked accounts. As part of the update functionality you can add or remove permissions from the user.
Request Content
Send a JSON object, with the following:
firstName string optional
lastName string optional
email string optional
password string optional (if empty, a new password is generated)
Note:
Any of the permissions described in User Permissions can be included with a value of "true."
Note:
If you need to manage an operation on behalf of a linked BlueSnap account, use the "onbehalfofmid" parameter.
curl -v -X PUT https://sandbox.bluesnap.com/services/2/cp/userId \
-H 'Content-Type: application/json'
-H 'Accept: application/json'
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
{
"userfirstName": "New",
"userlastName": "User",
"userEmail": "new.email@email.com" ,
"userName": "finance 1234",
"allowViewFinancialInfo": true,
"allowReports": false
}curl -v -X PUT https://sandbox.bluesnap.com/services/2/cp/user/23645623?onbehalfofmid=34234
-H 'Content-Type: application/json'
-H 'Accept: application/json'
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
{
"userEmail": "new.email@email.com" ,
"allowViewFinancialInfo": true,
"allowReports": false
}{
"userId": "1111001",
"merchantId": "1111111111",
"userfirstName": "New",
"userlastName": "User",
"userEmail": "new.email@email.com",
"userName": "finance 1234",
"allowViewFinancialInfo": true
}Example Descriptions
For details about the above examples, see:
Update User
This example shows an Update User request with the userId, merchantId, userfirstName, userlastName, userEmail, and userName values set. You will want to use these values to update your user's information. This example also has the allowViewFinancialInfo permissions value set to "true."
Update User on behalf of linked BlueSnap account
This example shows an Update User request on behalf of a linked BlueSnap account.
Parameter Reference
Parameter
Description
onbehalfofmid
Creates, updates, retrieves, or deletes users on behalf of a linked BlueSnap account
Note: This parameter specifies the ID of the BlueSnap account that owns the user, which should be linked to the BlueSnap account executing the call.
firstName
Consists of 2 to 100 characters
Note: Cannot contain the following symbols: <>!
lastName
Consists of 2 to 100 characters
Note: Cannot contain the following symbols: <>!
Consists of 4 to 100 characters
password
Consists of 6 to 20 characters, in any letter or number combination
Note: The password is only returned in the response, if it was included in the request.
Parameter rules
- Username: Unique name; 4 to 20 characters
- Password: 6 to 20 characters; allowed characters: a-z A-Z 0-9 _~!@#&$%^*()|'-
- Email: 4 to 100 characters