Description
You have to call this method when you want to deregister (delete) a user in DruID Identity (CIAM).
The unsubscription of the user is not done immediately, but it is queued in a daily nightly unsubscription process, so the user has the possibility to cancel the unsubscription as long as the process has not been executed.
If you successfully log in an user in DRUID, you will receive an access_token (that you could use to call other resources that need an user session); you also get all information of the logged user.
Please, read first: https://dru-id.com/developers/apis/oauth-2/ to learn about Oauth2 protocol and the meaning of each token.
Endpoint URL:
POST https://{{graph_host}}/activityid/v1/user/unsubscribe
Request parameters
Parameter | Description | Type | Required |
---|---|---|---|
Authorization | “Bearer access_token” Literal text Bearer followed by access_token that is the user access token obtained from /oauth2/token endpoint | string | yes |
Content-Type | The type of content that will be used for requests to be JSON | string | yes |
Accept | The type of content that will be used for responses to be JSON | string | yes |
From | Name of the entrypoint | string | yes |
Accept-Language | Language for this request | Locale | no |
Query string parameters
Parameter | Description | Type | Required | Default value |
---|
Request example
Parameter | Description | Type | Required | Value |
---|---|---|---|---|
actor.id | Object ID of user who request action | string | yes | object_id |
actor.objectType | Type of the object which represents the actor. | string | yes | ‘user’ |
verb | Verb used for action | string | yes | ‘delete’ |
object.objectType | ObjectType represents the user | string | yes | ‘user’ |
context.reason | Reason writer by user for unsubscription | string | yes | |
source.id | Type of device doing the activity | string | yes | ‘unknown’ | ‘pc’ | ‘mobile’ | ‘tablet’ | ‘game_console’ | ‘itv’ |
source.objectType | Type of source | string | yes | ‘device’ |
Response examples
Response: Request success (Accepted)
Name | Type | Description |
---|---|---|
content | struct | Custom structure containing the result of the operation. |
content.reason | string | Reason for unsubscribing the user. |
content.app | string | App Id |
content.entrypoint | string | Entrypoint Id |
content.requestedOn | date | Timestamp representing the moment when the request took place. |
result | struct | Common http result |
result.status | integer | Http code |
Response codes
Code | Type | Description |
---|---|---|
400 | Error | Bad Request: The request could not be understood by the server due to malformed syntax |
401 | Error | Unauthorized: authentication is required and has failed or has not yet been provided (token is invalid, etc) |
409 | Error | Unsubcription already requested |
428 | Error | Precondition required: User need to configure MFA or needs to send a MFA code. Check the MFA API |
500 | Error | Internal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request |
504 | Error | Gateway TimeoutService can not contact with oauth server to do some internal operations |
202 | Success | Accepted: Unsubscription requested succesfully. |