Skip to main content

Identity Provider

IdentityProvider​

Defines an identity provider for customers.

It sets the sign-in methods, the authentication flows and the look of the sign-in page for end-user applications.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be IdentityProvider.
metadatamapThe engine reads the reserved keys name, project, environment, organizational-unit and organization. They resolve the identity of this manifest, its parent PublicIngress and the target GCP Project.
specSpecDesired configuration. See Spec.

Spec​

User-authored identity provider configuration.

It sets the login methods, signup rules, password and SMS policies, status controls, custom claims and the sign-in page style.

PropertyTypeDescription
descriptionstringOptional free text. AI assistants use it as context. The engine does not copy it to the GCIP tenant.
disabledboolIf true, the engine creates the GCIP tenant with authentication disabled (DisableAuth). This blocks all sign-in but keeps the tenant configuration.
permissionsPermissionsSignup and email-domain rules. See Permissions.
displayNamestringName shown on the sign-in page. Required.
modestringHow federated sign-in opens. POPUP opens a popup window. REDIRECT goes to the provider page. Default: REDIRECT.
providersProvidersSign-in methods to enable. See Providers.
termsOfServicestringURL of the terms of service, shown on the sign-in page. An absolute URL must use https. A relative URL resolves against the login domain. Required if the project has GDPR compliance enabled.
privacyPolicystringURL of the privacy policy, shown on the sign-in page. It follows the URL rules of terms_of_service. Required if the project has GDPR compliance enabled.
logoUrlstringURL of the logo on the sign-in page. A relative path resolves against the login domain. Required.
iconUrlstringURL of the icon on the sign-in page. A relative path resolves against the login domain. Required.
buttonColorstringHex color code (#RRGGBB) of the sign-in button. Validation checks the format. Default: #007bff.
styleUrlstringURL of a CSS stylesheet that overrides the ingress-level style for this tenant. Must be a valid URI (https if absolute). A relative path resolves against the login domain.
heroImageUrlstringURL of the background image of the hero panel. Must be a valid URI. A relative path resolves against the login domain.
heroBackgroundstringCSS background value of the hero panel. Validation rejects script-injection patterns.
immediateFederatedRedirectboolIf true and you configure exactly one federated provider, the login page goes straight to it and skips the provider picker.
redirectOnLoginstringURL where the user goes after sign-in. Overrides the ingress-level default.
redirectOnLogoutstringURL where the user goes after sign-out. Overrides the ingress-level default.
passwordPolicyPasswordPolicyPassword policy for this tenant. Only effective in multi-tenant mode. See PasswordPolicy.
smsRegionPolicySmsRegionPolicySMS region policy for phone sign-in. Required if providers.phone is true. Validation fails without it. See SmsRegionPolicy.
testPhoneNumberslist of TestPhoneNumbersEntryMap of an E.164 phone number to a fixed verification code. These numbers skip real SMS delivery, for tests. Maximum: 10 entries.
termsOfServiceVersionstringCurrent terms-of-service version, for example v2026-05. If set, sign-in fails with TOS_ACCEPTANCE_REQUIRED until the user accepts this version. A custom claim tracks the acceptance. The first signup records the current version.
statusOperationalStatusMaintenance and suspension state of this tenant. See OperationalStatus.
customClaimsCustomClaimsCustom claims for this tenant. See CustomClaims.

CustomClaims​

Custom claims added during authentication.

The blocking function adds these key/value claims to the Firebase Auth ID token (JWT) of the user.

PropertyTypeDescription
onCreatelist of OnCreateEntryClaims set once at account creation, by the beforeCreate trigger.
onSignInlist of OnSignInEntryClaims set at every sign-in, by the beforeSignIn trigger. Use them sparingly, because this runs on each login attempt.

OnCreateEntry​

PropertyTypeDescription
keystring
valuestring

OnSignInEntry​

PropertyTypeDescription
keystring
valuestring

OperationalStatus​

Tenant operational-status controls.

The beforeSignIn trigger checks these switches at every sign-in, not only at new registrations.

PropertyTypeDescription
maintenanceMaintenanceMaintenance mode. See Maintenance.
suspensionSuspensionTenant suspension. See Suspension.

Maintenance​

Maintenance-mode configuration.

If enabled, the tenant blocks all sign-ins with an informational message (severity info).

PropertyTypeDescription
enabledboolIf true, the tenant blocks all sign-ins and shows a maintenance notice.
messagestringText that the login app shows as it is. The engine does not translate it.

Suspension​

Tenant-suspension configuration.

If enabled, the tenant blocks all sign-ins with an error message (severity error). Unlike spec.disabled, this works at application level and allows a custom message.

PropertyTypeDescription
enabledboolIf true, the tenant blocks all sign-ins with a suspension error.
messagestringReason shown to users when sign-in fails. The engine does not translate it.

PasswordPolicy​

Tenant password policy.

The GCIP tenant enforces these rules. They are only effective in multi-tenant mode.

PropertyTypeDescription
minLengthint32Minimum password length, from 6 to 30. Default: 6.
maxLengthint32Maximum password length, from 6 to 4096. Default: 4096.
requireUppercaseboolIf true, a password needs an uppercase letter.
requireLowercaseboolIf true, a password needs a lowercase letter.
requireNumericboolIf true, a password needs a digit.
requireNonAlphanumericboolIf true, a password needs a symbol.

Permissions​

End-user signup and email-domain controls.

The beforeCreate trigger of the tenant blocking function enforces these rules.

PropertyTypeDescription
disableUserSignupboolIf true, end users cannot register a new account. The beforeCreate trigger enforces this for the tenant.
allowedEmailDomainslist of stringOnly emails with a domain in this list can register. If the list is empty, no allowlist applies.
blockedEmailDomainslist of stringEmails with a domain in this list cannot register. This check runs after allowed_email_domains, so you can set both.

Providers​

Enabled sign-in methods.

Each enabled federated provider creates a GCIP tenant provider. Its client ID and secret must exist in the centralized secret manager.

PropertyTypeDescription
anonymousboolIf true, allows anonymous (guest) sign-in. No external provider or secret is necessary.
passwordboolIf true, allows email/password and email-link sign-up and sign-in.
phoneboolIf true, allows SMS sign-in. This requires sms_region_policy, which prevents toll fraud. Validation fails without it.
googleboolIf true, enables Google sign-in (google.com).
appleboolIf true, enables Apple sign-in (apple.com).
facebookboolIf true, enables Facebook sign-in (facebook.com).
githubboolIf true, enables GitHub sign-in (github.com). The engine-generated login UI does not show it yet.
linkedInboolIf true, enables LinkedIn sign-in (linkedin.com).
microsoftboolIf true, enables Microsoft sign-in (microsoft.com).
googlePlayboolIf true, enables Google Play Games sign-in (playgames.google.com). The engine-generated login UI does not show it yet.
twitterboolIf true, enables Twitter/X sign-in (twitter.com). The engine-generated login UI does not show it yet.
yahooboolIf true, enables Yahoo sign-in (yahoo.com). The engine-generated login UI does not show it yet.
oauth2list of stringNOT YET IMPLEMENTED. The engine ignores this field. It will register each listed ID as a generic OAuth 2.0 provider.

SmsRegionPolicy​

SMS region restriction policy.

It limits the regions that can receive SMS verification codes. This prevents toll fraud.

PropertyTypeDescription
allowedRegionslist of stringISO 3166-1 alpha-2 codes of the regions that can receive SMS verification codes.

TestPhoneNumbersEntry​

PropertyTypeDescription
keystring
valuestring