View Source GoogleApi.RecaptchaEnterprise.V1.Api.Projects (google_api_recaptcha_enterprise v0.4.0)
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.
Creates an Assessment of the likelihood an event is legitimate.
Creates a new reCAPTCHA Enterprise key.
Deletes the specified key.
Returns the specified key.
Get some aggregated metrics for a Key. This data can be used to build dashboards.
Returns the list of all keys that belong to a project.
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 Site Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.
Updates the specified key.
Search group memberships related to a given account.
List groups of related accounts.
Get the memberships in a group of related accounts.
Link to this section Functions
recaptchaenterprise_projects_assessments_annotate(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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
recaptchaenterprise_projects_assessments_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
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
recaptchaenterprise_projects_keys_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
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
recaptchaenterprise_projects_keys_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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
recaptchaenterprise_projects_keys_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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
recaptchaenterprise_projects_keys_get_metrics(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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
recaptchaenterprise_projects_keys_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
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
recaptchaenterprise_projects_keys_migrate(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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 Site 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
recaptchaenterprise_projects_keys_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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
) - 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