identitytoolkit/v2 library
Identity Toolkit API - v2
The Google Identity Toolkit API lets you use open standards to verify a user's identity.
For more information, see cloud.google.com/identity-platform
Create an instance of IdentityToolkitApi to access these resources:
Classes
- AccountsMfaEnrollmentResource
- AccountsMfaSignInResource
- AccountsResource
- DefaultSupportedIdpsResource
- GoogleCloudIdentitytoolkitAdminV2AllowByDefault
- Defines a policy of allowing every region by default and adding disallowed regions to a disallow list.
- GoogleCloudIdentitytoolkitAdminV2AllowlistOnly
- Defines a policy of only allowing regions by explicitly adding them to an allowlist.
- GoogleCloudIdentitytoolkitAdminV2Anonymous
- Configuration options related to authenticating an anonymous user.
- GoogleCloudIdentitytoolkitAdminV2AppleSignInConfig
- Additional config for SignInWithApple.
- GoogleCloudIdentitytoolkitAdminV2BlockingFunctionsConfig
- Configuration related to Blocking Functions.
- GoogleCloudIdentitytoolkitAdminV2ClientConfig
- Options related to how clients making requests on behalf of a project should be configured.
- GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig
- Options related to how clients making requests on behalf of a tenant should be configured.
- GoogleCloudIdentitytoolkitAdminV2CodeFlowConfig
- Additional config for Apple for code flow.
- GoogleCloudIdentitytoolkitAdminV2Config
- Represents an Identity Toolkit project.
- GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdp
- Standard Identity Toolkit-trusted IDPs.
- GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig
- Configurations options for authenticating with a the standard set of Identity Toolkit-trusted IDPs.
- GoogleCloudIdentitytoolkitAdminV2DnsInfo
- Information of custom domain DNS verification.
- GoogleCloudIdentitytoolkitAdminV2Email
- Configuration options related to authenticating a user by their email address.
- GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig
- Configuration for settings related to email privacy and public visibility.
- GoogleCloudIdentitytoolkitAdminV2EmailTemplate
- Email template.
- GoogleCloudIdentitytoolkitAdminV2ForwardInboundCredentials
- Indicates which credentials to pass to the registered Blocking Functions.
- GoogleCloudIdentitytoolkitAdminV2HashConfig
- History information of the hash algorithm and key.
- GoogleCloudIdentitytoolkitAdminV2IdpCertificate
- The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP.
- GoogleCloudIdentitytoolkitAdminV2IdpConfig
- The SAML IdP (Identity Provider) configuration when the project acts as the relying party.
- GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig
- A pair of SAML RP-IDP configurations when the project acts as the relying party.
- GoogleCloudIdentitytoolkitAdminV2Inheritance
- Settings that the tenants will inherit from project level.
- GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpConfigsResponse
- Response for DefaultSupportedIdpConfigs
- GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpsResponse
- Response for ListDefaultSupportedIdps
- GoogleCloudIdentitytoolkitAdminV2ListInboundSamlConfigsResponse
- Response for ListInboundSamlConfigs
- GoogleCloudIdentitytoolkitAdminV2ListOAuthIdpConfigsResponse
- Response for ListOAuthIdpConfigs
- GoogleCloudIdentitytoolkitAdminV2ListTenantsResponse
- Response message for ListTenants.
- GoogleCloudIdentitytoolkitAdminV2MonitoringConfig
- Configuration related to monitoring project activity.
- GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig
- Options related to MultiFactor Authentication for the project.
- GoogleCloudIdentitytoolkitAdminV2MultiTenantConfig
- Configuration related to multi-tenant functionality.
- GoogleCloudIdentitytoolkitAdminV2NotificationConfig
- Configuration related to sending notifications to users.
- GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig
- Configuration options for authenticating with an OAuth IDP.
- GoogleCloudIdentitytoolkitAdminV2OAuthResponseType
- The response type to request for in the OAuth authorization flow.
- GoogleCloudIdentitytoolkitAdminV2PasswordPolicyConfig
- The configuration for the password policy on the project.
- GoogleCloudIdentitytoolkitAdminV2PasswordPolicyVersion
- The strength attributes for the password policy on the project.
- GoogleCloudIdentitytoolkitAdminV2PhoneNumber
- Configuration options related to authenticated a user by their phone number.
- GoogleCloudIdentitytoolkitAdminV2ProviderConfig
- ProviderConfig describes the supported MFA providers along with their configurations.
- GoogleCloudIdentitytoolkitAdminV2QuotaConfig
- Configuration related to quotas.
- GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig
- The reCAPTCHA Enterprise integration config.
- GoogleCloudIdentitytoolkitAdminV2RecaptchaKey
- The reCAPTCHA key config.
- GoogleCloudIdentitytoolkitAdminV2RecaptchaManagedRule
- The config for a reCAPTCHA managed rule.
- GoogleCloudIdentitytoolkitAdminV2RequestLogging
- Configuration for logging requests made to this project to Stackdriver Logging
- GoogleCloudIdentitytoolkitAdminV2SendEmail
- Options for email sending.
- GoogleCloudIdentitytoolkitAdminV2SendSms
- Options for SMS sending.
- GoogleCloudIdentitytoolkitAdminV2SignInConfig
- Configuration related to local sign in methods.
- GoogleCloudIdentitytoolkitAdminV2SmsRegionConfig
- Configures the regions where users are allowed to send verification SMS for the project or tenant.
- GoogleCloudIdentitytoolkitAdminV2SmsTemplate
- The template to use when sending an SMS.
- GoogleCloudIdentitytoolkitAdminV2Smtp
- Configuration for SMTP relay
- GoogleCloudIdentitytoolkitAdminV2SpCertificate
- The SP's certificate data for IDP to verify the SAMLRequest generated by the SP.
- GoogleCloudIdentitytoolkitAdminV2SpConfig
- The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider.
- GoogleCloudIdentitytoolkitAdminV2TemporaryQuota
- Temporary quota increase / decrease
- GoogleCloudIdentitytoolkitAdminV2Tenant
- A Tenant contains configuration for the tenant in a multi-tenant project.
- GoogleCloudIdentitytoolkitAdminV2TotpMfaProviderConfig
- TotpMFAProviderConfig represents the TOTP based MFA provider.
- GoogleCloudIdentitytoolkitAdminV2Trigger
- Synchronous Cloud Function with HTTP Trigger
- GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentRequest
- Finishes enrolling a second factor for the user.
- GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentResponse
- FinalizeMfaEnrollment response.
- GoogleCloudIdentitytoolkitV2FinalizeMfaPhoneRequestInfo
- Phone Verification info for a FinalizeMfa request.
- GoogleCloudIdentitytoolkitV2FinalizeMfaPhoneResponseInfo
- Phone Verification info for a FinalizeMfa response.
- GoogleCloudIdentitytoolkitV2FinalizeMfaSignInRequest
- Finalizes sign-in by verifying MFA challenge.
- GoogleCloudIdentitytoolkitV2FinalizeMfaSignInResponse
- FinalizeMfaSignIn response.
- GoogleCloudIdentitytoolkitV2FinalizeMfaTotpEnrollmentRequestInfo
- Mfa request info specific to TOTP auth for FinalizeMfa.
- GoogleCloudIdentitytoolkitV2MfaTotpSignInRequestInfo
- TOTP verification info for FinalizeMfaSignInRequest.
- GoogleCloudIdentitytoolkitV2PasswordPolicy
- Configuration for password policy.
- GoogleCloudIdentitytoolkitV2RecaptchaConfig
- Configuration for reCAPTCHA
- GoogleCloudIdentitytoolkitV2RecaptchaEnforcementState
- Enforcement states for reCAPTCHA protection.
- GoogleCloudIdentitytoolkitV2RevokeTokenRequest
- Request message for RevokeToken.
- GoogleCloudIdentitytoolkitV2StartMfaEnrollmentRequest
- Sends MFA enrollment verification SMS for a user.
- GoogleCloudIdentitytoolkitV2StartMfaEnrollmentResponse
- StartMfaEnrollment response.
- GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo
- App Verification info for a StartMfa request.
- GoogleCloudIdentitytoolkitV2StartMfaPhoneResponseInfo
- Phone Verification info for a StartMfa response.
- GoogleCloudIdentitytoolkitV2StartMfaSignInRequest
- Starts multi-factor sign-in by sending the multi-factor auth challenge.
- GoogleCloudIdentitytoolkitV2StartMfaSignInResponse
- StartMfaSignIn response.
- GoogleCloudIdentitytoolkitV2StartMfaTotpEnrollmentResponseInfo
- Mfa response info specific to TOTP auth for StartMfa.
- GoogleCloudIdentitytoolkitV2WithdrawMfaRequest
- Withdraws MFA.
- GoogleCloudIdentitytoolkitV2WithdrawMfaResponse
- Withdraws MultiFactorAuth response.
- GoogleIamV1AuditConfig
- Specifies the audit configuration for a service.
- GoogleIamV1Binding
-
Associates
members
, or principals, with arole
. - GoogleIamV1GetIamPolicyRequest
-
Request message for
GetIamPolicy
method. - GoogleIamV1Policy
- An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
- GoogleIamV1SetIamPolicyRequest
-
Request message for
SetIamPolicy
method. - IdentityToolkitApi
- The Google Identity Toolkit API lets you use open standards to verify a user's identity.
- ProjectsDefaultSupportedIdpConfigsResource
- ProjectsIdentityPlatformResource
- ProjectsInboundSamlConfigsResource
- ProjectsOauthIdpConfigsResource
- ProjectsResource
- ProjectsTenantsDefaultSupportedIdpConfigsResource
- ProjectsTenantsInboundSamlConfigsResource
- ProjectsTenantsOauthIdpConfigsResource
- ProjectsTenantsResource
- V2Resource
Typedefs
- GoogleCloudIdentitytoolkitAdminV2ClientPermissions = $Permissions
- Configuration related to restricting a user's ability to affect their account.
- GoogleCloudIdentitytoolkitAdminV2CustomStrengthOptions = $V2CustomStrengthOptions
- Custom strength options to enforce on user passwords.
- GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformRequest = $Empty
- Request for InitializeIdentityPlatform.
- GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformResponse = $Empty
- Response for InitializeIdentityPlatform.
- GoogleCloudIdentitytoolkitAdminV2Permissions = $Permissions
- Configuration related to restricting a user's ability to affect their account.
- GoogleCloudIdentitytoolkitV2AutoRetrievalInfo = $AutoRetrievalInfo
- The information required to auto-retrieve an SMS.
- GoogleCloudIdentitytoolkitV2CustomStrengthOptions = $V2CustomStrengthOptions
- Custom strength options to enforce on user passwords.
- GoogleCloudIdentitytoolkitV2FinalizeMfaTotpEnrollmentResponseInfo = $Empty
- Mfa response info specific to TOTP auth for FinalizeMfa.
- GoogleCloudIdentitytoolkitV2RevokeTokenResponse = $Empty
- Response message for RevokeToken.
- GoogleCloudIdentitytoolkitV2StartMfaTotpEnrollmentRequestInfo = $Empty
- Mfa request info specific to TOTP auth for StartMfa.
- GoogleIamV1AuditLogConfig = $AuditLogConfig
- Provides the configuration for logging a type of permissions.
- GoogleIamV1GetPolicyOptions = $GetPolicyOptions00
- Encapsulates settings provided to GetIamPolicy.
- GoogleIamV1TestIamPermissionsRequest = $TestIamPermissionsRequest00
-
Request message for
TestIamPermissions
method. - GoogleIamV1TestIamPermissionsResponse = $PermissionsResponse
-
Response message for
TestIamPermissions
method. - GoogleProtobufEmpty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- GoogleTypeExpr = $Expr
- Represents a textual expression in the Common Expression Language (CEL) syntax.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.