{"_id":"5bc48b4f9919d4000df5ea71","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5bc48b4f9919d4000df5ea7b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b8ec64c7ef0f4000350182a","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z","categories":["5bc48b4f9919d4000df5ea33","5bc48b4f9919d4000df5ea34","5bc48b4f9919d4000df5ea35","5bc48b4f9919d4000df5ea36","5bc48b4f9919d4000df5ea37","5bc48b4f9919d4000df5ea38","5bc48b4f9919d4000df5ea39","5bc48b4f9919d4000df5ea3a","5bc48b4f9919d4000df5ea3b","5bc48b4f9919d4000df5ea3c","5bc48b4f9919d4000df5ea3d","5bc48b4f9919d4000df5ea3e","5b34c737e0dca2000311de6a","5bc48b4f9919d4000df5ea3f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27.1 Release","version_clean":"8976.0.0-Tools","version":"8976-Tools"},"category":{"_id":"5bc48b4f9919d4000df5ea3e","project":"57336fd5a6a9c40e00e13a0b","version":"5bc48b4f9919d4000df5ea7b","__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","githubsync":"","__v":46,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-06-18T14:14:51.144Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"method":"delete","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/cp/user/<userId>?onbehalfofmid=</span>\n\n<hr>\n\n##Documentation\n\nThe BlueSnap Delete User API is a RESTful web service that enables you to delete an existing user associated with your account \"on-behalf\" of a separate but linked BlueSnap account. \n\n##Examples\n\n###Request Example\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note:\",\n  \"body\": \"If you need to manage an operation on behalf of a linked BlueSnap account, use the \\\"onbehalfofmid\\\" parameter.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X DELETE 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-d '\",\n      \"language\": \"curl\",\n      \"name\": \"Delete User\"\n    },\n    {\n      \"code\": \"curl -v -X DELETE 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-d '\",\n      \"language\": \"curl\",\n      \"name\": \"Delete 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\n##Example Descriptions\n\nFor details about the above examples, see:\n\n* [Delete User](https://developers.bluesnap.com/v8976-Tools/docs/delete-user-api#section-delete-user)\n* [Delete User on behalf of linked BlueSnap account](https://developers.bluesnap.com/v8976-Tools/docs/delete-user-api#section-delete-user-on-behalf-of-linked-bluesnap-account)\n\n###Delete User\nThis example shows a Delete User request.\n\n###Delete User on behalf of linked BlueSnap account\nThis example shows a Delete 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-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    \"0-0\": \"onbehalfofmid\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","excerpt":"","slug":"delete-user-api","type":"endpoint","title":"Delete User"}

Definition

https://sandbox.bluesnap.com/services/2/cp/user/<userId>?onbehalfofmid=


Documentation

The BlueSnap Delete User API is a RESTful web service that enables you to delete an existing user associated with your account "on-behalf" of a separate but linked BlueSnap account.

Examples

Request Example

Note:

If you need to manage an operation on behalf of a linked BlueSnap account, use the "onbehalfofmid" parameter.

curl -v -X DELETE https://sandbox.bluesnap.com/services/2/cp/user/23645623?onbehalfofmid=34234
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
curl -v -X DELETE https://sandbox.bluesnap.com/services/2/cp/user/23645623?onbehalfofmid=34234
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

Response Example

If successful, the response HTTP status code is 200 OK.

Example Descriptions

For details about the above examples, see:

Delete User

This example shows a Delete User request.

Delete User on behalf of linked BlueSnap account

This example shows a Delete 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.