Esta página se ha traducido con Cloud Translation API.
Switch to English

Crear y actualizar consentimientos de usuarios

En esta página, se describe cómo crear, actualizar y revocar los consentimientos de los usuarios.

Tu aplicación registra los artefactos de consentimiento y los consentimientos por separado. La API de administración de consentimientos almacena datos sensibles relacionados con el consentimiento de un usuario como ConsentArtifact. Un ConsentArtifact puede incluir marcas de tiempo de firma y también imágenes de firmas o de otros documentos que actúen como "pruebas" de consentimiento.

La API de administración de consentimientos almacena datos de consentimiento no sensibles como objetos Consent. Un Consent incluye un ID de usuario opaco, las políticas de consentimiento que concede el usuario y el estado de las políticas de consentimiento.

Debido a que los consentimientos y los artefactos de consentimiento tienen diferentes rutas de recursos, sus permisos se pueden configurar de forma independiente para minimizar el acceso a datos de consentimiento sensibles en artefactos de consentimiento.

Los consentimientos admiten una duración de vencimiento que te permite configurar cuando un consentimiento vence y ya no es válido. La duración del vencimiento se puede establecer en una fecha o un período específicos, como un año.

Durante la creación del almacén de consentimientos, puedes configurar una duración de vencimiento predeterminada para ese almacén. Durante la creación de consentimientos, puedes configurar una duración de vencimiento para estos. La duración del vencimiento establecida durante la creación del consentimiento anula la duración predeterminada establecida para el almacén de consentimientos.

Se pueden crear consentimientos en los estados ACTIVE o DRAFT. La API de administración de consentimientos usa los consentimientos con estado ACTIVE para realizar determinaciones de acceso. Los consentimientos con estado DRAFT solo se usan en las determinaciones de acceso si se especifica en una solicitud de determinación de acceso. Puedes cambiar el estado de DRAFT a ACTIVE o REJECTED actualizando el consentimiento.

Para registrar un consentimiento de usuario, crea un artefacto de consentimiento con el método projects.locations.datasets.consentStores.consentArtifacts.create y, luego, vincula el artefacto de consentimiento con un consentimiento creado con el método projects.locations.datasets.consentStores.consents.create.

En las muestras de esta página, se supone que creaste un almacén de consentimientos y que configuraste las políticas de consentimiento.

Un artefacto de consentimiento almacena datos sensibles relacionados con el consentimiento de un usuario. Un artefacto de consentimiento puede incluir la información de contacto del usuario, las marcas de tiempo de firma y las imágenes de las firmas o demás documentos que actúan como "pruebas" de consentimiento.

Para crear un artefacto de consentimiento, usa el método projects.locations.datasets.consentStores.consentArtifacts.create. Realiza una solicitud POST y especifica la siguiente información en la solicitud:

  • El nombre del almacén del consentimiento principal
  • Un ID de usuario único y opaco que representa al usuario que proporcionó el consentimiento.
  • La firma del usuario, opcionalmente incluye la imagen de la firma, la marca de tiempo y otros metadatos. Esta imagen se puede especificar como una ubicación de imagen en Cloud Storage o como una string de bytes sin procesar
  • Una firma opcional o un tutor opcional.
  • Imágenes o documentos opcionales que actúan como "pruebas" de consentimiento, como una imagen de firma, imágenes que capturan las pantallas de un flujo de consentimiento móvil o un documento PDF firmado Estas imágenes se pueden especificar como una ubicación en Cloud Storage o como una string de bytes sin procesar
  • Un identificador para la información de consentimiento que se mostró al usuario.
  • Metadatos opcionales relacionados con el consentimiento del usuario.
  • Un token de acceso.

Un consentimiento almacena datos no sensibles, incluidos los ID de usuario opacos, las políticas de consentimiento que conceden los usuarios y si las políticas de consentimiento son válidas actualmente.

Para crear un consentimiento, usa el método projects.locations.datasets.consentStores.consents.create. Realiza una solicitud POST y especifica la siguiente información en la solicitud:

  • El nombre del almacén del consentimiento principal
  • Un ID de usuario único y opaco que representa al usuario que proporcionó el consentimiento.
  • Hasta 10 políticas de consentimiento, cada una con un conjunto de valores de atributos RESOURCE y una regla de autorización expresada en Lenguaje de expresión común (CEL) que describe el intent del usuario con definiciones de atributos creadas anteriormente. Se aplican las siguientes restricciones al CEL:
    • Solo puedes definir un máximo de 10 operadores lógicos por política.
    • Solo puede utilizar operadores AND (&&), OR (||) e IN.
  • La ruta de acceso de REST al artefacto de consentimiento correspondiente (que se muestra cuando se crea el artefacto de consentimiento).
  • Un estado de consentimiento opcional, ya sea DRAFT o ACTIVE. Si no especificas el estado, el consentimiento se crea con el estado ACTIVE.
  • Una duración de vencimiento opcional para el consentimiento, definida como una fecha o un período. Este valor se debe proporcionar en segundos y se debe usar la letra s como sufijo. Por ejemplo, 86000s. Este valor anula la duración de vencimiento configurada para el almacén de consentimiento. Si no configuras un vencimiento, el recurso hereda la duración de vencimiento predeterminada del almacén de consentimiento. Si no se especifica una duración de vencimiento para el recurso o el almacén, el recurso de consentimiento no vence.
  • Un token de acceso.

En los siguientes ejemplos, se muestra cómo obtener un consentimiento. Para obtener más información, consulta projects.locations.datasets.consentStores.consents.get

Para obtener un consentimiento, realiza una solicitud GET y especifica la siguiente información en la solicitud:

  • El nombre del conjunto de datos superior
  • El nombre del almacén de consentimientos
  • El nombre del consentimiento
  • Un token de acceso

En las siguientes muestras, se indica cómo enumerar los consentimientos en un almacén de consentimientos.

Para enumerar los consentimientos de un almacén de consentimientos, usa el método projects.locations.datasets.consentStores.consents.list.

También puedes enumerar las revisiones de un consentimiento específico mediante el método projects.locations.datasets.consentStores.consents.listRevisions.

Actualiza consentimientos

Es posible que debas actualizar el estado de los consentimientos a lo largo del tiempo. Para ello, cambia el estado del consentimiento. Cada actualización y cambio de estado genera una revisión nueva del consentimiento. Para acceder a las revisiones anteriores, anexa @{revision_id} al nombre de recurso del consentimiento.

Actualiza consentimientos

Para actualizar los campos userId, policies, consentArtifact o revokeConsentArtifact de un consentimiento activo o en borrador, usa el método projects.locations.datasets.consentStores.consents.patch. Se confirma una nueva revisión con los cambios y se establece en el estado actual.

Para actualizar un consentimiento, realiza una solicitud PATCH y especifica la siguiente información en la solicitud:

  • La ruta de acceso de REST del consentimiento que se debe actualizar
  • Los campos que se deben actualizar
  • Una máscara de actualización
  • Un token de acceso

Activa los consentimientos

Para cambiar el estado de un consentimiento de DRAFT a ACTIVE después de que el usuario acepte el consentimiento, usa el método projects.locations.datasets.consentStores.consents.activateConsent. Se confirma una nueva revisión con el estado ACTIVE. Cuando el estado del consentimiento es ACTIVE, el consentimiento se incluye en las solicitudes de determinación de acceso.

Para activar un consentimiento, realiza una solicitud POST y especifica la siguiente información en la solicitud:

  • La ruta de acceso de REST del consentimiento que se activará
  • La ruta de acceso de REST a un artefacto opcional para documentar por qué se activó el consentimiento
  • Un token de acceso

Revoca y rechaza consentimientos

Para cambiar el estado de un consentimiento de DRAFT a REJECTED, por ejemplo, si el usuario indica que el consentimiento no es aceptable, usa el método projects.locations.datasets.consentStores.consents.reject. Cuando el estado de un consentimiento es REJECTED, el consentimiento no se incluye en las solicitudes de determinación de acceso.

Para cambiar el estado de un consentimiento de ACTIVE a REVOKED, por ejemplo, si un usuario solicita anular un consentimiento ya otorgado, usa el método projects.locations.datasets.consentStores.consents.revoke. Se confirma una nueva revisión con el estado REVOKED. Los consentimientos con un estado REVOKED no se incluyen en las solicitudes de determinación de acceso. Puedes crear un artefacto opcional asociado con el consentimiento para documentar por qué se revocó el consentimiento. Revocar un consentimiento no borra el consentimiento.

Para revocar un consentimiento, realiza una solicitud POST y especifica la siguiente información en la solicitud:

  • La ruta de acceso de REST del consentimiento que se revocará
  • La ruta de acceso de REST a un artefacto opcional para documentar por qué se revocó el consentimiento
  • Un token de acceso