Skip to content

Delete Authorization from Dynamic Collection v1.0.0 Help

Removes a specified authorization from a dynamic collection.

How can I use the Step?

Use this Step to delete an authorization from a dynamic collection within your key-value storage. This is essential when you need to manage or revoke access to services, ensuring that outdated or unnecessary authorizations are removed promptly.

How does the Step work?

The Step deletes a specified authorization from a given dynamic collection. It checks the collection and authorization key and removes the authorization entry from the collection. This action helps maintain the integrity and security of your service authorizations.

Dynamic collection settings

This section outlines the parameters for configuring the Step's interaction with dynamic collections:

  • Authorization source: Defines how the Step receives authorization information. You can inherit the dynamic collection name and authorization key from the previous Step or define them manually. Exception: The inheritance option doesn't work with the List Authorization in Dynamic Collection Step.
  • Dynamic collection name: Name of the dynamic collection from which to delete the authorization.
  • Authorization key: The specific authorization key to be deleted from the dynamic collection.

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 includes the status and the message of the deletion operation. For example:

json
{
  "status": "ok",
  "message": "Authorization successfully deleted."
}
{
  "status": "ok",
  "message": "Authorization successfully deleted."
}

Error Handling

By default, the Step handles errors using a separate exit. 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

  • sdk-api v2.17.0
  • access event-manager v2.1.0
  • oauth redirect endpoint provider v2.1.6

Release notes

v1.0.0

  • Initial release