diff --git a/obp-api/src/main/scala/code/api/UKOpenBanking/v2_0_0/APIMethods_UKOpenBanking_200.scala b/obp-api/src/main/scala/code/api/UKOpenBanking/v2_0_0/APIMethods_UKOpenBanking_200.scala index 9593a3c554..37333138a6 100644 --- a/obp-api/src/main/scala/code/api/UKOpenBanking/v2_0_0/APIMethods_UKOpenBanking_200.scala +++ b/obp-api/src/main/scala/code/api/UKOpenBanking/v2_0_0/APIMethods_UKOpenBanking_200.scala @@ -39,7 +39,7 @@ object APIMethods_UKOpenBanking_200 extends RestHelper{ |Reads a list of bank accounts, with balances where required. |It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |This call is work in progress - Experimental! |""", @@ -73,7 +73,7 @@ object APIMethods_UKOpenBanking_200 extends RestHelper{ "UK Open Banking: Get Account Transactions", s""" |Reads account data from a given account addressed by “account-id”. - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |This call is work in progress - Experimental! |""", @@ -123,7 +123,7 @@ object APIMethods_UKOpenBanking_200 extends RestHelper{ |Reads a bank account, with balances where required. |It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |This call is work in progress - Experimental! |""", @@ -161,7 +161,7 @@ object APIMethods_UKOpenBanking_200 extends RestHelper{ |An AISP may retrieve the account balance information resource for a specific AccountId |(which is retrieved in the call to GET /accounts). | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |This call is work in progress - Experimental! |""", @@ -206,7 +206,7 @@ object APIMethods_UKOpenBanking_200 extends RestHelper{ |an AISP may optionally retrieve the account information resources in bulk. |This will retrieve the resources for all authorised accounts linked to the account-request. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |This call is work in progress - Experimental! |""", diff --git a/obp-api/src/main/scala/code/api/berlin/group/v1/APIMethods_BERLIN_GROUP_1.scala b/obp-api/src/main/scala/code/api/berlin/group/v1/APIMethods_BERLIN_GROUP_1.scala index d6b24dafbc..3c7b92fd2a 100644 --- a/obp-api/src/main/scala/code/api/berlin/group/v1/APIMethods_BERLIN_GROUP_1.scala +++ b/obp-api/src/main/scala/code/api/berlin/group/v1/APIMethods_BERLIN_GROUP_1.scala @@ -40,7 +40,7 @@ object APIMethods_BERLIN_GROUP_1 extends RestHelper{ |Reads a list of bank accounts, with balances where required. |It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |This endpoint is work in progress. Experimental! |""", @@ -98,7 +98,7 @@ object APIMethods_BERLIN_GROUP_1 extends RestHelper{ s""" |Reads account data from a given account addressed by “account-id”. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |This endpoint is work in progress. Experimental! |""", @@ -138,7 +138,7 @@ object APIMethods_BERLIN_GROUP_1 extends RestHelper{ "Berlin Group Read Account Transactions", s""" |Reads account data from a given account addressed by “account-id”. - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |This endpoint is work in progress. Experimental! |""", diff --git a/obp-api/src/main/scala/code/api/dynamic/entity/helper/DynamicEntityHelper.scala b/obp-api/src/main/scala/code/api/dynamic/entity/helper/DynamicEntityHelper.scala index 6df2c496f5..f4d6ae8d73 100644 --- a/obp-api/src/main/scala/code/api/dynamic/entity/helper/DynamicEntityHelper.scala +++ b/obp-api/src/main/scala/code/api/dynamic/entity/helper/DynamicEntityHelper.scala @@ -1,6 +1,6 @@ package code.api.dynamic.entity.helper -import code.api.util.APIUtil.{EmptyBody, ResourceDoc, authenticationRequiredMessage} +import code.api.util.APIUtil.{EmptyBody, ResourceDoc, userAuthenticationMessage} import code.api.util.ApiRole.getOrCreateDynamicApiRole import code.api.util.ApiTag._ import code.api.util.ErrorMessages.{InvalidJsonFormat, UnknownError, UserHasMissingRoles, UserNotLoggedIn} @@ -176,7 +176,7 @@ object DynamicEntityHelper { | |${methodRoutingExample(entityName)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Can do filter on the fields |e.g: /${entityName}?name=James%20Brown&number=123.456&number=11.11 @@ -208,7 +208,7 @@ object DynamicEntityHelper { | |${methodRoutingExample(entityName)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, dynamicEntityInfo.getSingleExample, @@ -236,7 +236,7 @@ object DynamicEntityHelper { | |${methodRoutingExample(entityName)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", dynamicEntityInfo.getSingleExampleWithoutId, @@ -266,7 +266,7 @@ object DynamicEntityHelper { | |${methodRoutingExample(entityName)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", dynamicEntityInfo.getSingleExampleWithoutId, @@ -293,7 +293,7 @@ object DynamicEntityHelper { | |${methodRoutingExample(entityName)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", dynamicEntityInfo.getSingleExampleWithoutId, @@ -324,7 +324,7 @@ object DynamicEntityHelper { | |${methodRoutingExample(entityName)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Can do filter on the fields |e.g: /${entityName}?name=James%20Brown&number=123.456&number=11.11 @@ -354,7 +354,7 @@ object DynamicEntityHelper { | |${methodRoutingExample(entityName)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, dynamicEntityInfo.getSingleExample, @@ -380,7 +380,7 @@ object DynamicEntityHelper { | |${methodRoutingExample(entityName)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", dynamicEntityInfo.getSingleExampleWithoutId, @@ -408,7 +408,7 @@ object DynamicEntityHelper { | |${methodRoutingExample(entityName)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", dynamicEntityInfo.getSingleExampleWithoutId, @@ -434,7 +434,7 @@ object DynamicEntityHelper { | |${methodRoutingExample(entityName)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", dynamicEntityInfo.getSingleExampleWithoutId, diff --git a/obp-api/src/main/scala/code/api/util/APIUtil.scala b/obp-api/src/main/scala/code/api/util/APIUtil.scala index 549d1188f7..2471e5c21f 100644 --- a/obp-api/src/main/scala/code/api/util/APIUtil.scala +++ b/obp-api/src/main/scala/code/api/util/APIUtil.scala @@ -1569,8 +1569,8 @@ object APIUtil extends MdcLoggable with CustomJsonFormats{ ) { // this code block will be merged to constructor. { - val authenticationIsRequired = authenticationRequiredMessage(true) - val authenticationIsOptional = authenticationRequiredMessage(false) + val authenticationIsRequired = userAuthenticationMessage(true) + val authenticationIsOptional = userAuthenticationMessage(false) val rolesIsEmpty = roles.map(_.isEmpty).getOrElse(true) // if required roles not empty, add UserHasMissingRoles to errorResponseBodies @@ -2158,10 +2158,10 @@ object APIUtil extends MdcLoggable with CustomJsonFormats{ } - def authenticationRequiredMessage(authRequired: Boolean) : String = - authRequired match { - case true => "Authentication is Mandatory" - case false => "Authentication is Optional" + def userAuthenticationMessage(userAuthRequired: Boolean) : String = + userAuthRequired match { + case true => "User Authentication is Mandatory" + case false => "User Authentication is Optional" } diff --git a/obp-api/src/main/scala/code/api/v1_2_1/APIMethods121.scala b/obp-api/src/main/scala/code/api/v1_2_1/APIMethods121.scala index 0c7c52dc83..f9bd3a1740 100644 --- a/obp-api/src/main/scala/code/api/v1_2_1/APIMethods121.scala +++ b/obp-api/src/main/scala/code/api/v1_2_1/APIMethods121.scala @@ -220,7 +220,7 @@ trait APIMethods121 { s"""Returns the list of accounts at that the user has access to at all banks. |For each account the API returns the account ID and the available views. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, accountJSON, @@ -316,7 +316,7 @@ trait APIMethods121 { s"""Returns the list of accounts at BANK_ID that the user has access to. |For each account the API returns the account ID and the available views. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """, EmptyBody, @@ -349,7 +349,7 @@ trait APIMethods121 { s"""Returns the list of private accounts at BANK_ID that the user has access to. |For each account the API returns the ID and the available views. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -422,7 +422,7 @@ trait APIMethods121 { | |More details about the data moderation by the view [here](#1_2_1-getViewsForBankAccount). | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to `true`. | @@ -460,7 +460,7 @@ trait APIMethods121 { s"""Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account' | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, updateAccountJSON, @@ -527,7 +527,7 @@ trait APIMethods121 { | |Returns the list of the views created for account ACCOUNT_ID at BANK_ID. | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view.""", + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view.""", EmptyBody, viewsJSONV121, List(UserNotLoggedIn, BankAccountNotFound, UnknownError, "user does not have owner access"), @@ -563,7 +563,7 @@ trait APIMethods121 { "Create View", s"""#Create a view on bank account | - | ${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + | ${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | The 'alias' field in the JSON can take one of three values: | | * _public_: to use the public alias if there is one specified for the other account. @@ -628,7 +628,7 @@ trait APIMethods121 { "Update View", s"""Update an existing view on a bank account | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | |The json sent is the same as during view creation (above), with one difference: the 'name' field |of a view is not editable (it is only set when a view is created)""", @@ -738,7 +738,7 @@ trait APIMethods121 { "Get access", s"""Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to. | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view.""", + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view.""", EmptyBody, permissionsJSON, List(UserNotLoggedIn, UnknownError), @@ -776,7 +776,7 @@ trait APIMethods121 { s"""Returns the list of the views at BANK_ID for account ACCOUNT_ID that a USER_ID at their provider PROVIDER_ID has access to. |All url parameters must be [%-encoded](http://en.wikipedia.org/wiki/Percent-encoding), which is often especially relevant for USER_ID and PROVIDER_ID. | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view.""", + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view.""", EmptyBody, viewsJSONV121, List( @@ -823,7 +823,7 @@ trait APIMethods121 { | |All url parameters must be [%-encoded](http://en.wikipedia.org/wiki/Percent-encoding), which is often especially relevant for PROVIDER_ID and PROVIDER. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |The User needs to have access to the owner view.""", viewIdsJson, @@ -872,7 +872,7 @@ trait APIMethods121 { | |All url parameters must be [%-encoded](http://en.wikipedia.org/wiki/Percent-encoding), which is often especially relevant for PROVIDER and PROVIDER_ID. | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | |Granting access to a public view will return an error message, as the user already has access.""", EmptyBody, // No Json body required @@ -935,7 +935,7 @@ trait APIMethods121 { | |$generalRevokeAccessToViewText | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view.""", + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view.""", EmptyBody, EmptyBody, List( @@ -973,7 +973,7 @@ trait APIMethods121 { | |$generalRevokeAccessToViewText | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view.""", + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view.""", EmptyBody, EmptyBody, List( @@ -1007,7 +1007,7 @@ trait APIMethods121 { "/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts", "Get Other Accounts of one Account", s"""Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID. - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view VIEW_ID is not public.""", EmptyBody, otherAccountsJSON, @@ -1039,7 +1039,7 @@ trait APIMethods121 { "/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID", "Get Other Account by Id", s"""Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID. - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public.""", EmptyBody, otherAccountJSON, @@ -1105,8 +1105,8 @@ trait APIMethods121 { "/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias", "Get public alias of other bank account", s"""Returns the public alias of the other account OTHER_ACCOUNT_ID. - |${authenticationRequiredMessage(false)} - |${authenticationRequiredMessage(true)} if the view is not public.""", + |${userAuthenticationMessage(false)} + |${userAuthenticationMessage(true)} if the view is not public.""", EmptyBody, aliasJSON, List( @@ -1148,7 +1148,7 @@ trait APIMethods121 { "Add public alias to other bank account", s"""Creates the public alias for the other account OTHER_ACCOUNT_ID. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public. | |Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if @@ -1206,7 +1206,7 @@ trait APIMethods121 { "Update public alias of other bank account", s"""Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public.""", aliasJSON, successMessage, @@ -1259,7 +1259,7 @@ trait APIMethods121 { "Delete Counterparty Public Alias", s"""Deletes the public alias of the other account OTHER_ACCOUNT_ID. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public.""", EmptyBody, EmptyBody, @@ -1307,7 +1307,7 @@ trait APIMethods121 { "Get Other Account Private Alias", s"""Returns the private alias of the other account OTHER_ACCOUNT_ID. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public.""", EmptyBody, aliasJSON, @@ -1351,7 +1351,7 @@ trait APIMethods121 { "Create Other Account Private Alias", s"""Creates a private alias for the other account OTHER_ACCOUNT_ID. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public.""", aliasJSON, successMessage, @@ -1403,7 +1403,7 @@ trait APIMethods121 { "Update Counterparty Private Alias", s"""Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public.""", aliasJSON, successMessage, @@ -1455,7 +1455,7 @@ trait APIMethods121 { "Delete Counterparty Private Alias", s"""Deletes the private alias of the other account OTHER_ACCOUNT_ID. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public.""", EmptyBody, EmptyBody, @@ -2456,7 +2456,7 @@ trait APIMethods121 { "Get Transaction by Id", s"""Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and [moderated](#1_2_1-getViewsForBankAccount) by the view (VIEW_ID). | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public. | | @@ -2529,7 +2529,7 @@ trait APIMethods121 { |Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views. |If you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative). | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public. |""", transactionNarrativeJSON, @@ -2803,7 +2803,7 @@ trait APIMethods121 { "Add a Transaction Tag", s"""Posts a tag about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Authentication is required as the tag is linked with the user.""", postTransactionTagJSON, @@ -2923,7 +2923,7 @@ trait APIMethods121 { "Add a Transaction Image", s"""Posts an image about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID. | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | |The image is linked with the user.""", postTransactionImageJSON, @@ -3048,7 +3048,7 @@ trait APIMethods121 { "Add a Transaction where Tag", s"""Creates a "where" Geo tag on a transaction TRANSACTION_ID in a [view](#1_2_1-getViewsForBankAccount). | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |The geo tag is linked with the user.""", postTransactionWhereJSON, @@ -3094,7 +3094,7 @@ trait APIMethods121 { "Update a Transaction where Tag", s"""Updates the "where" Geo tag on a transaction TRANSACTION_ID in a [view](#1_2_1-getViewsForBankAccount). | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |The geo tag is linked with the user.""", postTransactionWhereJSON, @@ -3140,7 +3140,7 @@ trait APIMethods121 { "Delete a Transaction Tag", s"""Deletes the where tag of the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount). | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |The user must either have owner privileges for this account, or must be the user that posted the geo tag.""", EmptyBody, diff --git a/obp-api/src/main/scala/code/api/v1_4_0/APIMethods140.scala b/obp-api/src/main/scala/code/api/v1_4_0/APIMethods140.scala index ee4c3e4b4a..50867371bd 100644 --- a/obp-api/src/main/scala/code/api/v1_4_0/APIMethods140.scala +++ b/obp-api/src/main/scala/code/api/v1_4_0/APIMethods140.scala @@ -41,7 +41,7 @@ import scala.collection.mutable.ArrayBuffer // So we can include resource docs from future versions //import code.api.v1_4_0.JSONFactory1_4_0._ import code.api.ResourceDocs1_4_0.SwaggerDefinitionsJSON._ -import code.api.util.APIUtil.{ResourceDoc, authenticationRequiredMessage, _} +import code.api.util.APIUtil._ import code.api.util.ErrorMessages import code.api.util.ErrorMessages._ import code.crm.CrmEvent @@ -222,7 +222,7 @@ trait APIMethods140 extends MdcLoggable with APIMethods130 with APIMethods121{ | |You can use the url query parameters *limit* and *offset* for pagination | - |${authenticationRequiredMessage(!getBranchesIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getBranchesIsPublic)}""".stripMargin, EmptyBody, branchesJson, List( @@ -274,7 +274,7 @@ trait APIMethods140 extends MdcLoggable with APIMethods130 with APIMethods121{ | |${urlParametersDocument(false,false)} | - |${authenticationRequiredMessage(!getAtmsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getAtmsIsPublic)}""".stripMargin, EmptyBody, atmsJson, List( @@ -332,7 +332,7 @@ trait APIMethods140 extends MdcLoggable with APIMethods130 with APIMethods121{ |* Description |* Terms and Conditions |* License the data under this endpoint is released under - |${authenticationRequiredMessage(!getProductsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getProductsIsPublic)}""".stripMargin, EmptyBody, productsJson, List( @@ -486,7 +486,7 @@ trait APIMethods140 extends MdcLoggable with APIMethods130 with APIMethods121{ |This call may require additional permissions/role in the future. |For now the authenticated user can create at most one linked customer. |Dates need to be in the format 2013-01-21T23:08:00Z - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } |Note: This call is depreciated in favour of v.2.0.0 createCustomer |""", code.api.ResourceDocs1_4_0.SwaggerDefinitionsJSON.createCustomerJson, diff --git a/obp-api/src/main/scala/code/api/v2_0_0/APIMethods200.scala b/obp-api/src/main/scala/code/api/v2_0_0/APIMethods200.scala index 17e39e749d..ea4ab1d0ab 100644 --- a/obp-api/src/main/scala/code/api/v2_0_0/APIMethods200.scala +++ b/obp-api/src/main/scala/code/api/v2_0_0/APIMethods200.scala @@ -177,7 +177,7 @@ trait APIMethods200 { |Returns the list of accounts at that the user has access to at all banks. |For each account the API returns the account ID and the available views. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -211,7 +211,7 @@ trait APIMethods200 { |Returns the list of accounts containing private views for the user at all banks. |For each account the API returns the ID and the available views. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -254,7 +254,7 @@ trait APIMethods200 { |Returns accounts that contain at least one public view (a view where is_public is true) |For each account the API returns the ID and the available views. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |""".stripMargin, EmptyBody, @@ -292,7 +292,7 @@ trait APIMethods200 { |For each account the API returns the account ID and the views available to the user.. |Each account must have at least one private View. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} """.stripMargin, EmptyBody, basicAccountsJSON, @@ -336,7 +336,7 @@ trait APIMethods200 { | |This call MAY have an alias /bank/accounts but ONLY if defaultBank is set in Props | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -408,7 +408,7 @@ trait APIMethods200 { |If you want less information about the account, use the /my accounts call | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -446,7 +446,7 @@ trait APIMethods200 { "Get Public Accounts at Bank", s"""Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |""".stripMargin, EmptyBody, @@ -479,7 +479,7 @@ trait APIMethods200 { s"""Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID |Get a list of documents that affirm the identity of the customer |Passport, driving licence etc. - |${authenticationRequiredMessage(false)}""".stripMargin, + |${userAuthenticationMessage(false)}""".stripMargin, EmptyBody, kycDocumentsJSON, List(UserNotLoggedIn, CustomerNotFoundByCustomerId, UnknownError), @@ -516,7 +516,7 @@ trait APIMethods200 { "Get KYC Media for a customer", s"""Get KYC media (scans, pictures, videos) that affirms the identity of the customer. | - |${authenticationRequiredMessage(true)}""".stripMargin, + |${userAuthenticationMessage(true)}""".stripMargin, EmptyBody, kycMediasJSON, List(UserNotLoggedIn, CustomerNotFoundByCustomerId, UnknownError), @@ -549,7 +549,7 @@ trait APIMethods200 { "Get Customer KYC Checks", s"""Get KYC checks for the Customer specified by CUSTOMER_ID. | - |${authenticationRequiredMessage(true)}""".stripMargin, + |${userAuthenticationMessage(true)}""".stripMargin, EmptyBody, kycChecksJSON, List(UserNotLoggedIn, CustomerNotFoundByCustomerId, UnknownError), @@ -582,7 +582,7 @@ trait APIMethods200 { "Get Customer KYC statuses", s"""Get the KYC statuses for a customer specified by CUSTOMER_ID over time. | - |${authenticationRequiredMessage(true)}""".stripMargin, + |${userAuthenticationMessage(true)}""".stripMargin, EmptyBody, kycStatusesJSON, List(UserNotLoggedIn, CustomerNotFoundByCustomerId, UnknownError), @@ -616,7 +616,7 @@ trait APIMethods200 { "Get Customer Social Media Handles", s"""Get social media handles for a customer specified by CUSTOMER_ID. | - |${authenticationRequiredMessage(true)}""".stripMargin, + |${userAuthenticationMessage(true)}""".stripMargin, EmptyBody, socialMediasJSON, List(UserNotLoggedIn, UserHasMissingRoles, CustomerNotFoundByCustomerId, UnknownError), @@ -912,7 +912,7 @@ trait APIMethods200 { |This call returns the owner view and requires access to that view. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -1006,7 +1006,7 @@ trait APIMethods200 { |PSD2 Context: PSD2 requires customers to have access to their account information via third party applications. |This call provides balance and other account information via delegated authentication using OAuth. | - |${authenticationRequiredMessage(true)} if the 'is_public' field in view (VIEW_ID) is not set to `true`. + |${userAuthenticationMessage(true)} if the 'is_public' field in view (VIEW_ID) is not set to `true`. | |""".stripMargin, EmptyBody, @@ -1042,7 +1042,7 @@ trait APIMethods200 { "Get access", s"""Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |and the user needs to have access to the owner view. | |""", @@ -1085,7 +1085,7 @@ trait APIMethods200 { s"""Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to. |All url parameters must be [%-encoded](http://en.wikipedia.org/wiki/Percent-encoding), which is often especially relevant for USER_ID and PROVIDER. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |The user needs to have access to the owner view.""", EmptyBody, @@ -1265,7 +1265,7 @@ trait APIMethods200 { | * description : A longer description | * charge : The charge to the customer for each one of these | - |${authenticationRequiredMessage(!getTransactionTypesIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getTransactionTypesIsPublic)}""".stripMargin, EmptyBody, transactionTypesJsonV200, List(BankNotFound, UnknownError), @@ -1549,7 +1549,7 @@ trait APIMethods200 { |This call may require additional permissions/role in the future. |For now the authenticated user can create at most one linked customer. |Dates need to be in the format 2013-01-21T23:08:00Z - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", createCustomerJson, customerJsonV140, @@ -1710,7 +1710,7 @@ trait APIMethods200 { "Create User Customer Link", s"""Link a User to a Customer | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |$createUserCustomerLinksrequiredEntitlementsText |""", @@ -1847,7 +1847,7 @@ trait APIMethods200 { "Get Entitlements for User", s""" | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | | """.stripMargin, diff --git a/obp-api/src/main/scala/code/api/v2_1_0/APIMethods210.scala b/obp-api/src/main/scala/code/api/v2_1_0/APIMethods210.scala index e108daf10c..317d941e4d 100644 --- a/obp-api/src/main/scala/code/api/v2_1_0/APIMethods210.scala +++ b/obp-api/src/main/scala/code/api/v2_1_0/APIMethods210.scala @@ -118,7 +118,7 @@ trait APIMethods210 { |Note: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data. | |An example of an import set of data (json) can be found [here](https://raw.githubusercontent.com/OpenBankProject/OBP-API/develop/obp-api/src/main/scala/code/api/sandbox/example_data/2016-04-28/example_import.json) - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", SandboxData.importJson, successMessage, @@ -167,7 +167,7 @@ trait APIMethods210 { "Get Transaction Request Types at Bank", s"""Get the list of the Transaction Request Types supported by the bank. | - |${authenticationRequiredMessage(!getTransactionRequestTypesIsPublic)} + |${userAuthenticationMessage(!getTransactionRequestTypesIsPublic)} |""", EmptyBody, transactionRequestTypesJSON, @@ -250,7 +250,7 @@ trait APIMethods210 { | |There is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests) | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""" @@ -769,7 +769,7 @@ trait APIMethods210 { "Get Roles", s"""Returns all available roles | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} """.stripMargin, EmptyBody, availableRolesJSON, @@ -801,7 +801,7 @@ trait APIMethods210 { | |Get Entitlements specified by BANK_ID and USER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | | """.stripMargin, @@ -975,7 +975,7 @@ trait APIMethods210 { "Create Card", s"""Create Card at bank specified by BANK_ID . | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", postPhysicalCardJSON, physicalCardJSON, @@ -1106,7 +1106,7 @@ trait APIMethods210 { | * description : A longer description | * charge : The charge to the customer for each one of these | - |${authenticationRequiredMessage(getTransactionTypesIsPublic)}""".stripMargin, + |${userAuthenticationMessage(getTransactionTypesIsPublic)}""".stripMargin, transactionTypeJsonV200, transactionType, List( @@ -1155,7 +1155,7 @@ trait APIMethods210 { |* Geo Location |* License the data under this endpoint is released under | - |${authenticationRequiredMessage(!getAtmsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getAtmsIsPublic)}""".stripMargin, EmptyBody, atmJson, List(UserNotLoggedIn, BankNotFound, AtmNotFoundByAtmId, UnknownError), @@ -1200,7 +1200,7 @@ trait APIMethods210 { |* Geo Location |* License the data under this endpoint is released under | - |${authenticationRequiredMessage(!getBranchesIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getBranchesIsPublic)}""".stripMargin, EmptyBody, branchJson, List( @@ -1251,7 +1251,7 @@ trait APIMethods210 { |* Description |* Terms and Conditions |* License the data under this endpoint is released under - |${authenticationRequiredMessage(!getProductsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getProductsIsPublic)}""".stripMargin, EmptyBody, productJsonV210, List( @@ -1298,7 +1298,7 @@ trait APIMethods210 { |* Description |* Terms and Conditions |* License the data under this endpoint is released under - |${authenticationRequiredMessage(!getProductsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getProductsIsPublic)}""".stripMargin, EmptyBody, productsJsonV210, List( @@ -1348,7 +1348,7 @@ trait APIMethods210 { |The Customer resource stores the customer number, legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc. |Dates need to be in the format 2013-01-21T23:08:00Z | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |$createCustomeEntitlementsRequiredText |""", @@ -1461,7 +1461,7 @@ trait APIMethods210 { s"""Returns a list of Customers at the Bank that are linked to the currently authenticated User. | | - |${authenticationRequiredMessage(true)}""".stripMargin, + |${userAuthenticationMessage(true)}""".stripMargin, EmptyBody, customerJSONs, List( @@ -1503,7 +1503,7 @@ trait APIMethods210 { "/banks/BANK_ID/branches/BRANCH_ID", "Update Branch", s"""Update an existing branch for a bank account (Authenticated access). - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", branchJsonPut, branchJson, @@ -1550,7 +1550,7 @@ trait APIMethods210 { "/banks/BANK_ID/branches", "Create Branch", s"""Create branch for the bank (Authenticated access). - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", branchJsonPost, branchJson, diff --git a/obp-api/src/main/scala/code/api/v2_2_0/APIMethods220.scala b/obp-api/src/main/scala/code/api/v2_2_0/APIMethods220.scala index 9eac8d7ff3..784862f634 100644 --- a/obp-api/src/main/scala/code/api/v2_2_0/APIMethods220.scala +++ b/obp-api/src/main/scala/code/api/v2_2_0/APIMethods220.scala @@ -120,7 +120,7 @@ trait APIMethods220 { | |Returns the list of the views created for account ACCOUNT_ID at BANK_ID. | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view.""", + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view.""", EmptyBody, viewsJSONV220, List( @@ -163,7 +163,7 @@ trait APIMethods220 { "Create View", s"""#Create a view on bank account | - | ${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + | ${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | The 'alias' field in the JSON can take one of three values: | | * _public_: to use the public alias if there is one specified for the other account. @@ -230,7 +230,7 @@ trait APIMethods220 { "Update View", s"""Update an existing view on a bank account | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | |The json sent is the same as during view creation (above), with one difference: the 'name' field |of a view is not editable (it is only set when a view is created)""", @@ -348,7 +348,7 @@ trait APIMethods220 { | |For a general introduction to Counterparties in OBP, see ${Glossary.getGlossaryItemLink("Counterparties")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, counterpartiesJsonV220, @@ -404,7 +404,7 @@ trait APIMethods220 { "Get Counterparty by Counterparty Id (Explicit)", s"""Information returned about the Counterparty specified by COUNTERPARTY_ID: | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, counterpartyWithMetadataJson, @@ -477,7 +477,7 @@ trait APIMethods220 { "/banks", "Create Bank", s"""Create a new bank (Authenticated access). - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } |""", bankJSONV220, bankJSONV220, @@ -561,7 +561,7 @@ trait APIMethods220 { "Create Branch", s"""Create Branch for the Bank. | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | |""", branchJsonV220, @@ -610,7 +610,7 @@ trait APIMethods220 { "Create ATM", s"""Create ATM for the Bank. | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | |""", atmJsonV220, @@ -661,7 +661,7 @@ trait APIMethods220 { "Create Product", s"""Create or Update Product for the Bank. | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | |""", productJsonV220, @@ -738,7 +738,7 @@ trait APIMethods220 { | 1 US Dollar = 0.8800 Euro | | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | |""", fxJsonV220, @@ -1161,7 +1161,7 @@ trait APIMethods220 { | "bespoke": [] |} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, postCounterpartyJSON, diff --git a/obp-api/src/main/scala/code/api/v3_0_0/APIMethods300.scala b/obp-api/src/main/scala/code/api/v3_0_0/APIMethods300.scala index b1ddaa8622..d01a885dab 100644 --- a/obp-api/src/main/scala/code/api/v3_0_0/APIMethods300.scala +++ b/obp-api/src/main/scala/code/api/v3_0_0/APIMethods300.scala @@ -127,7 +127,7 @@ trait APIMethods300 { | |Returns the list of the views created for account ACCOUNT_ID at BANK_ID. | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view.""", + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view.""", EmptyBody, viewsJsonV300, List( @@ -174,7 +174,7 @@ trait APIMethods300 { "Create Custom View", s"""Create a custom view on bank account | - | ${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + | ${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | The 'alias' field in the JSON can take one of three values: | | * _public_: to use the public alias if there is one specified for the other account. @@ -239,7 +239,7 @@ trait APIMethods300 { s"""Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to. |All url parameters must be [%-encoded](http://en.wikipedia.org/wiki/Percent-encoding), which is often especially relevant for USER_ID and PROVIDER. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |The user needs to have access to the owner view.""", EmptyBody, @@ -282,7 +282,7 @@ trait APIMethods300 { "Update Custom View", s"""Update an existing custom view on a bank account | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | |The json sent is the same as during view creation (above), with one difference: the 'name' field |of a view is not editable (it is only set when a view is created)""", @@ -400,7 +400,7 @@ trait APIMethods300 { |PSD2 Context: PSD2 requires customers to have access to their account information via third party applications. |This call provides balance and other account information via delegated authentication using OAuth. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |""".stripMargin, EmptyBody, @@ -442,7 +442,7 @@ trait APIMethods300 { |This call returns the owner view and requires access to that view. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -478,7 +478,7 @@ trait APIMethods300 { | |${accountTypeFilterText("/my/accounts")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", EmptyBody, coreAccountsJsonV300, @@ -534,7 +534,7 @@ trait APIMethods300 { |URL params example: | `/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1&_timestamp_=1596762180358` | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -623,7 +623,7 @@ trait APIMethods300 { | |${urlParametersDocument(true, true)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -686,7 +686,7 @@ trait APIMethods300 { "Get Transactions for Account (Core)", s"""Returns transactions list (Core info) of the account specified by ACCOUNT_ID. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |${urlParametersDocument(true, true)} | @@ -742,7 +742,7 @@ trait APIMethods300 { "Get Transactions for Account (Full)", s"""Returns transactions list of the account specified by ACCOUNT_ID and [moderated](#1_2_1-getViewsForBankAccount) by the view (VIEW_ID). | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |Authentication is required if the view is not public. | @@ -801,7 +801,7 @@ trait APIMethods300 { s""" |Search the data warehouse and get row level results. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |CanSearchWarehouse entitlement is required. You can request the Role below. | @@ -883,7 +883,7 @@ trait APIMethods300 { | |https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |CanSearchWarehouseStats Role is required. You can request this below. | @@ -957,7 +957,7 @@ trait APIMethods300 { "Get Users by Email Address", s"""Get users by email address | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |CanGetAnyUser entitlement is required, | """.stripMargin, @@ -990,7 +990,7 @@ trait APIMethods300 { "Get User by USER_ID", s"""Get user by USER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |CanGetAnyUser entitlement is required, | """.stripMargin, @@ -1026,7 +1026,7 @@ trait APIMethods300 { "Get User by USERNAME", s"""Get user by USERNAME | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |CanGetAnyUser entitlement is required, | @@ -1064,7 +1064,7 @@ trait APIMethods300 { "Get Adapter Info for a bank", s"""Get basic information about the Adapter listening on behalf of this bank. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1105,7 +1105,7 @@ trait APIMethods300 { "Create Branch", s"""Create Branch for the Bank. | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | |""", branchJsonV300, @@ -1155,7 +1155,7 @@ trait APIMethods300 { "Update Branch", s"""Update an existing branch for a bank account (Authenticated access). | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | |""", postBranchJsonV300, @@ -1222,7 +1222,7 @@ trait APIMethods300 { "Create ATM", s"""Create ATM for the Bank. | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | |""", atmJsonV300, @@ -1277,7 +1277,7 @@ trait APIMethods300 { |* Geo Location |* License the data under this endpoint is released under. | - |${authenticationRequiredMessage(!getBranchesIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getBranchesIsPublic)}""".stripMargin, EmptyBody, branchJsonV300, List( @@ -1339,7 +1339,7 @@ trait APIMethods300 { | |note: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value. | - |${authenticationRequiredMessage(!getBranchesIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getBranchesIsPublic)}""".stripMargin, EmptyBody, branchesJsonV300, List( @@ -1456,7 +1456,7 @@ trait APIMethods300 { | | | - |${authenticationRequiredMessage(!getAtmsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getAtmsIsPublic)}""".stripMargin, EmptyBody, atmJsonV300, List(UserNotLoggedIn, BankNotFound, AtmNotFoundByAtmId, UnknownError), @@ -1497,7 +1497,7 @@ trait APIMethods300 { | |You can use the url query parameters *limit* and *offset* for pagination | - |${authenticationRequiredMessage(!getAtmsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getAtmsIsPublic)}""".stripMargin, EmptyBody, atmJsonV300, List( @@ -1569,7 +1569,7 @@ trait APIMethods300 { "Get all Users", s"""Get all users | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |CanGetAnyUser entitlement is required, | @@ -1616,7 +1616,7 @@ trait APIMethods300 { s"""Gets all Customers that are linked to a User. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1666,7 +1666,7 @@ trait APIMethods300 { "Get User (Current)", s"""Get the logged in user | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} """.stripMargin, EmptyBody, userJsonV300, @@ -1702,7 +1702,7 @@ trait APIMethods300 { | |${accountTypeFilterText("/banks/BANK_ID/accounts/private")} | - |${authenticationRequiredMessage(true)}""".stripMargin, + |${userAuthenticationMessage(true)}""".stripMargin, EmptyBody, coreAccountsJsonV300, List(UserNotLoggedIn, BankNotFound, UnknownError), @@ -1741,7 +1741,7 @@ trait APIMethods300 { | |${accountTypeFilterText("/banks/BANK_ID/accounts/account_ids/private")} | - |${authenticationRequiredMessage(true)}""".stripMargin, + |${userAuthenticationMessage(true)}""".stripMargin, EmptyBody, accountsIdsJsonV300, List(UserNotLoggedIn, BankNotFound, UnknownError), @@ -1774,7 +1774,7 @@ trait APIMethods300 { "/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts", "Get Other Accounts of one Account", s"""Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID. - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |Authentication is required if the view VIEW_ID is not public.""", EmptyBody, @@ -1811,7 +1811,7 @@ trait APIMethods300 { "/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID", "Get Other Account by Id", s"""Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID. - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |Authentication is required if the view is not public.""", EmptyBody, @@ -1859,7 +1859,7 @@ trait APIMethods300 { | | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, code.api.ResourceDocs1_4_0.SwaggerDefinitionsJSON.createEntitlementJSON, @@ -1917,7 +1917,7 @@ trait APIMethods300 { s""" |Get all Entitlement Requests | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} """.stripMargin, EmptyBody, entitlementRequestsJSON, @@ -1955,7 +1955,7 @@ trait APIMethods300 { s"""Get Entitlement Requests for a User. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1994,7 +1994,7 @@ trait APIMethods300 { s"""Get Entitlement Requests for the current User. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -2030,7 +2030,7 @@ trait APIMethods300 { s"""Delete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} """.stripMargin, EmptyBody, EmptyBody, @@ -2069,7 +2069,7 @@ trait APIMethods300 { s"""Get Entitlements for the current User. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -2222,7 +2222,7 @@ trait APIMethods300 { | |15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -2385,7 +2385,7 @@ trait APIMethods300 { "Get Scopes for Consumer", s"""Get all the scopes for an consumer specified by CONSUMER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | | """.stripMargin, diff --git a/obp-api/src/main/scala/code/api/v3_1_0/APIMethods310.scala b/obp-api/src/main/scala/code/api/v3_1_0/APIMethods310.scala index 7daacf7bb4..e23e96eead 100644 --- a/obp-api/src/main/scala/code/api/v3_1_0/APIMethods310.scala +++ b/obp-api/src/main/scala/code/api/v3_1_0/APIMethods310.scala @@ -245,7 +245,7 @@ trait APIMethods310 { | |15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -332,7 +332,7 @@ trait APIMethods310 { | |16 limit (for pagination: defaults to 50) eg:limit=200 | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -394,7 +394,7 @@ trait APIMethods310 { | |${urlParametersDocument(true, true)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -444,7 +444,7 @@ trait APIMethods310 { "Get User Lock Status", s""" |Get User Login Status. - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -483,7 +483,7 @@ trait APIMethods310 { | |(Perhaps the user was locked due to multiple failed login attempts) | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -531,7 +531,7 @@ trait APIMethods310 { |Per Month | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, callLimitPostJson, @@ -590,7 +590,7 @@ trait APIMethods310 { "Get Call Limits for a Consumer", s""" |Get Calls limits per Consumer. - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -775,7 +775,7 @@ trait APIMethods310 { "Get Consumers", s"""Get the all Consumers. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |${urlParametersDocument(true, true)} | @@ -1014,7 +1014,7 @@ trait APIMethods310 { "Get Adapter Info", s"""Get basic information about the Adapter. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1048,7 +1048,7 @@ trait APIMethods310 { "Get Transaction by Id", s"""Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and [moderated](#1_2_1-getViewsForBankAccount) by the view (VIEW_ID). | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |Authentication is required if the view is not public. | | @@ -1160,7 +1160,7 @@ trait APIMethods310 { | |Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", postCustomerJsonV310, customerJsonV310, @@ -1238,7 +1238,7 @@ trait APIMethods310 { | |See the consumer rate limits / call limits endpoints. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1272,7 +1272,7 @@ trait APIMethods310 { s"""Gets the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1315,7 +1315,7 @@ trait APIMethods310 { s"""Gets the Customer specified by CUSTOMER_NUMBER. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", postCustomerNumberJsonV310, @@ -1360,7 +1360,7 @@ trait APIMethods310 { "Create User Auth Context", s"""Create User Auth Context. These key value pairs will be propagated over connector to adapter. Normally used for mapping OBP user and | Bank User/Customer. - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", postUserAuthContextJson, userAuthContextJson, @@ -1401,7 +1401,7 @@ trait APIMethods310 { s"""Get User Auth Contexts for a User. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1440,7 +1440,7 @@ trait APIMethods310 { s"""Delete the Auth Contexts of a User specified by USER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1478,7 +1478,7 @@ trait APIMethods310 { s"""Delete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1515,7 +1515,7 @@ trait APIMethods310 { s"""Create a Tax Residence for a Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", postTaxResidenceJsonV310, @@ -1559,7 +1559,7 @@ trait APIMethods310 { s"""Get the Tax Residences of the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1597,7 +1597,7 @@ trait APIMethods310 { s"""Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1675,7 +1675,7 @@ trait APIMethods310 { s"""Create an Address for a Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", postCustomerAddressJsonV310, @@ -1732,7 +1732,7 @@ trait APIMethods310 { s"""Update an Address of the Customer specified by CUSTOMER_ADDRESS_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", postCustomerAddressJsonV310, @@ -1787,7 +1787,7 @@ trait APIMethods310 { s"""Get the Addresses of the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1826,7 +1826,7 @@ trait APIMethods310 { s"""Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1870,7 +1870,7 @@ trait APIMethods310 { |In the future, this endpoint may also return information about database connections etc. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1910,7 +1910,7 @@ trait APIMethods310 { | As to the Json body, you can leave it as Empty. | This call will get data from backend, no need to prepare the json body in api side. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1979,7 +1979,7 @@ trait APIMethods310 { | | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", productAttributeJson, @@ -2038,7 +2038,7 @@ trait APIMethods310 { | |Get one product attribute by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -2080,7 +2080,7 @@ trait APIMethods310 { | |Update one Product Attribute by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", productAttributeJson, @@ -2139,7 +2139,7 @@ trait APIMethods310 { | |Delete a Product Attribute by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -2175,7 +2175,7 @@ trait APIMethods310 { "Create Account Application", s""" Create Account Application | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", accountApplicationJson, @@ -2236,7 +2236,7 @@ trait APIMethods310 { s"""Get the Account Applications. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -2279,7 +2279,7 @@ trait APIMethods310 { s"""Get the Account Application. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -2325,7 +2325,7 @@ trait APIMethods310 { s"""Update an Account Application status | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", accountApplicationUpdateStatusJson, @@ -2415,7 +2415,7 @@ trait APIMethods310 { |$productHiearchyAndCollectionNote | | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | | |""", @@ -2492,7 +2492,7 @@ trait APIMethods310 { |* Terms and Conditions |* License the data under this endpoint is released under | - |${authenticationRequiredMessage(!getProductsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getProductsIsPublic)}""".stripMargin, EmptyBody, productJsonV310, List( @@ -2547,7 +2547,7 @@ trait APIMethods310 { | | | - |${authenticationRequiredMessage(!getProductsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getProductsIsPublic)}""".stripMargin, EmptyBody, childProductTreeJsonV310, List( @@ -2600,7 +2600,7 @@ trait APIMethods310 { |Can filter with attributes name and values. |URL params example: /banks/some-bank-id/products?&limit=50&offset=1 | - |${authenticationRequiredMessage(!getProductsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getProductsIsPublic)}""".stripMargin, EmptyBody, productsJsonV310, List( @@ -2671,7 +2671,7 @@ trait APIMethods310 { | |The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", accountAttributeJson, @@ -2744,7 +2744,7 @@ trait APIMethods310 { | |See [FPML](http://www.fpml.org/) for more examples. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", accountAttributeJson, @@ -2826,7 +2826,7 @@ trait APIMethods310 { | |$productHiearchyAndCollectionNote - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | | |""", @@ -2928,7 +2928,7 @@ trait APIMethods310 { "Delete Branch", s"""Delete Branch from given Bank. | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | |""", EmptyBody, @@ -3296,7 +3296,7 @@ trait APIMethods310 { | |$generalObpConsentText | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Example 1: |{ @@ -3375,7 +3375,7 @@ trait APIMethods310 { | |$generalObpConsentText | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Example 1: |{ @@ -3456,7 +3456,7 @@ trait APIMethods310 { | |$generalObpConsentText | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Example 1: |{ @@ -3670,7 +3670,7 @@ trait APIMethods310 { | |The User must supply a code that was sent out of band (OOB) for example via an SMS. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", PostConsentChallengeJsonV310(answer = "12345678"), @@ -3717,7 +3717,7 @@ trait APIMethods310 { s""" |This endpoint gets the Consents that the current User created. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -3762,7 +3762,7 @@ trait APIMethods310 { |OBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user. |The status of the token is changed to "REVOKED" so the next time the revoked client makes a request, their token will fail to validate. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -3804,7 +3804,7 @@ trait APIMethods310 { "/banks/BANK_ID/users/current/auth-context-updates/SCA_METHOD", "Create User Auth Context Update Request", s"""Create User Auth Context Update Request. - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |A One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD |SCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes. @@ -3918,7 +3918,7 @@ trait APIMethods310 { "Get System View", s"""Get System View | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -3955,7 +3955,7 @@ trait APIMethods310 { "Create System View", s"""Create a system view | - | ${authenticationRequiredMessage(true)} and the user needs to have access to the $canCreateSystemView entitlement. + | ${userAuthenticationMessage(true)} and the user needs to have access to the $canCreateSystemView entitlement. | The 'alias' field in the JSON can take one of two values: | | * _public_: to use the public alias if there is one specified for the other account. @@ -4050,7 +4050,7 @@ trait APIMethods310 { "Update System View", s"""Update an existing view on a bank account | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | |The json sent is the same as during view creation (above), with one difference: the 'name' field |of a view is not editable (it is only set when a view is created)""", @@ -4206,7 +4206,7 @@ trait APIMethods310 { s"""Create a MethodRouting. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Explanation of Fields: | @@ -4316,7 +4316,7 @@ trait APIMethods310 { s"""Update a MethodRouting. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Explaination of Fields: | @@ -4421,7 +4421,7 @@ trait APIMethods310 { s"""Delete a MethodRouting specified by METHOD_ROUTING_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -4459,7 +4459,7 @@ trait APIMethods310 { s"""Update an email of the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", putUpdateCustomerEmailJsonV310, @@ -4508,7 +4508,7 @@ trait APIMethods310 { s"""Update the number of the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", putUpdateCustomerNumberJsonV310, @@ -4563,7 +4563,7 @@ trait APIMethods310 { s"""Update the mobile number of the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", putUpdateCustomerMobileNumberJsonV310, @@ -4612,7 +4612,7 @@ trait APIMethods310 { s"""Update the identity data of the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", putUpdateCustomerIdentityJsonV310, @@ -4669,7 +4669,7 @@ trait APIMethods310 { s"""Update the credit limit of the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", putUpdateCustomerCreditLimitJsonV310, @@ -4718,7 +4718,7 @@ trait APIMethods310 { s"""Update the credit rating and source of the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", putUpdateCustomerCreditRatingAndSourceJsonV310, @@ -4766,7 +4766,7 @@ trait APIMethods310 { "Update Account", s"""Update the account. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, updateAccountRequestJsonV310, @@ -4829,7 +4829,7 @@ trait APIMethods310 { "Create Card", s"""Create Card at bank specified by BANK_ID . | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", createPhysicalCardJsonV310, physicalCardJsonV310, @@ -4924,7 +4924,7 @@ trait APIMethods310 { "/management/banks/BANK_ID/cards/CARD_ID", "Update Card", s"""Update Card at bank specified by CARD_ID . - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", updatePhysicalCardJsonV310, physicalCardJsonV310, @@ -5011,7 +5011,7 @@ trait APIMethods310 { |2 account_id should be valid account_id , otherwise, it will return an empty card list. | | - |${authenticationRequiredMessage(true)}""".stripMargin, + |${userAuthenticationMessage(true)}""".stripMargin, EmptyBody, physicalCardsJsonV310, List(UserNotLoggedIn,BankNotFound, UnknownError), @@ -5080,7 +5080,7 @@ trait APIMethods310 { "Delete Card", s"""Delete a Card at bank specified by CARD_ID . | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", EmptyBody, EmptyBody, @@ -5121,7 +5121,7 @@ trait APIMethods310 { | |The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", CardAttributeJson( @@ -5192,7 +5192,7 @@ trait APIMethods310 { | |Each Card Attribute is linked to its Card by CARD_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", CardAttributeJson( @@ -5260,7 +5260,7 @@ trait APIMethods310 { s"""Update the Branch of the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", putCustomerBranchJsonV310, @@ -5316,7 +5316,7 @@ trait APIMethods310 { s"""Update the other data of the Customer specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", putUpdateCustomerDataJsonV310, @@ -5813,7 +5813,7 @@ trait APIMethods310 { s"""Create a WebUiProps. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Explaination of Fields: | @@ -5894,7 +5894,7 @@ trait APIMethods310 { s"""Delete a WebUiProps specified by WEB_UI_PROPS_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, diff --git a/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala b/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala index 4d5dee831d..54d05962ad 100644 --- a/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala +++ b/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala @@ -141,7 +141,7 @@ trait APIMethods400 extends MdcLoggable { "Get Mapper Database Info", s"""Get basic information about the Mapper Database. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -171,7 +171,7 @@ trait APIMethods400 extends MdcLoggable { "Get Logout Link", s"""Get the Logout Link | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} """.stripMargin, EmptyBody, logoutLinkV400, @@ -209,7 +209,7 @@ trait APIMethods400 extends MdcLoggable { |Per Month | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, callLimitPostJsonV400, @@ -370,7 +370,7 @@ trait APIMethods400 extends MdcLoggable { |`transaction_request_id` of the transaction request at the origin of the transaction. Please note that if none |transaction request is at the origin of the transaction, the `transaction_request` object will be `null`. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -409,7 +409,7 @@ trait APIMethods400 extends MdcLoggable { s"""Get Balancing Transaction | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1227,7 +1227,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", transactionRequestAttributeJsonV400, @@ -1282,7 +1282,7 @@ trait APIMethods400 extends MdcLoggable { "Get Transaction Request Attribute By Id", s""" Get Transaction Request Attribute By Id | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1323,7 +1323,7 @@ trait APIMethods400 extends MdcLoggable { "Get Transaction Request Attributes", s""" Get Transaction Request Attributes | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1365,7 +1365,7 @@ trait APIMethods400 extends MdcLoggable { "Update Transaction Request Attribute", s""" Update Transaction Request Attribute | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", transactionRequestAttributeJsonV400, @@ -1425,7 +1425,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of: ${AttributeType.DOUBLE}, ${AttributeType.STRING}, ${AttributeType.INTEGER} and ${AttributeType.DATE_WITH_DAY} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", transactionRequestAttributeDefinitionJsonV400, @@ -1484,7 +1484,7 @@ trait APIMethods400 extends MdcLoggable { "Get Transaction Request Attribute Definition", s""" Get Transaction Request Attribute Definition | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1521,7 +1521,7 @@ trait APIMethods400 extends MdcLoggable { "Delete Transaction Request Attribute Definition", s""" Delete Transaction Request Attribute Definition by ATTRIBUTE_DEFINITION_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1648,7 +1648,7 @@ trait APIMethods400 extends MdcLoggable { s"""Create a system level Dynamic Entity. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Create a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically | @@ -1693,7 +1693,7 @@ trait APIMethods400 extends MdcLoggable { "Create Bank Level Dynamic Entity", s"""Create a Bank Level DynamicEntity. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Create a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically | @@ -1759,7 +1759,7 @@ trait APIMethods400 extends MdcLoggable { s"""Update a System Level Dynamic Entity. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed. | @@ -1802,7 +1802,7 @@ trait APIMethods400 extends MdcLoggable { s"""Update a Bank Level DynamicEntity. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed. | @@ -1946,7 +1946,7 @@ trait APIMethods400 extends MdcLoggable { s"""Update my DynamicEntity. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Update one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed. | @@ -2302,7 +2302,7 @@ trait APIMethods400 extends MdcLoggable { s"""Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account' | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, updateAccountJsonV400, @@ -2348,7 +2348,7 @@ trait APIMethods400 extends MdcLoggable { s""" |Lock a User. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -2542,7 +2542,7 @@ trait APIMethods400 extends MdcLoggable { "Create a tag on account", s"""Posts a tag about an account ACCOUNT_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Authentication is required as the tag is linked with the user.""", postAccountTagJSON, @@ -2588,7 +2588,7 @@ trait APIMethods400 extends MdcLoggable { "Delete a tag on account", s"""Deletes the tag TAG_ID about the account ACCOUNT_ID made on [view](#1_2_1-getViewsForBankAccount). | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Authentication is required as the tag is linked with the user.""", EmptyBody, @@ -2629,7 +2629,7 @@ trait APIMethods400 extends MdcLoggable { "/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/metadata/tags", "Get tags on account", s"""Returns the account ACCOUNT_ID tags made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID). - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |Authentication is required as the tag is linked with the user.""", EmptyBody, @@ -2980,7 +2980,7 @@ trait APIMethods400 extends MdcLoggable { |URL params example: | `/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1&_timestamp_=1596762180358` | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -3062,7 +3062,7 @@ trait APIMethods400 extends MdcLoggable { |optional pagination parameters for filter with accounts |${urlParametersDocument(true, false)} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -3142,7 +3142,7 @@ trait APIMethods400 extends MdcLoggable { "Get User Id (Current)", s"""Get the USER_ID of the logged in user | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} """.stripMargin, EmptyBody, userIdJsonV400, @@ -3171,7 +3171,7 @@ trait APIMethods400 extends MdcLoggable { "Get User by USER_ID", s"""Get user by USER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |CanGetAnyUser entitlement is required, | """.stripMargin, @@ -3210,7 +3210,7 @@ trait APIMethods400 extends MdcLoggable { "Get User by USERNAME", s"""Get user by USERNAME | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |CanGetAnyUser entitlement is required, | @@ -3247,7 +3247,7 @@ trait APIMethods400 extends MdcLoggable { "Get Users by Email Address", s"""Get users by email address | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |CanGetAnyUser entitlement is required, | """.stripMargin, @@ -3278,7 +3278,7 @@ trait APIMethods400 extends MdcLoggable { "Get all Users", s"""Get all users | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |CanGetAnyUser entitlement is required, | @@ -3414,7 +3414,7 @@ trait APIMethods400 extends MdcLoggable { "Get User Invitation Information", s"""Get User Invitation Information. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |""", PostUserInvitationAnonymousJsonV400(secret_key = 5819479115482092878L), userInvitationJsonV400, @@ -3461,7 +3461,7 @@ trait APIMethods400 extends MdcLoggable { "Get User Invitation", s""" Get User Invitation | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -3496,7 +3496,7 @@ trait APIMethods400 extends MdcLoggable { "Get User Invitations", s""" Get User Invitations | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -3533,7 +3533,7 @@ trait APIMethods400 extends MdcLoggable { s"""Delete a User. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -3927,7 +3927,7 @@ trait APIMethods400 extends MdcLoggable { "Grant User access to View", s"""Grants the User identified by USER_ID access to the view identified by VIEW_ID. | - |${authenticationRequiredMessage(true)} and the user needs to be account holder. + |${userAuthenticationMessage(true)} and the user needs to be account holder. | |""", postAccountAccessJsonV400, @@ -3983,7 +3983,7 @@ trait APIMethods400 extends MdcLoggable { | |This endpoint will create the (DAuth) User with username and provider if the User does not already exist. | - |${authenticationRequiredMessage(true)} and the logged in user needs to be account holder. + |${userAuthenticationMessage(true)} and the logged in user needs to be account holder. | |For information about DAuth see below: | @@ -4040,7 +4040,7 @@ trait APIMethods400 extends MdcLoggable { "Revoke User access to View", s"""Revoke the User identified by USER_ID access to the view identified by VIEW_ID. | - |${authenticationRequiredMessage(true)} and the user needs to be account holder. + |${userAuthenticationMessage(true)} and the user needs to be account holder. | |""", postAccountAccessJsonV400, @@ -4097,7 +4097,7 @@ trait APIMethods400 extends MdcLoggable { "Revoke/Grant User access to View", s"""Revoke/Grant the logged in User access to the views identified by json. | - |${authenticationRequiredMessage(true)} and the user needs to be an account holder or has owner view access. + |${userAuthenticationMessage(true)} and the user needs to be an account holder or has owner view access. | |""", postRevokeGrantAccountAccessJsonV400, @@ -4153,7 +4153,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", customerAttributeJsonV400, @@ -4207,7 +4207,7 @@ trait APIMethods400 extends MdcLoggable { s""" Update Customer Attribute | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", customerAttributeJsonV400, @@ -4265,7 +4265,7 @@ trait APIMethods400 extends MdcLoggable { "Get Customer Attributes", s""" Get Customer Attributes | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -4306,7 +4306,7 @@ trait APIMethods400 extends MdcLoggable { "Get Customer Attribute By Id", s""" Get Customer Attribute By Id | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -4402,7 +4402,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", transactionAttributeJsonV400, @@ -4456,7 +4456,7 @@ trait APIMethods400 extends MdcLoggable { s""" Update Transaction Attribute | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", transactionAttributeJsonV400, @@ -4511,7 +4511,7 @@ trait APIMethods400 extends MdcLoggable { "Get Transaction Attributes", s""" Get Transaction Attributes | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -4552,7 +4552,7 @@ trait APIMethods400 extends MdcLoggable { "Get Transaction Attribute By Id", s""" Get Transaction Attribute By Id | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -4884,7 +4884,7 @@ trait APIMethods400 extends MdcLoggable { s"""Get Customers at Any Bank. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -4921,7 +4921,7 @@ trait APIMethods400 extends MdcLoggable { s"""Get Customers Minimal at Any Bank. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -4958,7 +4958,7 @@ trait APIMethods400 extends MdcLoggable { "Get Scopes for Consumer", s"""Get all the scopes for an consumer specified by CONSUMER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | | """.stripMargin, @@ -5068,7 +5068,7 @@ trait APIMethods400 extends MdcLoggable { | |Delete a Customer Attribute by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -5532,7 +5532,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of; ${AttributeType.DOUBLE}, ${AttributeType.STRING}, ${AttributeType.INTEGER} and ${AttributeType.DATE_WITH_DAY} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", templateAttributeDefinitionJsonV400, @@ -5596,7 +5596,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of; ${AttributeType.DOUBLE}, ${AttributeType.STRING}, ${AttributeType.INTEGER} and ${AttributeType.DATE_WITH_DAY} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", accountAttributeDefinitionJsonV400, @@ -5659,7 +5659,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of; ${AttributeType.DOUBLE}, ${AttributeType.STRING}, ${AttributeType.INTEGER} and ${AttributeType.DATE_WITH_DAY} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", productAttributeDefinitionJsonV400, @@ -5747,7 +5747,7 @@ trait APIMethods400 extends MdcLoggable { | | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", productAttributeJsonV400, @@ -5807,7 +5807,7 @@ trait APIMethods400 extends MdcLoggable { | |Update one Product Attribute by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", productAttributeJsonV400, @@ -5866,7 +5866,7 @@ trait APIMethods400 extends MdcLoggable { | |Get one product attribute by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -5903,7 +5903,7 @@ trait APIMethods400 extends MdcLoggable { "Create Product Fee", s"""Create Product Fee | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", productFeeJsonV400.copy(product_fee_id = None), @@ -5956,7 +5956,7 @@ trait APIMethods400 extends MdcLoggable { | |Update one Product Fee by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", productFeeJsonV400.copy(product_fee_id = None), @@ -6009,7 +6009,7 @@ trait APIMethods400 extends MdcLoggable { | |Get one product fee by its id. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |""", EmptyBody, @@ -6045,7 +6045,7 @@ trait APIMethods400 extends MdcLoggable { "Get Product Fees", s"""Get Product Fees | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |""", EmptyBody, @@ -6082,7 +6082,7 @@ trait APIMethods400 extends MdcLoggable { | |Delete one product fee by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6121,7 +6121,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of; ${AttributeType.DOUBLE}, ${AttributeType.STRING}, ${AttributeType.INTEGER} and ${AttributeType.DATE_WITH_DAY} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", bankAttributeDefinitionJsonV400, @@ -6197,7 +6197,7 @@ trait APIMethods400 extends MdcLoggable { | | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", bankAttributeJsonV400, @@ -6249,7 +6249,7 @@ trait APIMethods400 extends MdcLoggable { "Get Bank Attributes", s""" Get Bank Attributes | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6284,7 +6284,7 @@ trait APIMethods400 extends MdcLoggable { "Get Bank Attribute By BANK_ATTRIBUTE_ID", s""" Get Bank Attribute By BANK_ATTRIBUTE_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6322,7 +6322,7 @@ trait APIMethods400 extends MdcLoggable { | |Update one Bak Attribute by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", bankAttributeJsonV400, @@ -6377,7 +6377,7 @@ trait APIMethods400 extends MdcLoggable { | |Delete a Bank Attribute by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6417,7 +6417,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of; ${AttributeType.DOUBLE}, ${AttributeType.STRING}, ${AttributeType.INTEGER} and ${AttributeType.DATE_WITH_DAY} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", transactionAttributeDefinitionJsonV400, @@ -6481,7 +6481,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of; ${AttributeType.DOUBLE}, ${AttributeType.STRING}, ${AttributeType.INTEGER} and ${AttributeType.DATE_WITH_DAY} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", cardAttributeDefinitionJsonV400, @@ -6541,7 +6541,7 @@ trait APIMethods400 extends MdcLoggable { "Delete Transaction Attribute Definition", s""" Delete Transaction Attribute Definition by ATTRIBUTE_DEFINITION_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6579,7 +6579,7 @@ trait APIMethods400 extends MdcLoggable { "Delete Customer Attribute Definition", s""" Delete Customer Attribute Definition by ATTRIBUTE_DEFINITION_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6617,7 +6617,7 @@ trait APIMethods400 extends MdcLoggable { "Delete Account Attribute Definition", s""" Delete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6655,7 +6655,7 @@ trait APIMethods400 extends MdcLoggable { "Delete Product Attribute Definition", s""" Delete Product Attribute Definition by ATTRIBUTE_DEFINITION_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6693,7 +6693,7 @@ trait APIMethods400 extends MdcLoggable { "Delete Card Attribute Definition", s""" Delete Card Attribute Definition by ATTRIBUTE_DEFINITION_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6731,7 +6731,7 @@ trait APIMethods400 extends MdcLoggable { "Get Product Attribute Definition", s""" Get Product Attribute Definition | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6768,7 +6768,7 @@ trait APIMethods400 extends MdcLoggable { "Get Customer Attribute Definition", s""" Get Customer Attribute Definition | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6805,7 +6805,7 @@ trait APIMethods400 extends MdcLoggable { "Get Account Attribute Definition", s""" Get Account Attribute Definition | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6842,7 +6842,7 @@ trait APIMethods400 extends MdcLoggable { "Get Transaction Attribute Definition", s""" Get Transaction Attribute Definition | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6880,7 +6880,7 @@ trait APIMethods400 extends MdcLoggable { "Get Card Attribute Definition", s""" Get Card Attribute Definition | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6917,7 +6917,7 @@ trait APIMethods400 extends MdcLoggable { "Delete User Customer Link", s""" Delete User Customer Link by USER_CUSTOMER_LINK_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6955,7 +6955,7 @@ trait APIMethods400 extends MdcLoggable { "Get User Customer Links by User", s""" Get User Customer Links by USER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -6991,7 +6991,7 @@ trait APIMethods400 extends MdcLoggable { "Create User Customer Link", s"""Link a User to a Customer | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", createUserCustomerLinkJson, @@ -7054,7 +7054,7 @@ trait APIMethods400 extends MdcLoggable { "Get User Customer Links by Customer", s""" Get User Customer Links by CUSTOMER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -7087,7 +7087,7 @@ trait APIMethods400 extends MdcLoggable { "Get Correlated User Info by Customer", s"""Get Correlated User Info by CUSTOMER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -7123,7 +7123,7 @@ trait APIMethods400 extends MdcLoggable { "Get Correlated Entities for the current User", s"""Correlated Entities are users and customers linked to the currently authenticated user via User-Customer-Links | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -7179,7 +7179,7 @@ trait APIMethods400 extends MdcLoggable { | |Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", postCustomerJsonV310, customerJsonV310, @@ -7243,7 +7243,7 @@ trait APIMethods400 extends MdcLoggable { "Get Accounts Minimal for a Customer", s"""Get Accounts Minimal by CUSTOMER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -7280,7 +7280,7 @@ trait APIMethods400 extends MdcLoggable { s"""Delete a Transaction Cascade specified by TRANSACTION_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -7318,7 +7318,7 @@ trait APIMethods400 extends MdcLoggable { s"""Delete an Account Cascade specified by ACCOUNT_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -7357,7 +7357,7 @@ trait APIMethods400 extends MdcLoggable { s"""Delete a Bank Cascade specified by BANK_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -7392,7 +7392,7 @@ trait APIMethods400 extends MdcLoggable { s"""Delete a Product Cascade specified by PRODUCT_CODE. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -7430,7 +7430,7 @@ trait APIMethods400 extends MdcLoggable { s"""Delete a Customer Cascade specified by CUSTOMER_ID. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -7468,7 +7468,7 @@ trait APIMethods400 extends MdcLoggable { | |For an introduction to Counterparties in OBP see ${Glossary.getGlossaryItemLink("Counterparties")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, postCounterpartyJson400, @@ -7593,7 +7593,7 @@ trait APIMethods400 extends MdcLoggable { | |For a general introduction to Counterparties in OBP see ${Glossary.getGlossaryItemLink("Counterparties")} | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, EmptyBody, @@ -7642,7 +7642,7 @@ trait APIMethods400 extends MdcLoggable { | |For a general introduction to Counterparties in OBP, see ${Glossary.getGlossaryItemLink("Counterparties")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, EmptyBody, @@ -7689,7 +7689,7 @@ trait APIMethods400 extends MdcLoggable { | |For an introduction to Counterparties in OBP, see ${Glossary.getGlossaryItemLink("Counterparties")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, postCounterpartyJson400, @@ -7806,7 +7806,7 @@ trait APIMethods400 extends MdcLoggable { | |For a general introduction to Counterparties in OBP, see ${Glossary.getGlossaryItemLink("Counterparties")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, counterpartiesJson400, @@ -7861,7 +7861,7 @@ trait APIMethods400 extends MdcLoggable { | |For a general introduction to Counterparties in OBP, see ${Glossary.getGlossaryItemLink("Counterparties")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, counterpartiesJson400, @@ -7913,7 +7913,7 @@ trait APIMethods400 extends MdcLoggable { | |For a general introduction to Counterparties in OBP, see ${Glossary.getGlossaryItemLink("Counterparties")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, counterpartyWithMetadataJson400, @@ -7949,7 +7949,7 @@ trait APIMethods400 extends MdcLoggable { | |For a general introduction to Counterparties in OBP, see ${Glossary.getGlossaryItemLink("Counterparties")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -8001,7 +8001,7 @@ trait APIMethods400 extends MdcLoggable { |For a general introduction to Counterparties in OBP, see ${Glossary.getGlossaryItemLink("Counterparties")} | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -8047,7 +8047,7 @@ trait APIMethods400 extends MdcLoggable { | |Each Consent has one of the following states: ${ConsentStatus.values.toList.sorted.mkString(", ") }. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", PutConsentUserJsonV400(user_id = "ed7a7c01-db37-45cc-ba12-0ae8891c195c"), @@ -8106,7 +8106,7 @@ trait APIMethods400 extends MdcLoggable { | |Each Consent has one of the following states: ${ConsentStatus.values.toList.sorted.mkString(", ") }. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", PutConsentStatusJsonV400(status = "AUTHORISED"), @@ -8163,7 +8163,7 @@ trait APIMethods400 extends MdcLoggable { | |This endpoint gets the Consents that the current User created. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -8199,7 +8199,7 @@ trait APIMethods400 extends MdcLoggable { | |This endpoint gets the Consents that the current User created. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -8234,7 +8234,7 @@ trait APIMethods400 extends MdcLoggable { "Get My Personal User Attributes", s"""Get My Personal User Attributes. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, userAttributesResponseJson, @@ -8266,7 +8266,7 @@ trait APIMethods400 extends MdcLoggable { "Get User with Attributes by USER_ID", s"""Get User Attributes for the user defined via USER_ID. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, userWithAttributesResponseJson, @@ -8302,7 +8302,7 @@ trait APIMethods400 extends MdcLoggable { | |The `type` field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", userAttributeJsonV400, @@ -8354,7 +8354,7 @@ trait APIMethods400 extends MdcLoggable { | |The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", userAttributeJsonV400, @@ -8439,7 +8439,7 @@ trait APIMethods400 extends MdcLoggable { "Create My Api Collection", s"""Create Api Collection for logged in user. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, postApiCollectionJson400, apiCollectionJson400, @@ -8485,7 +8485,7 @@ trait APIMethods400 extends MdcLoggable { "Get My Api Collection By Name", s"""Get Api Collection By API_COLLECTION_NAME. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, apiCollectionJson400, @@ -8517,7 +8517,7 @@ trait APIMethods400 extends MdcLoggable { "Get My Api Collection By Id", s"""Get Api Collection By API_COLLECTION_ID. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, apiCollectionJson400, @@ -8548,7 +8548,7 @@ trait APIMethods400 extends MdcLoggable { "/api-collections/sharable/API_COLLECTION_ID", "Get Sharable Api Collection By Id", s"""Get Sharable Api Collection By Id. - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |""".stripMargin, EmptyBody, apiCollectionJson400, @@ -8581,7 +8581,7 @@ trait APIMethods400 extends MdcLoggable { "Get Api Collections for User", s"""Get Api Collections for User. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, apiCollectionsJson400, @@ -8614,7 +8614,7 @@ trait APIMethods400 extends MdcLoggable { "Get Featured Api Collections", s"""Get Featured Api Collections. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |""".stripMargin, EmptyBody, apiCollectionsJson400, @@ -8645,7 +8645,7 @@ trait APIMethods400 extends MdcLoggable { "Get My Api Collections", s"""Get all the apiCollections for logged in user. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -8679,7 +8679,7 @@ trait APIMethods400 extends MdcLoggable { | |${Glossary.getGlossaryItem("API Collections")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | | | @@ -8718,7 +8718,7 @@ trait APIMethods400 extends MdcLoggable { |${Glossary.getGlossaryItem("API Collections")} | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, postApiCollectionEndpointJson400, @@ -8767,7 +8767,7 @@ trait APIMethods400 extends MdcLoggable { | |${Glossary.getGlossaryItem("API Collections")} | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, postApiCollectionEndpointJson400, @@ -8815,7 +8815,7 @@ trait APIMethods400 extends MdcLoggable { "Get My Api Collection Endpoint", s"""Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |""".stripMargin, EmptyBody, apiCollectionEndpointJson400, @@ -8852,7 +8852,7 @@ trait APIMethods400 extends MdcLoggable { "Get Api Collection Endpoints", s"""Get Api Collection Endpoints By API_COLLECTION_ID. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} |""".stripMargin, EmptyBody, apiCollectionEndpointsJson400, @@ -8883,7 +8883,7 @@ trait APIMethods400 extends MdcLoggable { "Get My Api Collection Endpoints", s"""Get Api Collection Endpoints By API_COLLECTION_NAME. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, apiCollectionEndpointsJson400, @@ -8916,7 +8916,7 @@ trait APIMethods400 extends MdcLoggable { "Get My Api Collection Endpoints By Id", s"""Get Api Collection Endpoints By API_COLLECTION_ID. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, apiCollectionEndpointsJson400, @@ -8952,7 +8952,7 @@ trait APIMethods400 extends MdcLoggable { | |Delete Api Collection Endpoint By OPERATION_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -8989,7 +8989,7 @@ trait APIMethods400 extends MdcLoggable { | |Delete Api Collection Endpoint By OPERATION_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -9026,7 +9026,7 @@ trait APIMethods400 extends MdcLoggable { |Delete Api Collection Endpoint |Delete Api Collection Endpoint By Id | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -11196,7 +11196,7 @@ trait APIMethods400 extends MdcLoggable { | |You can use the url query parameters *limit* and *offset* for pagination | - |${authenticationRequiredMessage(!getAtmsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getAtmsIsPublic)}""".stripMargin, EmptyBody, atmsJsonV400, List( @@ -11246,7 +11246,7 @@ trait APIMethods400 extends MdcLoggable { |* Address |* Geo Location |* License the data under this endpoint is released under - |${authenticationRequiredMessage(!getAtmsIsPublic)} + |${userAuthenticationMessage(!getAtmsIsPublic)} |""".stripMargin, EmptyBody, atmJsonV400, @@ -11638,7 +11638,7 @@ trait APIMethods400 extends MdcLoggable { |Can filter with attributes name and values. |URL params example: /banks/some-bank-id/products?&limit=50&offset=1 | - |${authenticationRequiredMessage(!getProductsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getProductsIsPublic)}""".stripMargin, EmptyBody, productsJsonV400, List( @@ -11688,7 +11688,7 @@ trait APIMethods400 extends MdcLoggable { |$productHiearchyAndCollectionNote | | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | | |""", @@ -11761,7 +11761,7 @@ trait APIMethods400 extends MdcLoggable { |* Attributes |* Fees | - |${authenticationRequiredMessage(!getProductsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getProductsIsPublic)}""".stripMargin, EmptyBody, productJsonV400, List( @@ -11803,7 +11803,7 @@ trait APIMethods400 extends MdcLoggable { "Create Customer Message", s""" |Create a message for the customer specified by CUSTOMER_ID - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, createMessageJsonV400, @@ -11851,7 +11851,7 @@ trait APIMethods400 extends MdcLoggable { "/banks/BANK_ID/customers/CUSTOMER_ID/messages", "Get Customer Messages for a Customer", s"""Get messages for the customer specified by CUSTOMER_ID - ${authenticationRequiredMessage(true)} + ${userAuthenticationMessage(true)} """, EmptyBody, customerMessagesJsonV400, diff --git a/obp-api/src/main/scala/code/api/v5_0_0/APIMethods500.scala b/obp-api/src/main/scala/code/api/v5_0_0/APIMethods500.scala index 1b6c68f19c..22c3565ac5 100644 --- a/obp-api/src/main/scala/code/api/v5_0_0/APIMethods500.scala +++ b/obp-api/src/main/scala/code/api/v5_0_0/APIMethods500.scala @@ -445,7 +445,7 @@ trait APIMethods500 { "Create User Auth Context", s"""Create User Auth Context. These key value pairs will be propagated over connector to adapter. Normally used for mapping OBP user and | Bank User/Customer. - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", postUserAuthContextJson, userAuthContextJsonV500, @@ -486,7 +486,7 @@ trait APIMethods500 { s"""Get User Auth Contexts for a User. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -521,7 +521,7 @@ trait APIMethods500 { "/banks/BANK_ID/users/current/auth-context-updates/SCA_METHOD", "Create User Auth Context Update Request", s"""Create User Auth Context Update Request. - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |A One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD |SCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes. @@ -738,7 +738,7 @@ trait APIMethods500 { | |This endpoint gets the Consent By consent request id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1277,7 +1277,7 @@ trait APIMethods500 { | |Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", postCustomerJsonV500, customerJsonV310, @@ -1352,7 +1352,7 @@ trait APIMethods500 { s"""Gets the Customer Overview specified by customer_number and bank_code. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", postCustomerOverviewJsonV500, @@ -1401,7 +1401,7 @@ trait APIMethods500 { s"""Gets the Customer Overview Flat specified by customer_number and bank_code. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", postCustomerOverviewJsonV500, @@ -1486,7 +1486,7 @@ trait APIMethods500 { s"""Returns a list of Customers at the Bank that are linked to the currently authenticated User. | | - |${authenticationRequiredMessage(true)}""".stripMargin, + |${userAuthenticationMessage(true)}""".stripMargin, EmptyBody, customerJSONs, List( @@ -1529,7 +1529,7 @@ trait APIMethods500 { s"""Get Customers at Bank. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1614,7 +1614,7 @@ trait APIMethods500 { |$productHiearchyAndCollectionNote | | - |${authenticationRequiredMessage(true) } + |${userAuthenticationMessage(true) } | | |""", @@ -1678,7 +1678,7 @@ trait APIMethods500 { "Create Card", s"""Create Card at bank specified by BANK_ID . | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", createPhysicalCardJsonV500, physicalCardJsonV500, @@ -1798,7 +1798,7 @@ trait APIMethods500 { | |Returns the list of the views created for account ACCOUNT_ID at BANK_ID. | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view.""", + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view.""", EmptyBody, viewsJsonV500, List( @@ -1964,7 +1964,7 @@ trait APIMethods500 { "Get System View", s"""Get System View | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1998,7 +1998,7 @@ trait APIMethods500 { "Get Ids of System Views", s"""Get Ids of System Views | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -2033,7 +2033,7 @@ trait APIMethods500 { "Create System View", s"""Create a system view | - | ${authenticationRequiredMessage(true)} and the user needs to have access to the $canCreateSystemView entitlement. + | ${userAuthenticationMessage(true)} and the user needs to have access to the $canCreateSystemView entitlement. | | The 'allowed_actions' field is a list containing the names of the actions allowed through this view. | All the actions contained in the list will be set to `true` on the view creation, the rest will be set to `false`. @@ -2091,7 +2091,7 @@ trait APIMethods500 { "Update System View", s"""Update an existing view on a bank account | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | |The json sent is the same as during view creation (above), with one difference: the 'name' field |of a view is not editable (it is only set when a view is created)""", @@ -2136,7 +2136,7 @@ trait APIMethods500 { "Create Customer Account Link", s"""Link a Customer to a Account | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", createCustomerAccountLinkJson, @@ -2191,7 +2191,7 @@ trait APIMethods500 { "Get Customer Account Links by CUSTOMER_ID", s""" Get Customer Account Links by CUSTOMER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -2229,7 +2229,7 @@ trait APIMethods500 { "Get Customer Account Links by ACCOUNT_ID", s""" Get Customer Account Links by ACCOUNT_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -2264,7 +2264,7 @@ trait APIMethods500 { "Get Customer Account Link by Id", s""" Get Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -2298,7 +2298,7 @@ trait APIMethods500 { "Update Customer Account Link by Id", s""" Update Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", updateCustomerAccountLinkJson, @@ -2337,7 +2337,7 @@ trait APIMethods500 { "Delete Customer Account Link", s""" Delete Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -2372,7 +2372,7 @@ trait APIMethods500 { "Get Adapter Info", s"""Get basic information about the Adapter. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, diff --git a/obp-api/src/main/scala/code/api/v5_1_0/APIMethods510.scala b/obp-api/src/main/scala/code/api/v5_1_0/APIMethods510.scala index 3534aa3af2..2b2d2cddc6 100644 --- a/obp-api/src/main/scala/code/api/v5_1_0/APIMethods510.scala +++ b/obp-api/src/main/scala/code/api/v5_1_0/APIMethods510.scala @@ -197,7 +197,7 @@ trait APIMethods510 { "Create Regulated Entity", s"""Create Regulated Entity | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", regulatedEntityPostJsonV510, @@ -254,7 +254,7 @@ trait APIMethods510 { "Delete Regulated Entity", s"""Delete Regulated Entity specified by REGULATED_ENTITY_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, EmptyBody, @@ -326,7 +326,7 @@ trait APIMethods510 { "Get All API Collections", s"""Get All API Collections. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, apiCollectionsJson400, @@ -357,7 +357,7 @@ trait APIMethods510 { "/banks/BANK_ID/agents", "Create Agent", s""" - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", postAgentJsonV510, agentJsonV510, @@ -416,7 +416,7 @@ trait APIMethods510 { "/banks/BANK_ID/agents/AGENT_ID", "Update Agent status", s""" - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""", putAgentJsonV510, agentJsonV510, @@ -465,7 +465,7 @@ trait APIMethods510 { "Get Agent", s"""Get Agent. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, agentJsonV510, @@ -506,7 +506,7 @@ trait APIMethods510 { | |The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", userAttributeJsonV510, @@ -559,7 +559,7 @@ trait APIMethods510 { "Delete Non Personal User Attribute", s"""Delete the Non Personal User Attribute specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, EmptyBody, @@ -599,7 +599,7 @@ trait APIMethods510 { "Get Non Personal User Attributes", s"""Get Non Personal User Attribute for a user specified by USER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, EmptyBody, @@ -642,7 +642,7 @@ trait APIMethods510 { |PROVIDER_ID is the unique identifier for the User at the PROVIDER. |At the end of the process, a User will exist in OBP with the Account Access records defined by the CBS. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -811,7 +811,7 @@ trait APIMethods510 { "Check Custom View Names", s"""Check custom view names. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, CheckSystemIntegrityJsonV510(true), @@ -847,7 +847,7 @@ trait APIMethods510 { "Check System View Names", s"""Check system view names. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, CheckSystemIntegrityJsonV510(true), @@ -884,7 +884,7 @@ trait APIMethods510 { "Check Unique Index at Account Access", s"""Check unique index at account access table. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, CheckSystemIntegrityJsonV510(true), @@ -920,7 +920,7 @@ trait APIMethods510 { "Check for Sensible Currencies", s"""Check for sensible currencies at Bank Account model | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, CheckSystemIntegrityJsonV510(true), @@ -994,7 +994,7 @@ trait APIMethods510 { "Check for Orphaned Accounts", s"""Check for orphaned accounts at Bank Account model | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, EmptyBody, CheckSystemIntegrityJsonV510(true), @@ -1044,7 +1044,7 @@ trait APIMethods510 { | |The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", atmAttributeJsonV510, @@ -1097,7 +1097,7 @@ trait APIMethods510 { "Get Agents at Bank", s"""Get Agents at Bank. | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |${urlParametersDocument(true, true)} |""".stripMargin, @@ -1132,7 +1132,7 @@ trait APIMethods510 { "Get ATM Attributes", s""" Get ATM Attributes | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1168,7 +1168,7 @@ trait APIMethods510 { "Get ATM Attribute By ATM_ATTRIBUTE_ID", s""" Get ATM Attribute By ATM_ATTRIBUTE_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1207,7 +1207,7 @@ trait APIMethods510 { | |Update an ATM Attribute by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", atmAttributeJsonV510, @@ -1265,7 +1265,7 @@ trait APIMethods510 { | |Delete a Atm Attribute by its id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -1307,7 +1307,7 @@ trait APIMethods510 { | |Each Consent has one of the following states: ${ConsentStatus.values.toList.sorted.mkString(", ")}. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", PutConsentStatusJsonV400(status = "AUTHORISED"), @@ -1360,7 +1360,7 @@ trait APIMethods510 { | |This endpoint is used to update the Account Access of Consent. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", PutConsentPayloadJsonV510( @@ -1449,7 +1449,7 @@ trait APIMethods510 { | |If successful, the "Created by User ID" field in the OBP Consent table will be updated. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", PutConsentUserJsonV400(user_id = "ed7a7c01-db37-45cc-ba12-0ae8891c195c"), @@ -1527,7 +1527,7 @@ trait APIMethods510 { | |This endpoint gets the Consents created by a current User. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1567,7 +1567,7 @@ trait APIMethods510 { | |This endpoint gets the Consents at Bank by BANK_ID. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |1 limit (for pagination: defaults to 50) eg:limit=200 | @@ -1621,7 +1621,7 @@ trait APIMethods510 { | |This endpoint gets the Consents. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |1 limit (for pagination: defaults to 50) eg:limit=200 | @@ -1679,7 +1679,7 @@ trait APIMethods510 { | |This endpoint gets the Consent By consent id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1717,7 +1717,7 @@ trait APIMethods510 { | |This endpoint gets the Consent By consent id. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1761,7 +1761,7 @@ trait APIMethods510 { |OBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user. |The status of the token is changed to "REVOKED" so the next time the revoked client makes a request, their token will fail to validate. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1814,7 +1814,7 @@ trait APIMethods510 { |OBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user. |The status of the token is changed to "REVOKED" so the next time the revoked client makes a request, their token will fail to validate. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1855,7 +1855,7 @@ trait APIMethods510 { s""" |Provide client's certificate info of a current call specified by PSD2-CERT value at Request Header | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -1891,7 +1891,7 @@ trait APIMethods510 { "Update My Api Collection By API_COLLECTION_ID", s"""Update Api Collection for logged in user. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} |""".stripMargin, postApiCollectionJson400, apiCollectionJson400, @@ -1935,7 +1935,7 @@ trait APIMethods510 { "Get User by USERNAME", s"""Get user by PROVIDER and USERNAME | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |CanGetAnyUser entitlement is required, | @@ -1971,7 +1971,7 @@ trait APIMethods510 { "Get User Lock Status", s""" |Get User Login Status. - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -2013,7 +2013,7 @@ trait APIMethods510 { | |(Perhaps the user was locked due to multiple failed login attempts) | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -2058,7 +2058,7 @@ trait APIMethods510 { s""" |Lock a User. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""".stripMargin, EmptyBody, @@ -2127,7 +2127,7 @@ trait APIMethods510 { | |14 include_implemented_by_partial_functions (if null ignore).eg: &include_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | """.stripMargin, EmptyBody, @@ -2267,7 +2267,7 @@ trait APIMethods510 { s"""Gets all Customers Ids that are linked to a User. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -2306,7 +2306,7 @@ trait APIMethods510 { s"""Gets the Customers specified by Legal Name. | | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", postCustomerLegalNameJsonV510, @@ -2441,7 +2441,7 @@ trait APIMethods510 { | |You can use the url query parameters *limit* and *offset* for pagination | - |${authenticationRequiredMessage(!getAtmsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getAtmsIsPublic)}""".stripMargin, EmptyBody, atmsJsonV510, List( @@ -2504,7 +2504,7 @@ trait APIMethods510 { | | | - |${authenticationRequiredMessage(!getAtmsIsPublic)}""".stripMargin, + |${userAuthenticationMessage(!getAtmsIsPublic)}""".stripMargin, EmptyBody, atmJsonV510, List(UserNotLoggedIn, BankNotFound, AtmNotFoundByAtmId, UnknownError), @@ -2870,7 +2870,7 @@ trait APIMethods510 { "Get Consumers", s"""Get the all Consumers. | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |${urlParametersDocument(true, true)} | @@ -2909,7 +2909,7 @@ trait APIMethods510 { "Grant User access to View", s"""Grants the User identified by USER_ID access to the view identified. | - |${authenticationRequiredMessage(true)} and the user needs to be account holder. + |${userAuthenticationMessage(true)} and the user needs to be account holder. | |""", postAccountAccessJsonV510, @@ -2970,7 +2970,7 @@ trait APIMethods510 { "Revoke User access to View", s"""Revoke the User identified by USER_ID access to the view identified. | - |${authenticationRequiredMessage(true)}. + |${userAuthenticationMessage(true)}. | |""", postAccountAccessJsonV510, @@ -3040,7 +3040,7 @@ trait APIMethods510 { | |This endpoint will create the (DAuth) User with username and provider if the User does not already exist. | - |${authenticationRequiredMessage(true)} and the logged in user needs to be account holder. + |${userAuthenticationMessage(true)} and the logged in user needs to be account holder. | |For information about DAuth see below: | @@ -3186,7 +3186,7 @@ trait APIMethods510 { "Get Account Access by USER_ID", s"""Get Account Access by USER_ID | - |${authenticationRequiredMessage(true)} + |${userAuthenticationMessage(true)} | |""", EmptyBody, @@ -3220,7 +3220,7 @@ trait APIMethods510 { "Get API Tags", s"""Get API TagsGet API Tags | - |${authenticationRequiredMessage(false)} + |${userAuthenticationMessage(false)} | |""", EmptyBody, @@ -3751,7 +3751,7 @@ trait APIMethods510 { "Create Custom View", s"""Create a custom view on bank account | - | ${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + | ${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | The 'alias' field in the JSON can take one of three values: | | * _public_: to use the public alias if there is one specified for the other account. @@ -3819,7 +3819,7 @@ trait APIMethods510 { "Update Custom View", s"""Update an existing custom view on a bank account | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view. + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view. | |The json sent is the same as during view creation (above), with one difference: the 'name' field |of a view is not editable (it is only set when a view is created)""", @@ -3898,7 +3898,7 @@ trait APIMethods510 { | |Returns the list of the views created for account ACCOUNT_ID at BANK_ID. | - |${authenticationRequiredMessage(true)} and the user needs to have access to the owner view.""", + |${userAuthenticationMessage(true)} and the user needs to have access to the owner view.""", EmptyBody, customViewJsonV510, List( @@ -3990,7 +3990,7 @@ trait APIMethods510 { |VRPs are useful in situations when a beneficiary needs to be paid different amounts on a regular basis. | |Once granted, the consent allows its holder to initiate multiple Transaction Requests to the Counterparty defined in this endpoint as long as the - |Counterparty Limits are respected. + |Counterparty Limits linked to this particular consent are respected. | |Client, Consumer or Application Authentication is mandatory for this endpoint. | @@ -4012,6 +4012,8 @@ trait APIMethods510 { | |After successfully creating the VRP consent request, you need to call the `Create Consent By CONSENT_REQUEST_ID` endpoint to finalize the consent using the CONSENT_REQUEST_ID returned by this endpoint. | + |${userAuthenticationMessage(true)} + | |""".stripMargin, postVRPConsentRequestJsonV510, vrpConsentRequestResponseJson,