Package google.iam.v1

Indeks

IAMPolicy

Ringkasan API

Mengelola kebijakan Identity and Access Management (IAM).

Setiap penerapan API yang menawarkan fitur kontrol akses menerapkan antarmuka google.iam.v1.IAMPolicy.

Model data

Kontrol akses diterapkan saat principal (pengguna atau akun layanan) melakukan beberapa tindakan pada resource yang diekspos oleh layanan. Resource, yang diidentifikasi oleh nama seperti URI, adalah unit spesifikasi kontrol akses. Implementasi layanan dapat memilih perincian kontrol akses dan izin yang didukung untuk resource mereka. Misalnya, satu layanan database mungkin hanya mengizinkan kontrol akses ditentukan di tingkat Tabel, sedangkan layanan lainnya mungkin mengizinkan kontrol akses ditentukan di tingkat Kolom juga.

Struktur Kebijakan

Lihat google.iam.v1.Policy

API ini sengaja bukan API gaya CRUD karena kebijakan kontrol akses dibuat dan dihapus secara implisit dengan resource yang dilampirkan.

GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

Mendapatkan kebijakan kontrol akses untuk resource. Menampilkan kebijakan kosong jika resource ada dan tidak memiliki kebijakan yang ditetapkan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

Menetapkan kebijakan kontrol akses pada resource yang ditentukan. Menggantikan kebijakan yang ada.

Dapat menampilkan error NOT_FOUND, INVALID_ARGUMENT, dan PERMISSION_DENIED.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

Menampilkan izin yang dimiliki pemanggil pada resource tertentu. Jika resource tidak ada, izin kosong akan ditampilkan, bukan error NOT_FOUND.

Catatan: Operasi ini dirancang untuk digunakan dalam membangun UI dan alat command line yang memiliki izin, bukan untuk pemeriksaan otorisasi. Operasi ini dapat "gagal terbuka" tanpa peringatan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Binding

Mengaitkan members, atau akun utama, dengan role.

Kolom
role

string

Peran yang ditetapkan ke daftar members, atau akun utama. Misalnya, roles/viewer, roles/editor, atau roles/owner.

Untuk mengetahui ringkasan peran dan izin IAM, lihat dokumentasi IAM. Untuk mengetahui daftar peran bawaan yang tersedia, lihat di sini.
members[]

string

Menentukan akun utama yang meminta akses untuk resource Google Cloud. members dapat memiliki nilai berikut:

  • allUsers: ID khusus yang mewakili siapa saja yang ada di internet; dengan atau tanpa Akun Google.

  • allAuthenticatedUsers: ID khusus yang mewakili siapa saja yang diautentikasi dengan Akun Google atau akun layanan. Tidak mencakup identitas yang berasal dari penyedia identitas (IdP) eksternal melalui federasi identitas.

  • user:{emailid}: Alamat email yang mewakili Akun Google tertentu. Misalnya, alice@example.com .

  • serviceAccount:{emailid}: Alamat email yang mewakili akun layanan Google. Contoh, my-other-app@appspot.gserviceaccount.com.

  • serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: ID untuk akun layanan Kubernetes. Misalnya, my-project.svc.id.goog[my-namespace/my-kubernetes-sa].

  • group:{emailid}: Alamat email yang mewakili grup Google. Contoh, admins@example.com.

  • domain:{domain}: Domain G Suite (utama) yang mewakili semua pengguna domain tersebut. Misalnya google.com atau example.com.

  • principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Satu identitas dalam workforce identity pool.

  • principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: Semua workforce identity dalam sebuah grup.

  • principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: Semua identitas tenaga kerja dengan nilai atribut tertentu.

  • principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: Semua identitas dalam workforce identity pool.

  • principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: Satu identitas dalam workload identity pool.

  • principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: Grup workload identity pool.

  • principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: Semua identitas dalam workload identity pool dengan atribut tertentu.

  • principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: Semua identitas dalam workload identity pool.

  • deleted:user:{emailid}?uid={uniqueid}: Alamat email (plus ID unik) yang mewakili pengguna yang baru saja dihapus. Misalnya, alice@example.com?uid=123456789012345678901. Jika pengguna dipulihkan, nilai ini akan kembali ke user:{emailid} dan pengguna yang dipulihkan akan mempertahankan peran dalam binding.

  • deleted:serviceAccount:{emailid}?uid={uniqueid}: Alamat email (plus ID unik) yang mewakili akun layanan yang baru saja dihapus. Contoh, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. Jika akun layanan dibatalkan penghapusannya, nilai ini akan kembali ke serviceAccount:{emailid} dan akun layanan yang dibatalkan penghapusannya akan mempertahankan peran dalam binding.

  • deleted:group:{emailid}?uid={uniqueid}: Alamat email (plus ID unik) yang mewakili grup Google yang baru saja dihapus. Contoh, admins@example.com?uid=123456789012345678901. Jika grup dipulihkan, nilai ini akan kembali ke group:{emailid} dan grup yang dipulihkan akan mempertahankan peran dalam pengikatan.

  • deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Menghapus identitas tunggal dalam workforce identity pool. Contoh, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
condition

Expr

Kondisi yang terkait dengan binding ini.

Jika kondisi bernilai true, maka binding ini berlaku untuk permintaan saat ini.

Jika kondisi bernilai false, maka binding ini tidak berlaku untuk permintaan saat ini. Namun, binding peran yang berbeda dapat memberikan peran yang sama kepada satu atau beberapa akun utama dalam binding ini.

Untuk mempelajari resource mana yang mendukung kondisi dalam kebijakan IAM-nya, lihat dokumentasi IAM.

GetIamPolicyRequest

Pesan permintaan untuk metode GetIamPolicy.

Kolom
resource

string

WAJIB: Resource yang kebijakannya sedang diminta. Lihat Nama resource untuk mengetahui nilai yang sesuai untuk kolom ini.
options

GetPolicyOptions

OPSIONAL: Objek GetPolicyOptions untuk menentukan opsi ke GetIamPolicy.

GetPolicyOptions

Mencakup setelan yang diberikan ke GetIamPolicy.

Kolom
requested_policy_version

int32

Opsional. Versi kebijakan maksimum yang akan digunakan untuk memformat kebijakan.

Nilai yang valid adalah 0, 1, dan 3. Permintaan yang menentukan nilai tidak valid akan ditolak.

Permintaan kebijakan dengan binding peran bersyarat harus menentukan versi 3. Kebijakan tanpa binding peran kondisional dapat menentukan nilai yang valid atau membiarkan kolom tidak ditetapkan.

Kebijakan dalam respons dapat menggunakan versi kebijakan yang Anda tentukan, atau dapat menggunakan versi kebijakan yang lebih rendah. Misalnya, jika Anda menentukan versi 3, tetapi kebijakan tidak memiliki binding peran bersyarat, respons akan menggunakan versi 1.

Untuk mempelajari resource mana yang mendukung kondisi dalam kebijakan IAM-nya, lihat dokumentasi IAM.

Kebijakan

Kebijakan Identity and Access Management (IAM), yang menentukan kontrol akses untuk resource Google Cloud.

Policy adalah kumpulan bindings. binding mengikat satu atau beberapa members, atau akun utama, ke satu role. Akun utama dapat berupa akun pengguna, akun layanan, grup Google, dan domain (seperti G Suite). role adalah daftar izin yang diberi nama; setiap role dapat berupa peran bawaan IAM atau peran khusus yang dibuat pengguna.

Untuk beberapa jenis resource Google Cloud, binding juga dapat menentukan condition, yang merupakan ekspresi logis yang mengizinkan akses ke resource hanya jika ekspresi dievaluasi ke true. Kondisi dapat menambahkan batasan berdasarkan atribut permintaan, resource, atau keduanya. Untuk mempelajari resource mana yang mendukung kondisi dalam kebijakan IAM-nya, lihat dokumentasi IAM.

Contoh JSON:

    {
      "bindings": [
        {
          "role": "roles/resourcemanager.organizationAdmin",
          "members": [
            "user:mike@example.com",
            "group:admins@example.com",
            "domain:google.com",
            "serviceAccount:my-project-id@appspot.gserviceaccount.com"
          ]
        },
        {
          "role": "roles/resourcemanager.organizationViewer",
          "members": [
            "user:eve@example.com"
          ],
          "condition": {
            "title": "expirable access",
            "description": "Does not grant access after Sep 2020",
            "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
          }
        }
      ],
      "etag": "BwWWja0YfJA=",
      "version": 3
    }

Contoh YAML:

    bindings:
    - members:
      - user:mike@example.com
      - group:admins@example.com
      - domain:google.com
      - serviceAccount:my-project-id@appspot.gserviceaccount.com
      role: roles/resourcemanager.organizationAdmin
    - members:
      - user:eve@example.com
      role: roles/resourcemanager.organizationViewer
      condition:
        title: expirable access
        description: Does not grant access after Sep 2020
        expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
    etag: BwWWja0YfJA=
    version: 3

Untuk mengetahui deskripsi IAM dan fitur-fiturnya, lihat dokumentasi IAM.

Kolom
version

int32

Menentukan format kebijakan.

Nilai yang valid adalah 0, 1, dan 3. Permintaan yang menentukan nilai tidak valid akan ditolak.

Setiap operasi yang memengaruhi binding peran bersyarat harus menentukan versi 3. Persyaratan ini berlaku untuk operasi berikut:

  • Mendapatkan kebijakan yang menyertakan binding peran bersyarat
  • Menambahkan binding peran bersyarat ke kebijakan
  • Mengubah binding peran bersyarat dalam kebijakan
  • Menghapus binding peran apa pun, dengan atau tanpa kondisi, dari kebijakan yang menyertakan kondisi

Penting: Jika Anda menggunakan IAM Conditions, Anda harus menyertakan kolom etag setiap kali Anda memanggil setIamPolicy. Jika Anda menghapus kolom ini, IAM akan mengizinkan Anda menimpa kebijakan versi 3 dengan kebijakan versi 1, dan semua kondisi dalam kebijakan versi 3 akan hilang.

Jika kebijakan tidak menyertakan kondisi apa pun, operasi pada kebijakan tersebut dapat menentukan versi yang valid atau membiarkan kolom tidak disetel.

Untuk mempelajari resource mana yang mendukung kondisi dalam kebijakan IAM-nya, lihat dokumentasi IAM.
bindings[]

Binding

Mengaitkan daftar members, atau akun utama, dengan role. Secara opsional, dapat menentukan condition yang menentukan cara dan waktu penerapan bindings. Setiap bindings harus berisi setidaknya satu prinsipal.

bindings dalam Policy dapat merujuk hingga 1.500 akun utama; hingga 250 akun utama ini dapat berupa grup Google. Setiap kemunculan akun utama dihitung dalam batas ini. Misalnya, jika bindings memberikan 50 peran berbeda kepada user:alice@example.com, dan bukan kepada akun utama lain, Anda dapat menambahkan 1.450 akun utama lain ke bindings di Policy.
etag

bytes

etag digunakan untuk kontrol konkurensi optimis sebagai cara untuk membantu mencegah pembaruan kebijakan secara bersamaan agar tidak menimpa satu sama lain. Sangat disarankan agar sistem menggunakan etag dalam siklus baca-ubah-tulis untuk melakukan update kebijakan guna menghindari kondisi persaingan: etag ditampilkan dalam respons terhadap getIamPolicy, dan sistem diharapkan untuk memasukkan etag tersebut dalam permintaan ke setIamPolicy untuk memastikan bahwa perubahan akan diterapkan ke kebijakan versi yang sama.

Penting: Jika Anda menggunakan IAM Conditions, Anda harus menyertakan kolom etag setiap kali Anda memanggil setIamPolicy. Jika Anda menghapus kolom ini, IAM akan mengizinkan Anda menimpa kebijakan versi 3 dengan kebijakan versi 1, dan semua kondisi dalam kebijakan versi 3 akan hilang.

SetIamPolicyRequest

Pesan permintaan untuk metode SetIamPolicy.

Kolom
resource

string

WAJIB: Resource yang kebijakannya sedang ditentukan. Lihat Nama resource untuk mengetahui nilai yang sesuai untuk kolom ini.
policy

Policy

WAJIB: Kebijakan lengkap yang akan diterapkan ke resource. Ukuran kebijakan dibatasi hingga beberapa puluh KB. Kebijakan kosong adalah kebijakan yang valid, tetapi layanan Google Cloud tertentu (seperti Project) mungkin menolaknya.

TestIamPermissionsRequest

Pesan permintaan untuk metode TestIamPermissions.

Kolom
resource

string

WAJIB: Resource yang detail kebijakannya sedang diminta. Lihat Nama resource untuk mengetahui nilai yang sesuai untuk kolom ini.
permissions[]

string

Kumpulan izin yang akan diperiksa untuk resource. Izin dengan karakter pengganti (seperti * atau storage.*) tidak diizinkan. Untuk mengetahui informasi selengkapnya, lihat Ringkasan IAM.

TestIamPermissionsResponse

Pesan respons untuk metode TestIamPermissions.

Kolom
permissions[]

string

Subkumpulan TestPermissionsRequest.permissions yang diizinkan untuk pemanggil.