View Source GoogleApi.RecaptchaEnterprise.V1.Api.Projects (google_api_recaptcha_enterprise v0.7.0)

API calls for all endpoints tagged Projects.

Summary

Functions

recaptchaenterprise_projects_assessments_annotate(connection, name, optional_params \\ [], opts \\ [])

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.

recaptchaenterprise_projects_assessments_create(connection, parent, optional_params \\ [], opts \\ [])

Creates an Assessment of the likelihood an event is legitimate.

recaptchaenterprise_projects_firewallpolicies_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

recaptchaenterprise_projects_firewallpolicies_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes the specified firewall policy.

recaptchaenterprise_projects_firewallpolicies_get(connection, name, optional_params \\ [], opts \\ [])

Returns the specified firewall policy.

recaptchaenterprise_projects_firewallpolicies_list(connection, parent, optional_params \\ [], opts \\ [])

Returns the list of all firewall policies that belong to a project.

recaptchaenterprise_projects_firewallpolicies_patch(connection, name, optional_params \\ [], opts \\ [])

Updates the specified firewall policy.

recaptchaenterprise_projects_firewallpolicies_reorder(connection, parent, optional_params \\ [], opts \\ [])

Reorders all firewall policies.

recaptchaenterprise_projects_keys_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a new reCAPTCHA Enterprise key.

recaptchaenterprise_projects_keys_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes the specified key.

recaptchaenterprise_projects_keys_get(connection, name, optional_params \\ [], opts \\ [])

Returns the specified key.

recaptchaenterprise_projects_keys_get_metrics(connection, name, optional_params \\ [], opts \\ [])

Get some aggregated metrics for a Key. This data can be used to build dashboards.

recaptchaenterprise_projects_keys_list(connection, parent, optional_params \\ [], opts \\ [])

Returns the list of all keys that belong to a project.

recaptchaenterprise_projects_keys_migrate(connection, name, optional_params \\ [], opts \\ [])

Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

recaptchaenterprise_projects_keys_patch(connection, name, optional_params \\ [], opts \\ [])

Updates the specified key.

recaptchaenterprise_projects_keys_retrieve_legacy_secret_key(connection, key, optional_params \\ [], opts \\ [])

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

recaptchaenterprise_projects_relatedaccountgroupmemberships_search(connection, project, optional_params \\ [], opts \\ [])

Search group memberships related to a given account.

recaptchaenterprise_projects_relatedaccountgroups_list(connection, parent, optional_params \\ [], opts \\ [])

List groups of related accounts.

recaptchaenterprise_projects_relatedaccountgroups_memberships_list(connection, parent, optional_params \\ [], opts \\ [])

Get memberships in a group of related accounts.

Functions

Link to this function

recaptchaenterprise_projects_assessments_annotate(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_assessments_annotate(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_assessments_create(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_assessments_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Assessment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an Assessment of the likelihood an event is legitimate.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the project in which the assessment will be created, in the format projects/{project}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Assessment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Assessment{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_firewallpolicies_create(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_firewallpolicies_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1FirewallPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the project this policy will apply to, in the format projects/{project}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1FirewallPolicy.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1FirewallPolicy{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_firewallpolicies_delete(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_firewallpolicies_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RecaptchaEnterprise.V1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified firewall policy.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the policy to be deleted, in the format projects/{project}/firewallpolicies/{firewallpolicy}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_firewallpolicies_get(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_firewallpolicies_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1FirewallPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the specified firewall policy.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the requested policy, in the format projects/{project}/firewallpolicies/{firewallpolicy}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1FirewallPolicy{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_firewallpolicies_list(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_firewallpolicies_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all firewall policies that belong to a project.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the project to list the policies for, in the format projects/{project}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of policies to return. Default is 10. Max limit is 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous. ListFirewallPoliciesRequest, if any.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_firewallpolicies_patch(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_firewallpolicies_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1FirewallPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified firewall policy.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • name (type: String.t) - Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields will be updated.
    • :body (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1FirewallPolicy.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1FirewallPolicy{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_firewallpolicies_reorder(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_firewallpolicies_reorder(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Reorders all firewall policies.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the project to list the policies for, in the format projects/{project}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_keys_create(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_keys_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Key.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new reCAPTCHA Enterprise key.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the project in which the key will be created, in the format projects/{project}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Key.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Key{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_keys_delete(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_keys_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RecaptchaEnterprise.V1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified key.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the key to be deleted, in the format projects/{project}/keys/{key}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_keys_get(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_keys_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Key.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the specified key.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the requested key, in the format projects/{project}/keys/{key}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Key{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_keys_get_metrics(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_keys_get_metrics(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Metrics.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get some aggregated metrics for a Key. This data can be used to build dashboards.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the requested metrics, in the format projects/{project}/keys/{key}/metrics.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Metrics{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_keys_list(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_keys_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ListKeysResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the list of all keys that belong to a project.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the project that contains the keys that will be listed, in the format projects/{project}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous. ListKeysRequest, if any.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ListKeysResponse{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_keys_migrate(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_keys_migrate(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Key.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the key to be migrated, in the format projects/{project}/keys/{key}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Key{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_keys_patch(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_keys_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Key.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified key.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • name (type: String.t) - Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated.
    • :body (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Key.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Key{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_keys_retrieve_legacy_secret_key(connection, key, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_keys_retrieve_legacy_secret_key(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • key (type: String.t) - Required. The public key name linked to the requested secret key in the format projects/{project}/keys/{key}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_relatedaccountgroupmemberships_search(connection, project, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_relatedaccountgroupmemberships_search(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Search group memberships related to a given account.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • project (type: String.t) - Required. The name of the project to search related account group memberships from. Specify the project name in the following format: projects/{project}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_relatedaccountgroups_list(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_relatedaccountgroups_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List groups of related accounts.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the project to list related account groups from, in the format projects/{project}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListRelatedAccountGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRelatedAccountGroups must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse{}} on success
  • {:error, info} on failure
Link to this function

recaptchaenterprise_projects_relatedaccountgroups_memberships_list(connection, parent, optional_params \\ [], opts \\ [])

View Source 
@spec recaptchaenterprise_projects_relatedaccountgroups_memberships_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get memberships in a group of related accounts.

Parameters

  • connection (type: GoogleApi.RecaptchaEnterprise.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name for the related account group in the format projects/{project}/relatedaccountgroups/{relatedaccountgroup}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of accounts to return. The service might return fewer than this value. If unspecified, at most 50 accounts are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListRelatedAccountGroupMemberships call. When paginating, all other parameters provided to ListRelatedAccountGroupMemberships must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse{}} on success
  • {:error, info} on failure