Create Dynamic Collection v1.0.0 Help ​

Creates a dynamic collection for the specified authorization service.

How can I use the Step? ​

You can use this Step to create a dynamic collection for managing authorizations. It's ideal for scenarios where you need to authorize services securely without exposing credentials. For example, when integrating with third-party services or APIs that require OAuth or other authorization types.

How does the Step work? ​

The Step creates an empty dynamic collection within your key-value storage in the __authorizer_dynamic_collections folder. A dynamic collection is a JSON file that points to the authorizations for a specific service but does not contain authorizations themselves.

Dynamic collection settings ​

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

  • Authorization type: Determines what type of authorization can be stored in the dynamic collection. Options include:
    • Basic: Uses username/password pairs encoded using Base64. To learn more, see RFC 7617.
    • Token: Uses bearer tokens. To learn more, see RFC 6750.
    • OAuth 2.0: Allows third-party apps to access an HTTP service on behalf of a user or itself. To learn more, see RFC 6749.
  • Dynamic collection name: Name for the dynamic collection to create. It must not contain the / slash or - hyphen characters.
  • Service name: Authorization service name. In the dynamic collection's JSON, formatted as __authorization_service_{name} e.g., __authorization_service_Slack.

Conflict handling ​

  • Action on duplicate collection name: Determines the action to take if a collection with the same name exists. Options include throwing an error or skipping the Step execution.

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 creation status, dynamic collection and service names, and authorization type. For example, a successful response might look like this:

json
{
  "status": "ok",
  "collectionName": "slack_oauth",
  "service": "__authorization_service_Slack",
  "type": "oauth",
}
{
  "status": "ok",
  "collectionName": "slack_oauth",
  "service": "__authorization_service_Slack",
  "type": "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 generates Reporting events during execution for real-time tracking and analysis of 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