Skip to content

Update Terms

cognitoidentityprovider_update_terms R Documentation

Modifies existing terms documents for the requested app client

Description

Modifies existing terms documents for the requested app client. When Terms and conditions and Privacy policy documents are configured, the app client displays links to them in the sign-up page of managed login for the app client.

You can provide URLs for terms documents in the languages that are supported by managed login localization. Amazon Cognito directs users to the terms documents for their current language, with fallback to default if no document exists for the language.

Each request accepts one type of terms document and a map of language-to-link for that document type. You must provide both types of terms documents in at least one language before Amazon Cognito displays your terms documents. Supply each type in separate requests.

For more information, see Terms documents.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Usage

cognitoidentityprovider_update_terms(TermsId, UserPoolId, TermsName,
  TermsSource, Enforcement, Links)

Arguments

TermsId

[required] The ID of the terms document that you want to update.
UserPoolId

[required] The ID of the user pool that contains the terms that you want to update.
TermsName

The new name that you want to apply to the requested terms documents.
TermsSource

This parameter is reserved for future use and currently accepts only one value.
Enforcement

This parameter is reserved for future use and currently accepts only one value.
Links

A map of URLs to languages. For each localized language that will view the requested TermsName, assign a URL. A selection of cognito:default displays for all languages that don't have a language-specific URL.

For example, ⁠"cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es"⁠.

Value

A list with the following syntax:

list(
  Terms = list(
    TermsId = "string",
    UserPoolId = "string",
    ClientId = "string",
    TermsName = "string",
    TermsSource = "LINK",
    Enforcement = "NONE",
    Links = list(
      "string"
    ),
    CreationDate = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedDate = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$update_terms(
  TermsId = "string",
  UserPoolId = "string",
  TermsName = "string",
  TermsSource = "LINK",
  Enforcement = "NONE",
  Links = list(
    "string"
  )
)