diff options
author | Antoine A <> | 2024-01-10 11:44:42 +0000 |
---|---|---|
committer | Antoine A <> | 2024-01-10 11:44:42 +0000 |
commit | d4c996a8b2f1241f2a99dfc1a5502e2c47e96d64 (patch) | |
tree | 2ef6982d3d7761e2a67c15966d2491a4092a7787 | |
parent | e6a0200c2106c679b0d016f834d569c9e2d44a5b (diff) | |
download | docs-d4c996a8b2f1241f2a99dfc1a5502e2c47e96d64.tar.gz docs-d4c996a8b2f1241f2a99dfc1a5502e2c47e96d64.tar.bz2 docs-d4c996a8b2f1241f2a99dfc1a5502e2c47e96d64.zip |
Allow account creation with 2FA by admin and improve error codes documentation
-rw-r--r-- | core/api-corebank.rst | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/core/api-corebank.rst b/core/api-corebank.rst index 2ef23096..32c15c97 100644 --- a/core/api-corebank.rst +++ b/core/api-corebank.rst @@ -167,8 +167,13 @@ Account Management payto_uri?: string; // If present, set the max debit allowed for this user - // Only admin can change this property. - debit_threshold?: Amount + // Only admin can set this property. + debit_threshold?: Amount; + + // If present, enables 2FA and set the TAN channel used for challenges + // Only admin can set this property, other user can reconfig their account + // after creation. + tan_channel?: TanChannel; // Deprecated use ``contact_data`` instead // will be removed in the next release @@ -204,7 +209,10 @@ Account Management * ``TALER_EC_BANK_REGISTER_PAYTO_URI_REUSE`` : payto URI already used. * ``TALER_EC_BANK_UNALLOWED_DEBIT`` : admin account does not have sufficient funds to grant bonus. * ``TALER_EC_BANK_RESERVED_USERNAME_CONFLICT`` : a reserved username was attempted, like ``admin`` or ``bank`` - * ``TALER_EC_BANK_NON_ADMIN_PATCH_DEBT_LIMIT``: a non-admin user has tried to change their debt limit. + * ``TALER_EC_BANK_NON_ADMIN_PATCH_DEBT_LIMIT`` : a non-admin user has tried to create an account with a customer debt limit. + * ``TALER_EC_BANK_NON_ADMIN_SET_TAN_CHANNEL`` : a non-admin user has tried to create an account with 2fa. + * ``TALER_EC_BANK_TAN_CHANNEL_NOT_SUPPORTED``: ``tan_channel`` is not supported, check bank config to find supported ones. + * ``TALER_EC_BANK_MISSING_TAN_INFO``: the user did not share any contact data where to send the TAN via ``tan_channel``. **Details:** @@ -294,7 +302,8 @@ Account Management :http:statuscode:`409 Conflict`: * ``TALER_EC_BANK_NON_ADMIN_PATCH_LEGAL_NAME`` : a non-admin user has tried to change their legal name. * ``TALER_EC_BANK_NON_ADMIN_PATCH_CASHOUT`` : a non-admin user has tried to change their cashout account. - * ``TALER_EC_BANK_NON_ADMIN_PATCH_DEBT_LIMIT``: a non-admin user has tried to change their debt limit. + * ``TALER_EC_BANK_NON_ADMIN_PATCH_DEBT_LIMIT`` : a non-admin user has tried to change their debt limit. + * ``TALER_EC_BANK_TAN_CHANNEL_NOT_SUPPORTED`` : ``tan_channel`` is not supported, check bank config to find supported ones. * ``TALER_EC_BANK_MISSING_TAN_INFO`` : the user did not share any contact data where to send the TAN via ``tan_channel``. |