Index
ConsentService
(interface)ActivateConsentRequest
(message)ArchiveUserDataMappingRequest
(message)ArchiveUserDataMappingResponse
(message)Attribute
(message)AttributeDefinition
(message)AttributeDefinition.Category
(enum)CheckDataAccessRequest
(message)CheckDataAccessRequest.ResponseView
(enum)CheckDataAccessResponse
(message)Consent
(message)Consent.State
(enum)ConsentArtifact
(message)ConsentEvaluation
(message)ConsentEvaluation.EvaluationResult
(enum)ConsentList
(message)ConsentStore
(message)CreateAttributeDefinitionRequest
(message)CreateConsentArtifactRequest
(message)CreateConsentRequest
(message)CreateConsentStoreRequest
(message)CreateUserDataMappingRequest
(message)DeleteAttributeDefinitionRequest
(message)DeleteConsentArtifactRequest
(message)DeleteConsentRequest
(message)DeleteConsentRevisionRequest
(message)DeleteConsentStoreRequest
(message)DeleteUserDataMappingRequest
(message)EvaluateUserConsentsRequest
(message)EvaluateUserConsentsRequest.ResponseView
(enum)EvaluateUserConsentsResponse
(message)EvaluateUserConsentsResponse.Result
(message)GcsDestination
(message)GetAttributeDefinitionRequest
(message)GetConsentArtifactRequest
(message)GetConsentRequest
(message)GetConsentStoreRequest
(message)GetUserDataMappingRequest
(message)Image
(message)ListAttributeDefinitionsRequest
(message)ListAttributeDefinitionsResponse
(message)ListConsentArtifactsRequest
(message)ListConsentArtifactsResponse
(message)ListConsentRevisionsRequest
(message)ListConsentRevisionsResponse
(message)ListConsentStoresRequest
(message)ListConsentStoresResponse
(message)ListConsentsRequest
(message)ListConsentsResponse
(message)ListUserDataMappingsRequest
(message)ListUserDataMappingsResponse
(message)Policy
(message)QueryAccessibleDataRequest
(message)QueryAccessibleDataResponse
(message)RejectConsentRequest
(message)RevokeConsentRequest
(message)Signature
(message)UpdateAttributeDefinitionRequest
(message)UpdateConsentRequest
(message)UpdateConsentStoreRequest
(message)UpdateUserDataMappingRequest
(message)UserDataMapping
(message)
ConsentService
A service for managing user consents.
ActivateConsent |
---|
Activates the latest revision of the specified
|
ArchiveUserDataMapping |
---|
Archives the specified
|
CheckDataAccess |
---|
Checks if a particular data_id of a
|
CreateAttributeDefinition |
---|
Creates a new
|
CreateConsent |
---|
Creates a new
|
CreateConsentArtifact |
---|
Creates a new
|
CreateConsentStore |
---|
Creates a new
|
CreateUserDataMapping |
---|
Creates a new
|
DeleteAttributeDefinition |
---|
Deletes the specified
|
DeleteConsent |
---|
Deletes the
|
DeleteConsentArtifact |
---|
Deletes the specified
|
DeleteConsentRevision |
---|
Deletes the specified revision of a
|
DeleteConsentStore |
---|
Deletes the specified
|
DeleteUserDataMapping |
---|
Deletes the specified
|
EvaluateUserConsents |
---|
Evaluates the user's Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated and when they are included in EvaluateUserConsents results.
|
GetAttributeDefinition |
---|
Gets the specified
|
GetConsent |
---|
Gets the specified revision of a
|
GetConsentArtifact |
---|
Gets the specified
|
GetConsentStore |
---|
Gets the specified
|
GetUserDataMapping |
---|
Gets the specified
|
ListAttributeDefinitions |
---|
Lists the
|
ListConsentArtifacts |
---|
Lists the
|
ListConsentRevisions |
---|
Lists the revisions of the specified
|
ListConsentStores |
---|
Lists the
|
ListConsents |
---|
Lists the
|
ListUserDataMappings |
---|
Lists the
|
QueryAccessibleData |
---|
Queries all data_ids that are consented for a specified use in the given The returned If the request is successful, a detailed response is returned of type Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). For example, the following sample log entry shows a
|
RejectConsent |
---|
Rejects the latest revision of the specified
|
RevokeConsent |
---|
Revokes the latest revision of the specified
|
UpdateAttributeDefinition |
---|
Updates the specified
|
UpdateConsent |
---|
Updates the latest revision of the specified
|
UpdateConsentStore |
---|
Updates the specified
|
UpdateUserDataMapping |
---|
Updates the specified
|
ActivateConsentRequest
Activates the latest revision of the specified Consent
by committing a new revision with state
updated to ACTIVE
. If the latest revision of the given Consent is in the ACTIVE
state, no new revision is committed. A FAILED_PRECONDITION
error occurs if the latest revision of the given consent is in the REJECTED
or REVOKED
state.
Fields | |
---|---|
name |
Required. The resource name of the Consent to activate, of the form Authorization requires the following IAM permission on the specified resource
|
consent_artifact |
Required. The resource name of the Consent artifact that contains documentation of the user's consent, of the form Authorization requires the following IAM permission on the specified resource
|
Union field expiration . Optional. Allows setting expiration time for Consents. Expired consents are ignored in access determination methods such as [CheckDataAccess]. This value overrides the expiration duration configured for the consent store. expiration can be only one of the following: |
|
expire_time |
Timestamp in UTC of when this Consent is considered expired. |
ttl |
The time to live for this Consent from when it is marked as active. |
ArchiveUserDataMappingRequest
Archives the specified User data mapping
.
Fields | |
---|---|
name |
Required. The resource name of the User data mapping to archive. Authorization requires the following IAM permission on the specified resource
|
ArchiveUserDataMappingResponse
This type has no fields.
Archives the specified User data mapping
.
Attribute
An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition
in the consent store that defines the default and allowed values.
Fields | |
---|---|
attribute_definition_id |
Indicates the name of an attribute defined in the consent store. |
values[] |
The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values. |
AttributeDefinition
A client-defined consent attribute.
Fields | |
---|---|
name |
Resource name of the Attribute definition, of the form |
description |
Optional. A description of the attribute. |
category |
Required. The category of the attribute. The value of this field cannot be changed after creation. |
allowed_values[] |
Required. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation. |
consent_default_values[] |
Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. |
data_mapping_default_value |
Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category |
Category
The category of the attribute.
Enums | |
---|---|
CATEGORY_UNSPECIFIED |
No category specified. This option is invalid. |
RESOURCE |
Specify this category when this attribute describes the properties of resources. For example, data anonymity or data type. |
REQUEST |
Specify this category when this attribute describes the properties of requests. For example, requester's role or requester's organization. |
CheckDataAccessRequest
Checks if a particular data_id of a User data mapping
in the given consent store
is consented for a given use.
Fields | |
---|---|
consent_store |
Required. Name of the consent store where the requested data_id is stored, of the form Authorization requires the following IAM permission on the specified resource
|
data_id |
Required. The unique identifier of the resource to check access for. This identifier must correspond to a User data mapping in the given consent store. |
request_attributes |
The values of request attributes associated with this access request. |
response_view |
Optional. The view for |
Union field consent_selection . The selection of Consents to evaluate the access request against. If no selection is specified, the access request is evaluated against all ACTIVE unexpired Consents with the same user_id as the data to check access for. consent_selection can be only one of the following: |
|
consent_list |
Optional. Specific |
ResponseView
The supported views for CheckDataAccessResponse
.
Enums | |
---|---|
RESPONSE_VIEW_UNSPECIFIED |
No response view specified. The API will default to the BASIC view. |
BASIC |
Only the consented field is populated in CheckDataAccessResponse . |
FULL |
All fields within CheckDataAccessResponse are populated. When set to FULL , all ACTIVE Consents are evaluated even if a matching policy is found during evaluation. |
CheckDataAccessResponse
Checks if a particular data_id of a User data mapping
in the given consent store
is consented for a given use.
Fields | |
---|---|
consented |
Whether the requested resource is consented for the given use. |
consent_details |
The resource names of all evaluated |
Consent
Represents a user's consent.
Fields | |
---|---|
name |
Resource name of the Consent, of the form |
revision_id |
Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending |
revision_create_time |
Output only. The timestamp that the revision was created. |
user_id |
Required. User's UUID provided by the client. |
policies[] |
Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. |
consent_artifact |
Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form |
state |
|