Halaman ini menunjukkan cara membuat dan mengelola penyimpanan izin.
Consent Management API adalah alat untuk mencatat izin pengguna, mengelola tindakan berdasarkan izin tersebut, dan mengelola dokumentasi dan catatan terkait.
Organisasi yang menggunakan Consent Management API bertanggung jawab untuk mendapatkan dan mempertahankan izin yang diperlukan untuk mengizinkan pemrosesan data apa pun melalui Consent Management API.
Consent Management API memenuhi peran titik keputusan kebijakan. Penerapan kebijakan harus diterapkan di aplikasi atau melalui proxy. Untuk mengetahui informasi selengkapnya, lihat Kontrol akses berbasis atribut.
Siapkan izin
Untuk menggunakan fitur dalam panduan ini, Anda harus memiliki
peran roles/healthcare.consentStoreAdmin
. Namun, untuk melakukan operasi tambahan yang berguna dengan
Consent Management API, izin tambahan mungkin diperlukan. Lihat
Kontrol akses
untuk mengetahui detail selengkapnya.
Membuat penyimpanan izin
Penyimpanan izin adalah resource tingkat teratas yang berisi semua informasi terkait konfigurasi dan operasi Consent Management API. Penyimpanan izin merupakan bagian dari set data Cloud Healthcare API, yang ditetapkan ke region saat dibuat. Wilayah ini adalah lokasi geografis tempat penyimpanan izin Anda beroperasi.
Konsol
Di konsol Google Cloud, buka halaman Datasets.
Pilih set data tempat Anda ingin membuat penyimpanan izin.
Klik Create data store.
Pilih Consent sebagai jenis penyimpanan data.
Di kolom ID, masukkan nama pilihan Anda yang unik dalam set data Anda. Jika nama tidak unik, pembuatan toko akan gagal.
Klik Berikutnya.
Di Konfigurasi Penyimpanan Izin, pilih salah satu opsi berikut untuk menentukan kapan izin di penyimpanan Anda berakhir masa berlakunya:
- Tidak ada waktu habis masa berlaku default berarti, secara default, izin tidak akan habis masa berlakunya.
- Waktu habis masa berlaku default berarti bahwa, secara default, masa berlaku izin akan berakhir setelah jumlah hari yang ditentukan di kolom Waktu habis masa berlaku.
Untuk mengizinkan pembuatan resource izin baru menggunakan
consentStores.patch
, klik Izinkan pembuatan izin pada update.Klik Berikutnya.
Klik Tambahkan label untuk menentukan label kunci dan nilai opsional untuk mengatur resource Google Cloud Anda.
Klik Create.
gcloud
Untuk membuat penyimpanan izin, jalankan perintah gcloud healthcare consent-stores create
.
Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:
- LOCATION: lokasi set data
- DATASET_ID: set data induk penyimpanan izin
- CONSENT_STORE_ID:
ID untuk penyimpanan izin. ID penyimpanan izin harus memiliki hal berikut:
- ID unik dalam set datanya
- String Unicode yang terdiri dari 1-256 karakter yang terdiri dari hal berikut:
- Numbers
- Surat
- Garis bawah
- Tanda Hubung
- Periode
Jalankan perintah berikut:
Linux, macOS, atau Cloud Shell
gcloud healthcare consent-stores create CONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores create CONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores create CONSENT_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION
Anda akan melihat respons seperti berikut:
Respons
Created consentStore [CONSENT_STORE_ID].
REST
Untuk membuat penyimpanan izin, gunakan metode
projects.locations.datasets.consentStores.create
.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: ID project Google Cloud Anda
- LOCATION: lokasi set data
- DATASET_ID: set data induk penyimpanan izin
- CONSENT_STORE_ID:
ID untuk penyimpanan izin. ID penyimpanan izin harus memiliki hal berikut:
- ID unik dalam set datanya
- String Unicode yang terdiri dari 1-256 karakter yang terdiri dari hal berikut:
- Numbers
- Surat
- Garis bawah
- Tanda Hubung
- Periode
- DEFAULT_CONSENT_EXPIRATION_DURATION: waktu default opsional, yang ditentukan dalam detik, hingga masa berlaku izin yang dibuat di penyimpanan ini berakhir. Durasi ini harus minimal 24 jam (86.400 detik) dan harus dalam format
DEFAULT_CONSENT_EXPIRATION_DURATIONs
. - ENABLE_CONSENT_CREATE_ON_UPDATE: boolean opsional yang menentukan apakah permintaan untuk menerapkan patch pada resource izin yang tidak ada menggunakan
consentStores.patch
harus membuat resource tersebut. Default-nya adalahFALSE
.
Meminta isi JSON:
{ "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" }
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Simpan isi permintaan dalam file bernama request.json
.
Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:
cat > request.json << 'EOF' { "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" } EOF
Kemudian, jalankan perintah berikut untuk mengirim permintaan REST Anda:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores?consentStoreId=CONSENT_STORE_ID"
PowerShell
Simpan isi permintaan dalam file bernama request.json
.
Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:
@' { "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" } '@ | Out-File -FilePath request.json -Encoding utf8
Kemudian jalankan perintah berikut untuk mengirim permintaan REST Anda:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores?consentStoreId=CONSENT_STORE_ID" | Select-Object -Expand Content
APIs Explorer
Salin isi permintaan dan buka halaman referensi metode. Panel API Explorer terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Tempelkan isi permintaan di alat ini, lengkapi kolom lainnya yang wajib diisi, lalu klik Jalankan.
Anda akan melihat respons JSON seperti berikut:
Node.js
Python
Mengedit penyimpanan izin
Setelah membuat penyimpanan izin, Anda dapat memperbaruinya. Misalnya, Anda dapat menambahkan atau menghapus label untuk mengatur penyimpanan izin.
Contoh berikut menunjukkan cara mengedit penyimpanan izin.
Konsol
Untuk mengedit penyimpanan izin, selesaikan langkah-langkah berikut:
- Di konsol Google Cloud, buka halaman Datasets.
- Pilih set data yang berisi penyimpanan izin yang ingin Anda edit.
- Dalam daftar Data store, klik data store yang ingin Anda edit.
- Untuk mengedit konfigurasi penyimpanan izin, klik ikon edit di samping Konfigurasi Penyimpanan Izin.
Untuk informasi selengkapnya tentang opsi konfigurasi penyimpanan izin, lihat Membuat penyimpanan izin. - Untuk menambahkan satu atau beberapa label ke toko, klik Menggunakan label resource. Labels, klik Add label, lalu masukkan label kunci/nilai. Untuk mengetahui informasi selengkapnya tentang label resource, lihat
- Klik Simpan.
gcloud
Untuk mengedit penyimpanan izin, jalankan perintah gcloud healthcare consent-stores update
.
Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:
- LOCATION: lokasi set data
- DATASET_ID: set data induk penyimpanan izin
- CONSENT_STORE_ID: ID penyimpanan izin
- KEY: kunci dalam key-value pair yang digunakan untuk mengatur penyimpanan izin. Lihat
labels
untuk mengetahui persyaratan dan batasan label. - VALUE: nilai dalam pasangan nilai kunci yang digunakan untuk mengatur penyimpanan izin. Lihat
labels
untuk mengetahui persyaratan dan batasan label.
Jalankan perintah berikut:
Linux, macOS, atau Cloud Shell
gcloud healthcare consent-stores update CONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION \ --update-labels=KEY=VALUE
Windows (PowerShell)
gcloud healthcare consent-stores update CONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION ` --update-labels=KEY=VALUE
Windows (cmd.exe)
gcloud healthcare consent-stores update CONSENT_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION ^ --update-labels=KEY=VALUE
Anda akan melihat respons seperti berikut:
Respons
Updated consentStore [CONSENT_STORE_ID]. labels: KEY: VALUE name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID
REST
Untuk mengedit penyimpanan izin, gunakan metode
projects.locations.datasets.consentStores.patch
.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: ID project Google Cloud Anda
- LOCATION: lokasi set data
- DATASET_ID: set data induk penyimpanan izin
- CONSENT_STORE_ID: ID penyimpanan izin
- KEY: kunci dalam pasangan nilai kunci yang digunakan untuk mengatur penyimpanan izin. Lihat
labels
untuk mengetahui persyaratan dan batasan label. - VALUE: nilai dalam pasangan nilai kunci yang digunakan untuk mengatur penyimpanan izin. Lihat
labels
untuk mengetahui persyaratan dan batasan label.
Meminta isi JSON:
{ "labels": { "KEY": "VALUE" } }
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Simpan isi permintaan dalam file bernama request.json
.
Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:
cat > request.json << 'EOF' { "labels": { "KEY": "VALUE" } } EOF
Kemudian, jalankan perintah berikut untuk mengirim permintaan REST Anda:
curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID?updateMask=labels"
PowerShell
Simpan isi permintaan dalam file bernama request.json
.
Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:
@' { "labels": { "KEY": "VALUE" } } '@ | Out-File -FilePath request.json -Encoding utf8
Kemudian jalankan perintah berikut untuk mengirim permintaan REST Anda:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID?updateMask=labels" | Select-Object -Expand Content
APIs Explorer
Salin isi permintaan dan buka halaman referensi metode. Panel API Explorer terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Tempelkan isi permintaan di alat ini, lengkapi kolom lainnya yang wajib diisi, lalu klik Jalankan.
Anda akan melihat respons JSON seperti berikut:
Node.js
Python
Mendapatkan detail toko izin
Contoh berikut menunjukkan cara mendapatkan detail tentang penyimpanan izin.
Konsol
Untuk melihat detail penyimpanan izin:
- Di konsol Google Cloud, buka halaman Datasets.
- Pilih set data yang berisi penyimpanan izin yang ingin Anda lihat.
- Klik nama penyimpanan izin.
Halaman Detail datastore menampilkan detail penyimpanan izin yang dipilih.
gcloud
Untuk mendapatkan detail tentang penyimpanan izin, jalankan perintah gcloud healthcare consent-stores describe
.
Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:
- LOCATION: lokasi set data
- DATASET_ID: set data induk penyimpanan izin
- CONSENT_STORE_ID: ID penyimpanan izin
Jalankan perintah berikut:
Linux, macOS, atau Cloud Shell
gcloud healthcare consent-stores describe CONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores describe CONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores describe CONSENT_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION
ConsentStore
, kolom tersebut juga akan muncul dalam respons.
Respons
name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID
REST
Untuk mendapatkan detail tentang penyimpanan izin, gunakan metode
projects.locations.datasets.consentStores.get
.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: ID project Google Cloud Anda
- LOCATION: lokasi set data
- DATASET_ID: set data induk penyimpanan izin
- CONSENT_STORE_ID: ID penyimpanan izin
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Jalankan perintah berikut:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID"
PowerShell
Jalankan perintah berikut:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID" | Select-Object -Expand Content
APIs Explorer
Buka halaman referensi metode. Panel API Explorer terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Lengkapi kolom yang wajib diisi, lalu klik Jalankan.
ConsentStore
, kolom tersebut juga akan muncul dalam respons.
Node.js
Python
Mencantumkan penyimpanan izin dalam set data
Contoh berikut menunjukkan cara mencantumkan penyimpanan izin dalam set data.
Konsol
Untuk melihat penyimpanan data dalam set data:
- Di konsol Google Cloud, buka halaman Datasets.
- Pilih set data yang berisi penyimpanan data yang ingin Anda lihat.
gcloud
Untuk mencantumkan penyimpanan izin dalam set data, jalankan perintah gcloud healthcare consent-stores list
.
Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:
- DATASET_ID: set data induk penyimpanan izin
- LOCATION: lokasi set data
Jalankan perintah berikut:
Linux, macOS, atau Cloud Shell
gcloud healthcare consent-stores list --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores list --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores list --dataset=DATASET_ID ^ --location=LOCATION
ConsentStore
, kolom tersebut juga akan muncul dalam respons.
ID LABELS LOCATION CONSENT_STORE_ID LOCATION
REST
Untuk mencantumkan penyimpanan izin dalam set data, gunakan metode projects.locations.datasets.consentStores.list
.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: ID project Google Cloud Anda
- DATASET_ID: set data induk penyimpanan izin
- LOCATION: lokasi set data
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Jalankan perintah berikut:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores"
PowerShell
Jalankan perintah berikut:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores" | Select-Object -Expand Content
APIs Explorer
Buka halaman referensi metode. Panel API Explorer terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Lengkapi kolom yang wajib diisi, lalu klik Jalankan.
ConsentStore
, kolom tersebut juga akan muncul dalam respons.
Node.js
Python
Menghapus penyimpanan izin
Contoh berikut menunjukkan cara menghapus penyimpanan izin.
Konsol
Untuk menghapus penyimpanan data:
- Di konsol Google Cloud, buka halaman Datasets.
- Pilih set data yang berisi penyimpanan data yang ingin Anda hapus.
- Pilih Hapus dari menu drop-down Tindakan untuk penyimpanan data yang ingin Anda hapus.
- Untuk mengonfirmasi, ketik nama penyimpanan data, lalu klik Hapus.
gcloud
Untuk menghapus penyimpanan izin, jalankan perintah gcloud healthcare consent-stores delete
.
Sebelum menggunakan salah satu data perintah di bawah, lakukan penggantian berikut:
- LOCATION: lokasi set data
- DATASET_ID: set data induk penyimpanan izin
- CONSENT_STORE_ID: ID penyimpanan izin
Jalankan perintah berikut:
Linux, macOS, atau Cloud Shell
gcloud healthcare consent-stores delete CONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores delete CONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores delete CONSENT_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION
Deleted consentStore [CONSENT_STORE_ID].
REST
Untuk menghapus penyimpanan izin, gunakan metode
projects.locations.datasets.consentStores.delete
.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: ID project Google Cloud Anda
- LOCATION: lokasi set data
- DATASET_ID: set data induk penyimpanan izin
- CONSENT_STORE_ID: ID penyimpanan izin
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Jalankan perintah berikut:
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID"
PowerShell
Jalankan perintah berikut:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID" | Select-Object -Expand Content
APIs Explorer
Buka halaman referensi metode. Panel API Explorer terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Lengkapi kolom yang wajib diisi, lalu klik Jalankan.
Anda akan melihat respons JSON seperti berikut:
Node.js
Python
Logging audit
Consent Management API menulis jenis log audit berikut:
- Aktivitas Admin: mencatat operasi yang mengubah konfigurasi atau metadata resource. Anda tidak dapat menonaktifkan log audit Aktivitas Admin.
- Akses Data: berisi panggilan API yang membaca konfigurasi atau metadata resource, serta panggilan API eksternal yang membuat, mengubah, atau membaca data resource yang disediakan pelanggan. Log ini harus diaktifkan. Misalnya, log audit Akses Data dapat digunakan untuk mencatat layanan yang membuat permintaan penetapan akses, informasi yang diberikan dalam permintaan tersebut, dan cara API merespons permintaan tersebut. Untuk informasi selengkapnya tentang log audit Akses Data, lihat Mengonfigurasi log audit Akses Data. Untuk mengetahui informasi selengkapnya tentang logging audit di Cloud Healthcare API, buka Melihat Cloud Audit Logs.
Untuk informasi selengkapnya tentang log audit untuk Consent Management API, lihat Melihat Cloud Audit Logs.