Description
To update a Multi-Factor Authentication (MFA) channel in your DruID account, utilize this method.
It’s essential to have a user logged in with an access token. This operation cannot be performed without an authenticated user. Prior to proceeding, familiarize yourself with OAuth2 APIs to understand the OAuth2 protocol and the significance of each token.
Upon successfully updating the MFA channel, confirmation is required by sending a valid code through the validate code endpoint.
Endpoint URL:
POST https://{your-endpoint-domain.com}/activityid/v1/mfa/update
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 updating the MFA channel | string | yes | ‘update’ |
| object.objectType | ObjectType represents the user | string | yes | ‘user’ |
| object.password | Password of the user. it must be send plain | string | yes | user password |
| 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’ |
| context .mfa_channel_address | Address where to send the TOTP code. For instance, a phone number if the channel is SMS | string | no | ‘+34123123123’ |
Response examples
Response: MFA Updated Channel
| Parameter | Description | Type |
|---|---|---|
| content | Data receive with the response | struct |
| content.provider | The provider that generates the TOTP codes. | string |
| content.isMandatory | Whether the MFA has been created with mandatory scope | string |
| content.channel | The name of the channel that has been configured. | string |
| content.secret | Secret shared with the user, this secret would be used as a seed for generating the TOTP codes. This is the code that is commonly requested in the authentication apps if the QR code is not available. | string |
| content.qrUri | The “otpauth” complete URI representing the MFA channel. | string |
| content.printableQrUri | The “content.qrUri” but encoded to be printed in html. You can print it with by pasting this property in the “src” on an “img” tag` | long |
| 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 updated succesfully |