| Ravi Teja | 4c549f6 | 2024-11-26 02:42:27 -0600 | [diff] [blame^] | 1 | description: > |
| 2 | This interface defines methods and properties required for Time-based |
| 3 | One-time Password (TOTP) multi-factor authentication at user manager level |
| 4 | to support multi-factor authentication. This interface implemented by each |
| 5 | user manager object to support TOTP based authenticators like google, |
| 6 | microsoft, etc. |
| 7 | |
| 8 | methods: |
| 9 | - name: SecretKeyRequired |
| 10 | description: > |
| 11 | This method checks whether google-authenticator secret key setup |
| 12 | required for the given user |
| 13 | parameters: |
| 14 | - name: UserName |
| 15 | type: string |
| 16 | description: > |
| 17 | This parameter shall be the valid user name |
| 18 | returns: |
| 19 | - name: Status |
| 20 | type: boolean |
| 21 | description: > |
| 22 | Returns true if given user needs to setup TOTP authenticator |
| 23 | secret key otherwise returns false. |
| 24 | errors: |
| 25 | - xyz.openbmc_project.User.Common.Error.UserNameDoesNotExist |