Skip to content

Delete Access Credentials v1.0.0 Help

Deletes access credentials and associated permissions data using a username-password pair or token.

How can I use the Step?

This Step lets you delete access credentials for Basic and Bearer HTTP authentication schemes. This way, you can revoke user access to protected resources by removing credentials from your storage.

How does the Step work?

The Step deletes credentials from your key-value storage using a hashed token or a username-password pair. If the Step can't find or verify the credentials, it throws an error and directs the Flow down the error exit.

Credentials type and collection

To set up the section, do the following:

  1. Select the credentials type.
  2. Select the collection within your key-value storage where credentials are stored.

Credentials to delete

To set up this section, do the following:

  1. Enter a username/password pair or token you want to delete.
  2. Optional: Disable the Check password match toggle to delete the username and password regardless of the password match.

Merge field settings

The Step returns the result as a JSON object and stores it under the Merge field name. To learn more about Merge fields and how to work with them, see our Merge fields guide.

Output example

The output JSON object contains the deletion status and message. For example, a successful response might look like this:

json
{
    "deleted": true,
    "message": "Credentials deleted."
}
{
    "deleted": true,
    "message": "Credentials deleted."
}

Error Handling

By default, the Step handles errors using a separate exit. So if any error occurs during the Step execution, the Flow proceeds down the error exit. For more information, see Error and timeout handling.

Reporting

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. To learn more, see Reporting events

Service dependencies

  • flow builder v2.34.0
  • studio v3.71.0
  • bot deployer v2.22.4
  • library v2.18.4

Release notes

v2.0.0

  • Initial release