DELETE login/users/:user id
From Social ID Developers
(Difference between revisions)
Renato.neves (Talk | contribs) (Created page with "== Description == Deletes an user. <span style="color: red">Important</span>: this API removes all user associated data, except datastore objects associated with this user i...") |
|||
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
| − | Deletes | + | Deletes a user. |
| − | + | ||
| − | + | ||
== Resource URL == | == Resource URL == | ||
| Line 21: | Line 19: | ||
== Authentication == | == Authentication == | ||
| − | This API requires | + | This API requires Login App authentication. See [[Authentication]]. |
| + | |||
| + | == Response == | ||
| + | |||
| + | === Response Status === | ||
| + | {| | ||
| + | ! align="left" width="200px" | ok (200) | ||
| + | | The user was deleted successfully. | ||
| + | |- | ||
| + | ! align="left" width="200px" | unauthorized (401) | ||
| + | | The authentication is wrong. See [[Authentication]]. | ||
| + | |- | ||
| + | ! align="left" width="200px" | forbidden (403) | ||
| + | | The Login App does not have access to this user. | ||
| + | |- | ||
| + | ! align="left" width="200px" | internal_server_error (500) | ||
| + | | An unknown error happened. | ||
| + | |} | ||
== Examples == | == Examples == | ||
Latest revision as of 16:51, 30 December 2021
Contents |
Description
Deletes a user.
Resource URL
DELETE https://api.socialidnow.com/v1/marketing/login/users/:user_id
Parameters
URL Parameters
| user_id | required | user identifier. |
|---|
Authentication
This API requires Login App authentication. See Authentication.
Response
Response Status
| ok (200) | The user was deleted successfully. |
|---|---|
| unauthorized (401) | The authentication is wrong. See Authentication. |
| forbidden (403) | The Login App does not have access to this user. |
| internal_server_error (500) | An unknown error happened. |
Examples
Request
curl -iX DELETE 'https://api.socialidnow.com/v1/marketing/login/users/:user_id' \ --user <api_id>:<api_secret>
Response
Response Headers
HTTP/1.1 200 OK Status: 200
