Description
To remove a Multi-Factor Authentication (MFA) channel from your DruID account, use this method.
It’s imperative to have a user logged in with an access token. This operation cannot be performed without an authenticated user. Before proceeding, familiarize yourself with OAuth2 APIs to understand the OAuth2 protocol and the significance of each token.
Please note that the system only permits the deletion of voluntary MFA channels.
Endpoint URL:
POST https://{your-endpoint-domain.com}/activityid/v1/mfa/delete
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 entry point | string | yes |
| Accept-Language | Language for this request | Locale | no |
Query string parameters
Request Example
| Parameter | Description | Type | Required | Value |
|---|---|---|---|---|
| actor.id | object_id of the logged user | string | yes | user id |
| actor.objectType | Type of the object which represents the actor. | string | yes | ‘person’ |
| verb | Verb used for deleting the MFA channel | string | yes | ‘delete’ |
| object.objectType | ObjectType represents the user | string | yes | ‘user’ |
| 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’ |
| context.mfa_channel | Name of the MFA channel | string | yes | ‘sms’ |
Response examples
Response: MFA Deleted Channel
| Parameter | Description | Type |
|---|---|---|
| result | Common http result | struct |
| result.status | Http code | integer |
| result.message | A description that describes the result of the operation | string |
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) |
| 417 | Error | MFA Error: There is a problem with MFA, you will receive a detailed error description |
| 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 |
| 200 | Success | MFA code deleted successfully |