Skip to content

docs: Secret object/array inputs #1682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 21, 2025
Merged

docs: Secret object/array inputs #1682

merged 5 commits into from
Jul 21, 2025

Conversation

MFori
Copy link
Member

@MFori MFori commented Jul 10, 2025

Add notes about isSecret availability for object/array inputs. Context: apify/apify-shared-js#515

@MFori MFori self-assigned this Jul 10, 2025
@MFori MFori added the t-console Issues with this label are in the ownership of the console team. label Jul 10, 2025
@github-actions github-actions bot added this to the 118th sprint - Console team milestone Jul 10, 2025
@apify-service-account
Copy link

Preview for this PR was built for commit 944a82f and is ready at https://pr-1682.preview.docs.apify.com!


:::

## Read secret input fields

When you read the Actor input through `Actor.getInput()`, the encrypted fields are automatically decrypted (starting with the [`apify` package](https://www.npmjs.com/package/apify) version 3.1.0).
When you read the Actor input through `Actor.getInput()`, the encrypted fields are automatically decrypted. Decryption of string fields is supported since [JavaScript SDK](http://docs.apify.loc/sdk/js/) 3.1.0; support for objects and arrays was added in [JavaScript SDK](http://docs.apify.loc/sdk/js/) 3.4.2 and [Python SDK](http://docs.apify.loc/sdk/python/) 2.7.0.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about the note with starting support for string fields since 3.1.0 is 3 years old

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MFori MFori marked this pull request as ready for review July 16, 2025 10:59
@MFori MFori requested a review from TC-MO as a code owner July 16, 2025 10:59
@apify-service-account
Copy link

Preview for this PR was built for commit 97a13d7e and is ready at https://pr-1682.preview.docs.apify.com!

@MFori MFori requested a review from valekjo July 16, 2025 10:59
@EvilWestOG

This comment was marked as spam.


:::

## Read secret input fields

When you read the Actor input through `Actor.getInput()`, the encrypted fields are automatically decrypted (starting with the [`apify` package](https://www.npmjs.com/package/apify) version 3.1.0).
When you read the Actor input through `Actor.getInput()`, the encrypted fields are automatically decrypted. Decryption of string fields is supported since [JavaScript SDK](http://docs.apify.loc/sdk/js/) 3.1.0; support for objects and arrays was added in [JavaScript SDK](http://docs.apify.loc/sdk/js/) 3.4.2 and [Python SDK](http://docs.apify.loc/sdk/python/) 2.7.0.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MFori and others added 2 commits July 21, 2025 17:15
@apify-service-account
Copy link

Preview for this PR was built for commit 4983d01b and is ready at https://pr-1682.preview.docs.apify.com!

@MFori MFori requested a review from TC-MO July 21, 2025 15:19
@apify-service-account
Copy link

Preview for this PR was built for commit 4983d01b and is ready at https://pr-1682.preview.docs.apify.com!

Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo, otherwise LGTM

@apify-service-account
Copy link

Preview for this PR was built for commit 5cb88aca and is ready at https://pr-1682.preview.docs.apify.com!

@MFori MFori merged commit 913e294 into master Jul 21, 2025
10 checks passed
@MFori MFori deleted the feat/secret-objects branch July 21, 2025 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t-console Issues with this label are in the ownership of the console team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants