Connectors

AWS S3 Connector

The AWS S3 connector lets you manage objects in Amazon S3 buckets, including uploading, retrieving, and deleting them from your PingOne DaVinci flow.

The connector authenticates by exchanging a PingOne access token for temporary AWS credentials, so you don’t need to store long-term AWS access keys.

Setup

Resources

You can find more information and setup help in the following:

Requirements

To use the connector, you’ll need:

  • A PingOne application configured for the client credentials grant type. The connector uses this application’s client ID and client secret to request an access token from PingOne.

  • An AWS IAM role that trusts your PingOne environment as a web identity provider and grants the permissions required for the actions you plan to use, such as s3:GetObject, s3:PutObject, or s3:DeleteObject.

  • The Amazon Resource Name (ARN) of that IAM role.

  • The AWS Region where your S3 bucket is located.

Configuring the AWS S3 connector

Add the connector in PingOne DaVinci as shown in Adding a connector, then configure it as follows.

Connector configuration

Setting Description

PingOne Client ID

The client ID of the PingOne application the connector uses to request an access token.

PingOne Client Secret

The client secret of the PingOne application the connector uses to request an access token.

PingOne Region

The PingOne region for your environment.

AWS Role ARN

The ARN of the AWS IAM role the connector assumes using the PingOne access token.

AWS Region

The AWS Region where your S3 bucket is located.

Using the connector in a flow

Storing an object in a bucket

Use the Put Object capability to upload an object to your S3 bucket. Set the Content Type Selection so the connector encodes the Object Data correctly: image content as base64 and text content as plain text.

Retrieving an object from a bucket

Use the Get Object capability to download an object from your S3 bucket. The connector returns image content as base64 and text content as plain text. It doesn’t retrieve objects larger than 10 MB.

Deleting an object from a bucket

Use the Delete Object capability to remove an object from your S3 bucket.

Capabilities

Get Object

Retrieves an object from a specified bucket.

Show details
  • Properties

  • Input Schema

  • Output Schema

Bucket Name textField required

Name of the AWS bucket

Object Key textField

Key associated with the corresponding object

  • default object

    • properties object

      • pingOneClientId string required

        PingOne Client ID

      • pingOneClientSecret string required

        PingOne Client Secret

      • pingOneRegion string required

        PingOne Region

      • awsRoleARN string required

        The ARN of the AWS IAM role that will be assumed using STS with the PingOne issued OIDC Token.

      • awsRegion string required

        AWS Region

      • bucket string required

        Name of bucket

      • key string required

        Key associated with the corresponding Object

  • output object

    • rawResponse object

    • statusCode number

    • bucketObject object

Put Object

Uploads an object to a specified bucket.

Show details
  • Properties

  • Input Schema

  • Output Schema

Bucket Name textField required

Name of the AWS bucket

Object Key textField

Key associated with the corresponding object

Object Data textField

Content that will be uploaded to the S3 bucket

Content Type Selection dropDown required

The MIME type of the object being uploaded

  • image/jpeg

  • image/png

  • text/plain

  • text/html

  • default object

    • properties object

      • pingOneClientId string required

        PingOne Client ID

      • pingOneClientSecret string required

        PingOne Client Secret

      • pingOneRegion string required

        PingOne Region

      • awsRoleARN string required

        The ARN of the AWS IAM role that will be assumed using STS with the PingOne issued OIDC Token.

      • awsRegion string required

        AWS Region

      • bucket string required

        Name of bucket

      • key string required

        Key associated with the corresponding Object

      • content string required

        Uploads object to S3 bucket

      • contentTypeSelection string required

        Content Type selection

  • output object

    • rawResponse object

    • statusCode number

Delete Object

Deletes an object from a specified bucket.

Show details
  • Properties

  • Input Schema

  • Output Schema

Bucket Name textField required

Name of the AWS bucket

Object Key textField

Key associated with the corresponding object

  • default object

    • properties object

      • pingOneClientId string required

        PingOne Client ID

      • pingOneClientSecret string required

        PingOne Client Secret

      • pingOneRegion string required

        PingOne Region

      • awsRoleARN string required

        The ARN of the AWS IAM role that will be assumed using STS with the PingOne issued OIDC Token.

      • awsRegion string required

        AWS Region

      • bucket string required

        Name of bucket

      • key string required

        Key associated with the corresponding Object

  • output object

    • rawResponse object

    • statusCode number