Clickwraps

A Clickwrap is a legal agreement (such as an NDA or Terms of Use) that your Users and/or Bundle/Inbox participants will need to agree to via a "Clickwrap" UI before accessing the site, bundle, or inbox.

The values for use_with_users, use_with_bundles, use_with_inboxes are explained as follows:

  • none - This Clickwrap may not be used in this context.
  • available_to_all_users - This Clickwrap may be assigned in this context by any user.
  • available - This Clickwrap may be assigned in this context, but only by Site Admins. We recognize that the name of this setting is somewhat ambiguous, but we maintain it for legacy reasons.
  • required - This Clickwrap will always be used in this context, and may not be overridden.

Resource Schema

Optional

PropertyDescription
name
String
Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
body
String
Body text of Clickwrap (supports Markdown formatting).
use_with_users
String
Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), require_all_users_once (show to all users at their next web login; once accepted, not shown again), require_all_users_always (show to all users on every web login).
Possible values: none, require, require_all_users_once, require_all_users_always
use_with_bundles
String
Use this Clickwrap for Bundles?
Possible values: none, available, require, available_to_all_users
use_with_inboxes
String
Use this Clickwrap for Inboxes?
Possible values: none, available, require, available_to_all_users

Read Only

PropertyDescription
id
Int64
Clickwrap ID

Example Resource

resource "files_clickwrap" "example_clickwrap" {
  name             = "Example Site NDA for Files.com Use"
  body             = "[Legal body text]"
  use_with_bundles = "example"
  use_with_inboxes = "example"
  use_with_users   = "example"
}

Resource Import

This Resource supports importing using the following syntax:

Example Import Command

# Clickwraps can be imported by specifying the id.
terraform import files_clickwrap.example_clickwrap 1

Data Source Schema

Required

PropertyDescription
id
Int64
Clickwrap ID

Read Only

PropertyDescription
name
String
Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
body
String
Body text of Clickwrap (supports Markdown formatting).
use_with_users
String
Use this Clickwrap for Users? Values: none, require (new user signup via email invitation only), require_all_users_once (show to all users at their next web login; once accepted, not shown again), require_all_users_always (show to all users on every web login).
Possible values: none, require, require_all_users_once, require_all_users_always
use_with_bundles
String
Use this Clickwrap for Bundles?
Possible values: none, available, require, available_to_all_users
use_with_inboxes
String
Use this Clickwrap for Inboxes?
Possible values: none, available, require, available_to_all_users

Example Data Source

data "files_clickwrap" "example_clickwrap" {
  id = 1
}