Package google.cloud.identitytoolkit.v2

Indeks

AccountManagementService

Pengelolaan akun untuk Identity Toolkit

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse)

Menyelesaikan pendaftaran faktor kedua untuk pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
StartMfaEnrollment

rpc StartMfaEnrollment(StartMfaEnrollmentRequest) returns (StartMfaEnrollmentResponse)

Langkah pertama dalam proses pendaftaran MFA. Dalam kasus SMS, tindakan ini akan mengirim kode verifikasi SMS kepada pengguna.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
WithdrawMfa

rpc WithdrawMfa(WithdrawMfaRequest) returns (WithdrawMfaResponse)

Membatalkan satu faktor kedua dari faktor kedua yang terdaftar untuk akun.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

AuthenticationService

Autentikasi untuk Identity Toolkit

FinalizeMfaSignIn

rpc FinalizeMfaSignIn(FinalizeMfaSignInRequest) returns (FinalizeMfaSignInResponse)

Memverifikasi tantangan MFA dan melakukan login

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
GetPasswordPolicy

rpc GetPasswordPolicy(GetPasswordPolicyRequest) returns (PasswordPolicy)

Mendapatkan konfigurasi kebijakan sandi yang ditetapkan di project atau tenant.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
GetRecaptchaConfig

rpc GetRecaptchaConfig(GetRecaptchaConfigRequest) returns (RecaptchaConfig)

Mendapatkan parameter yang diperlukan untuk analisis reCAPTCHA.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
RevokeToken

rpc RevokeToken(RevokeTokenRequest) returns (RevokeTokenResponse)

Membatalkan token pengguna dari Penyedia Identitas (IdP). Hal ini dilakukan dengan memberikan kredensial IdP secara manual, dan jenis token untuk pencabutan.

Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
StartMfaSignIn

rpc StartMfaSignIn(StartMfaSignInRequest) returns (StartMfaSignInResponse)

Mengirim tantangan MFA

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

AutoRetrievalInfo

Informasi yang diperlukan untuk mengambil SMS secara otomatis.

Kolom
app_signature_hash

string

Hash tanda tangan aplikasi Android untuk SMS Retriever API Layanan Google Play.

ClientType

Jenis platform klien: web, android, atau ios.

Enum
CLIENT_TYPE_UNSPECIFIED Jenis klien tidak ditentukan.
CLIENT_TYPE_WEB Jenis klien adalah web.
CLIENT_TYPE_ANDROID Jenis klien adalah android.
CLIENT_TYPE_IOS Jenis klien adalah ios.

FinalizeMfaEnrollmentRequest

Menyelesaikan pendaftaran faktor kedua untuk pengguna.

Kolom
id_token

string

Wajib. Token ID.
display_name

string

Nama tampilan yang dimasukkan oleh pengguna untuk membedakan antara faktor kedua yang berbeda dengan jenis yang sama atau jenis yang berbeda.
tenant_id

string

ID tenant Identity Platform tempat pengguna yang mendaftarkan MFA berada. Jika tidak ditetapkan, pengguna akan menjadi bagian dari project Identity Platform default.
Kolom union verification_info. Informasi pendaftaran MFA yang akan diverifikasi. verification_info hanya ada berupa salah satu diantara berikut:
phone_verification_info

FinalizeMfaPhoneRequestInfo

Info verifikasi untuk mengizinkan pengiriman SMS guna verifikasi telepon.
totp_verification_info

FinalizeMfaTotpEnrollmentRequestInfo

Informasi verifikasi untuk TOTP.

FinalizeMfaEnrollmentResponse

Respons FinalizeMfaEnrollment.

Kolom
id_token

string

Token ID diperbarui untuk mencerminkan pendaftaran MFA.
refresh_token

string

Token refresh diperbarui untuk mencerminkan pendaftaran MFA.
Kolom union auxiliary_auth_info. Informasi pendaftaran yang diverifikasi MFA. auxiliary_auth_info hanya ada berupa salah satu diantara berikut:
phone_auth_info

FinalizeMfaPhoneResponseInfo

Info autentikasi tambahan khusus untuk autentikasi ponsel.
totp_auth_info

FinalizeMfaTotpEnrollmentResponseInfo

Info autentikasi tambahan khusus untuk autentikasi TOTP.

FinalizeMfaPhoneRequestInfo

Info Verifikasi Telepon untuk permintaan FinalizeMfa.

Kolom
session_info

string

String buram yang mewakili sesi pendaftaran.
code

string

Kode verifikasi yang dimasukkan pengguna.
android_verification_proof

string

Khusus Android. Digunakan untuk verifikasi nomor telepon "instan" melalui GmsCore.
phone_number

string

Wajib jika bukti verifikasi Android ditampilkan.

FinalizeMfaPhoneResponseInfo

Info Verifikasi Telepon untuk respons FinalizeMfa.

Kolom
android_verification_proof

string

Khusus Android. Penggantian jangka panjang untuk kode valid yang terikat dengan perangkat Android.
android_verification_proof_expire_time

Timestamp

Khusus Android. Waktu habis masa berlaku bukti verifikasi dalam detik.
phone_number

string

Untuk bukti verifikasi Android.

FinalizeMfaSignInRequest

Menyelesaikan login dengan memverifikasi tantangan MFA.

Kolom
mfa_pending_credential

string

Wajib. Kredensial tertunda dari login faktor pertama.
tenant_id

string

ID tenant Identity Platform tempat pengguna login. Jika tidak ditetapkan, pengguna akan login ke project Identity Platform default.
mfa_enrollment_id

string

ID pendaftaran MFA dari daftar pendaftaran MFA pengguna saat ini.
Kolom union verification_info. Bukti penyelesaian tantangan MFA. verification_info hanya ada berupa salah satu diantara berikut:
phone_verification_info

FinalizeMfaPhoneRequestInfo

Bukti penyelesaian tantangan MFA berbasis SMS.
totp_verification_info

MfaTotpSignInRequestInfo

Bukti penyelesaian tantangan MFA berbasis TOTP.

FinalizeMfaSignInResponse

Respons FinalizeMfaSignIn.

Kolom
id_token

string

Token ID untuk pengguna yang diautentikasi.
refresh_token

string

Token refresh untuk pengguna yang diautentikasi.
Kolom union auxiliary_auth_info. Informasi login yang diverifikasi MFA. auxiliary_auth_info hanya ada berupa salah satu diantara berikut:
phone_auth_info

FinalizeMfaPhoneResponseInfo

Info autentikasi telepon tambahan, termasuk bukti verifikasi Android.

FinalizeMfaTotpEnrollmentRequestInfo

Info permintaan MFA khusus untuk autentikasi TOTP untuk FinalizeMfa.

Kolom
session_info

string

String buram yang mewakili sesi pendaftaran.
verification_code

string

Kode verifikasi yang dimasukkan pengguna.

FinalizeMfaTotpEnrollmentResponseInfo

Jenis ini tidak memiliki kolom.

Info respons MFA khusus untuk autentikasi TOTP untuk FinalizeMfa.

GetPasswordPolicyRequest

Permintaan untuk GetPasswordPolicy.

Kolom
tenant_id

string

ID tenant.

GetRecaptchaConfigRequest

Permintaan untuk GetRecaptchaConfig.

Kolom
tenant_id

string

ID tenant.
client_type

ClientType

reCAPTCHA Enterprise menggunakan kunci situs terpisah untuk berbagai jenis klien. Tentukan jenis klien untuk mendapatkan kunci yang sesuai.
version

RecaptchaVersion

Versi reCAPTCHA.

MfaTotpSignInRequestInfo

Info verifikasi TOTP untuk FinalizeMfaSignInRequest.

Kolom
verification_code

string

Kode verifikasi yang dimasukkan pengguna.

PasswordPolicy

Konfigurasi untuk kebijakan sandi.

Kolom
custom_strength_options

CustomStrengthOptions

Opsi kekuatan kustom yang diterapkan oleh kebijakan sandi.
schema_version

int32

Hanya output. nomor versi skema untuk kebijakan sandi
allowed_non_alphanumeric_characters[]

string

Hanya output. Karakter yang diizinkan yang memenuhi persyaratan non_alphanumeric.
enforcement_state

EnforcementState

Hanya output. Mode penerapan yang akan digunakan untuk kebijakan sandi.
force_upgrade_on_signin

bool

Pengguna harus memiliki sandi yang mematuhi kebijakan sandi untuk login.

CustomStrengthOptions

Opsi kekuatan kustom untuk diterapkan pada sandi pengguna.

Kolom
min_password_length

int32

Panjang sandi minimum. Rentang dari 6 hingga 30
max_password_length

int32

Panjang sandi maksimum. Tidak ada durasi maksimal default
contains_lowercase_character

bool

Sandi harus mengandung karakter huruf kecil.
contains_uppercase_character

bool

Sandi harus mengandung karakter huruf besar.
contains_numeric_character

bool

Sandi harus berisi angka.
contains_non_alphanumeric_character

bool

Sandi harus berisi karakter non-alfanumerik.

EnforcementState

Status penerapan untuk kebijakan sandi

Enum
ENFORCEMENT_STATE_UNSPECIFIED Status penegakan belum ditetapkan.
OFF Kebijakan Sandi tidak akan digunakan pada project.
ENFORCE Sandi yang tidak mematuhi kebijakan sandi akan ditolak dengan error yang ditampilkan.

RecaptchaConfig

Konfigurasi untuk reCAPTCHA

Kolom
recaptcha_enforcement_state[]

RecaptchaEnforcementState

Status penerapan reCAPTCHA untuk penyedia yang didukung perlindungan reCAPTCHA oleh GCIP.
recaptcha_key

string

Nama resource kunci reCAPTCHA Enterprise, misalnya "projects/{project}/keys/{key}". Ini hanya akan ditampilkan jika status penerapan reCAPTCHA adalah AUDIT atau ENFORCE di setidaknya salah satu penyedia reCAPTCHA.
use_sms_bot_score

bool

Apakah akan menggunakan skor bot rCE untuk penyedia telepon reCAPTCHA.
use_sms_toll_fraud_protection

bool

Apakah akan menggunakan skor risiko perlindungan terhadap penipuan pulsa SMS rCE untuk penyedia telepon reCAPTCHA.

RecaptchaEnforcementState

Status penerapan untuk perlindungan reCAPTCHA.

Kolom
provider

RecaptchaProvider

Penyedia yang memiliki perlindungan reCAPTCHA.
enforcement_state

EnforcementState

Status penerapan reCAPTCHA untuk penyedia.

EnforcementState

Status penerapan untuk perlindungan reCAPTCHA per penyedia.

Enum
ENFORCEMENT_STATE_UNSPECIFIED Status penegakan belum ditetapkan.
OFF Tidak diterapkan.
AUDIT Penilaian reCAPTCHA dibuat, hasilnya tidak digunakan untuk diterapkan.
ENFORCE Penilaian reCAPTCHA dibuat, hasilnya digunakan untuk diterapkan.

RecaptchaProvider

Penyedia GCIP yang mendukung perlindungan reCAPTCHA.

Enum
RECAPTCHA_PROVIDER_UNSPECIFIED Penyedia reCAPTCHA tidak ditentukan
EMAIL_PASSWORD_PROVIDER Penyedia sandi email
PHONE_PROVIDER Penyedia auth ponsel

RecaptchaVersion

Versi reCAPTCHA.

Enum
RECAPTCHA_VERSION_UNSPECIFIED Versi reCAPTCHA tidak ditentukan.
RECAPTCHA_ENTERPRISE reCAPTCHA Enterprise.

RevokeTokenRequest

Pesan permintaan untuk RevokeToken.

Kolom
provider_id

string

Wajib. Penyedia idp untuk token. Saat ini hanya mendukung Apple IdP. Formatnya harus "apple.com".
token_type

TokenType

Wajib. Jenis token yang akan dicabut.
token

string

Wajib. Token yang akan dicabut. Jika authorization_code diteruskan, API akan menukarkan kode dengan token akses terlebih dahulu, lalu mencabut token yang ditukar.
id_token

string

Wajib. Token ID Identity Platform yang valid untuk menautkan akun. Jika ada permintaan pencabutan token yang berhasil di akun dan tidak ada token yang dibuat setelah pencabutan, permintaan duplikat akan diabaikan dan segera ditampilkan.
tenant_id

string

ID tenant Identity Platform tempat pengguna login. Jika tidak ditetapkan, pengguna akan login ke project Identity Platform default.
redirect_uri

string

URI pengalihan yang diberikan dalam permintaan otorisasi awal yang dibuat oleh klien ke IdP. URI harus menggunakan protokol HTTPS, menyertakan nama domain, dan tidak boleh berisi alamat IP atau localhost. Wajib jika token_type adalah CODE.

TokenType

Jenis token yang akan dicabut.

Enum
TOKEN_TYPE_UNSPECIFIED Nilai default, jangan gunakan.
REFRESH_TOKEN Jenis token adalah refresh_token.
ACCESS_TOKEN Jenis token adalah access_token.
CODE Jenis token adalah authorization_code.

RevokeTokenResponse

Jenis ini tidak memiliki kolom.

Pesan respons untuk RevokeToken. Kosong untuk saat ini.

StartMfaEnrollmentRequest

Mengirim SMS verifikasi pendaftaran MFA untuk pengguna.

Kolom
id_token

string

Wajib. Token ID pengguna.
tenant_id

string

ID tenant Identity Platform tempat pengguna yang mendaftarkan MFA berada. Jika tidak ditetapkan, pengguna akan menjadi bagian dari project Identity Platform default.
Kolom union enrollment_info. Informasi MFA menurut jenis faktor ke-2. enrollment_info hanya ada berupa salah satu diantara berikut:
phone_enrollment_info

StartMfaPhoneRequestInfo

Info verifikasi untuk mengizinkan pengiriman SMS guna verifikasi telepon.
totp_enrollment_info

StartMfaTotpEnrollmentRequestInfo

Info login khusus untuk autentikasi TOTP.

StartMfaEnrollmentResponse

Respons StartMfaEnrollment.

Kolom
Kolom union enrollment_response. Respons pendaftaran awal MFA menurut jenis faktor ke-2. enrollment_response hanya ada berupa salah satu diantara berikut:
phone_session_info

StartMfaPhoneResponseInfo

Info verifikasi untuk mengizinkan pengiriman SMS guna verifikasi telepon.
totp_session_info

StartMfaTotpEnrollmentResponseInfo

Info respons pendaftaran khusus untuk autentikasi TOTP.

StartMfaPhoneRequestInfo

Info Verifikasi Aplikasi untuk permintaan StartMfa.

Kolom
phone_number

string

Wajib diisi untuk pendaftaran. Nomor telepon yang akan didaftarkan sebagai MFA.
ios_receipt

string

Khusus iOS. Tanda terima validasi token aplikasi yang berhasil dengan APNS.
ios_secret

string

Khusus iOS. Secret dikirim ke aplikasi iOS melalui APNS.
recaptcha_token

string

Khusus web. Solusi recaptcha.
auto_retrieval_info

AutoRetrievalInfo

Khusus Android. Digunakan oleh Layanan Google Play untuk mengidentifikasi aplikasi untuk pengambilan otomatis.
safety_net_token

string

Khusus Android. Digunakan untuk menyatakan identitas aplikasi sebagai pengganti token recaptcha. Token SafetyNet dapat dibuat melalui SafetyNet Android Attestation API, dengan encoding Base64 kolom phone_number sebagai nonce.
play_integrity_token

string

Khusus Android. Digunakan untuk menyatakan identitas aplikasi sebagai pengganti token recaptcha (atau token safety net). Token Play Integrity dapat dibuat melalui PlayIntegrity API dengan menerapkan SHA256 ke kolom phone_number sebagai nonce.
captcha_response

string

Token reCAPTCHA Enterprise yang disediakan oleh integrasi sisi klien reCAPTCHA. Wajib diisi jika reCAPTCHA Enterprise diaktifkan.
client_type

ClientType

Jenis klien, web, android, atau ios. Wajib diisi jika reCAPTCHA Enterprise diaktifkan.
recaptcha_version

RecaptchaVersion

Versi reCAPTCHA dari token reCAPTCHA di captcha_response. Wajib diisi jika reCAPTCHA Enterprise diaktifkan.

StartMfaPhoneResponseInfo

Info Verifikasi Telepon untuk respons StartMfa.

Kolom
session_info

string

String buram yang mewakili sesi pendaftaran.

StartMfaSignInRequest

Memulai login multi-faktor dengan mengirimkan tantangan autentikasi multi-faktor.

Kolom
mfa_pending_credential

string

Wajib. Kredensial tertunda dari login faktor pertama.
mfa_enrollment_id

string

Wajib. ID pendaftaran MFA dari daftar pendaftaran MFA pengguna saat ini.
tenant_id

string

ID tenant Identity Platform tempat pengguna login. Jika tidak ditetapkan, pengguna akan login ke project Identity Platform default.
Kolom union sign_in_info. Informasi MFA menurut jenis faktor ke-2. sign_in_info hanya ada berupa salah satu diantara berikut:
phone_sign_in_info

StartMfaPhoneRequestInfo

Info verifikasi untuk mengizinkan pengiriman SMS guna verifikasi telepon.

StartMfaSignInResponse

Respons StartMfaSignIn.

Kolom
Kolom union response_info. MultiFactor memulai respons login menurut jenis faktor ke-2. response_info hanya ada berupa salah satu diantara berikut:
phone_response_info

StartMfaPhoneResponseInfo

Informasi sesi login Multi-Faktor khusus untuk faktor kedua jenis SMS. Bersama dengan kode sekali pakai yang diambil dari SMS yang dikirim, konten informasi sesi ini harus diteruskan ke FinalizeMfaSignIn untuk menyelesaikan login.

StartMfaTotpEnrollmentRequestInfo

Jenis ini tidak memiliki kolom.

Info permintaan MFA khusus untuk autentikasi TOTP untuk StartMfa.

StartMfaTotpEnrollmentResponseInfo

Info respons MFA khusus untuk autentikasi TOTP untuk StartMfa.

Kolom
shared_secret_key

string

String berenkode base 32 yang mewakili secret TOTP bersama.

Encoding base 32 adalah encoding yang ditentukan oleh RFC4648#section-6. (Ini sama dengan encoding base 32 dari RFC3548#section-5.)
verification_code_length

int32

Panjang kode verifikasi yang perlu dibuat.
hashing_algorithm

string

Algoritma hashing yang digunakan untuk membuat kode verifikasi.
period_sec

int32

Durasi dalam detik saat kode verifikasi akan berubah.
session_info

string

String yang dienkode yang mewakili sesi pendaftaran.
finalize_enrollment_time

Timestamp

Waktu pendaftaran harus selesai.

WithdrawMfaRequest

Membatalkan MFA.

Kolom
id_token

string

Wajib. Token ID pengguna.
mfa_enrollment_id

string

Wajib. ID pendaftaran MFA dari pendaftaran MFA saat ini.
tenant_id

string

ID tenant Identity Platform tempat pengguna membatalkan pendaftaran MFA. Jika tidak ditetapkan, pengguna akan menjadi bagian dari project Identity Platform default.

WithdrawMfaResponse

Menarik respons MultiFactorAuth.

Kolom
id_token

string

Token ID diperbarui untuk mencerminkan penghapusan faktor kedua.
refresh_token

string

Token refresh diperbarui untuk mencerminkan penghapusan faktor kedua.