Action - updateCredentials

Purpose:

When invoked, this action will allow the user to update the credentials assigned to them for use with your application - as long as they are entitled to do so by their Administrator. The newly updated credentials are provided to the caller of this method once the action is fulfilled by the user.

Inputs:

Renders:

A credential input dialog - containing the credential keys that the user is allowed to update:

🚧

User vs Company Credentials

User's are only entitled to create/update user credentials delegated solely to them. Users are not allowed to touch shared credential sets, or company level credential sets configured by their Administrator

If your credential requirements specify a combination of user and company level credentials - users will only be able to supply you updated values of their user-level credentials. Sometimes - if a company credential has been marked as required in your applications credential requirements - and it has not been configured by the Administrator - users will be prompted with an error, asking them to contact their Administrator (required credentials need to be configured).

📘

Reasons for seeing "Contact Admin" credential prompt:

1. You have not specified a credential requirements in your applications configuration
2. You have not configured a required company level credential for your test user, acting as the test Administrator of your application sandbox

Returns:

Type: Promise

==> Resolved:

The credential key and value pairs - keys as defined in your applications configured credential requirements, values as entered by the user when prompted upon action invocation

{
  CREDENTIAL_KEY_A: "{{USER_ENTERED_VALUE}},
  CREDENTIAL_KEY_B: "{{USER_ENTERED_VALUE}}
}

If the user closes the credentials prompt without entering updated credential values, the Promise will resolve to an empty object - {}

==> Rejected

An error is raised, containing a message attribute with details on the error that occurred

{
  message: "{{ERROR_DETAILS}}"
}