Skip to content

List Authorizations in Dynamic Collection v1.0.0 Help

Lists authorizations in a dynamic collection with detailed information.

How can I use the Step?

The Step lets you view authorizations in a specific dynamic collection. You can use the Step when you need to keep track of or update authorizations for various services in your key-value storage.

How does the Step work?

When executed, the Step retrieves a list of all authorizations stored in the specified dynamic collection within the __authorizer_dynamic_collections folder. It returns detailed information about each authorization, including the authorization key, record key, service, and collection name.

Dynamic collection settings

  • Dynamic collection name: Name of the dynamic collection to list authorizations. This name must match one of the existing dynamic collections in your key-value storage.

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 details about the total number of authorizations and an array of authorization items. Each item includes the authorization key and ID, service and dynamic collection names. For example:

json
{
    "total": 1,
    "items": [
        {
            "key": "kinde_basic_test_2",
            "authId": "668195a9-73be-4a95-9aa2-3e0a0b635b51::basic-collection::Kinde_oauth collection auth",
            "service": "__authorization_service_Kinde",
            "collectionName": "Kinde_oauth"
        }
    ]
}
{
    "total": 1,
    "items": [
        {
            "key": "kinde_basic_test_2",
            "authId": "668195a9-73be-4a95-9aa2-3e0a0b635b51::basic-collection::Kinde_oauth collection auth",
            "service": "__authorization_service_Kinde",
            "collectionName": "Kinde_oauth"
        }
    ]
}

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