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.
| Property | Type | Description |
|---|---|---|
| apiVersion | string | API schema version. Must be lowops.manifests.v1. |
| kind | string | Resource kind. Must be IdentityProvider. |
| metadata | map | The 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. |
| spec | Spec | Desired 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.
| Property | Type | Description |
|---|---|---|
| description | string | Optional free text. AI assistants use it as context. The engine does not copy it to the GCIP tenant. |
| disabled | bool | If true, the engine creates the GCIP tenant with authentication disabled (DisableAuth). This blocks all sign-in but keeps the tenant configuration. |
| permissions | Permissions | Signup and email-domain rules. See Permissions. |
| displayName | string | Name shown on the sign-in page. Required. |
| mode | string | How federated sign-in opens. POPUP opens a popup window. REDIRECT goes to the provider page. Default: REDIRECT. |
| providers | Providers | Sign-in methods to enable. See Providers. |
| termsOfService | string | URL 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. |
| privacyPolicy | string | URL 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. |
| logoUrl | string | URL of the logo on the sign-in page. A relative path resolves against the login domain. Required. |
| iconUrl | string | URL of the icon on the sign-in page. A relative path resolves against the login domain. Required. |
| buttonColor | string | Hex color code (#RRGGBB) of the sign-in button. Validation checks the format. Default: #007bff. |
| styleUrl | string | URL 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. |
| heroImageUrl | string | URL of the background image of the hero panel. Must be a valid URI. A relative path resolves against the login domain. |
| heroBackground | string | CSS background value of the hero panel. Validation rejects script-injection patterns. |
| immediateFederatedRedirect | bool | If true and you configure exactly one federated provider, the login page goes straight to it and skips the provider picker. |
| redirectOnLogin | string | URL where the user goes after sign-in. Overrides the ingress-level default. |
| redirectOnLogout | string | URL where the user goes after sign-out. Overrides the ingress-level default. |
| passwordPolicy | PasswordPolicy | Password policy for this tenant. Only effective in multi-tenant mode. See PasswordPolicy. |
| smsRegionPolicy | SmsRegionPolicy | SMS region policy for phone sign-in. Required if providers.phone is true. Validation fails without it. See SmsRegionPolicy. |
| testPhoneNumbers | list of TestPhoneNumbersEntry | Map of an E.164 phone number to a fixed verification code. These numbers skip real SMS delivery, for tests. Maximum: 10 entries. |
| termsOfServiceVersion | string | Current 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. |
| status | OperationalStatus | Maintenance and suspension state of this tenant. See OperationalStatus. |
| customClaims | CustomClaims | Custom 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.
| Property | Type | Description |
|---|---|---|
| onCreate | list of OnCreateEntry | Claims set once at account creation, by the beforeCreate trigger. |
| onSignIn | list of OnSignInEntry | Claims set at every sign-in, by the beforeSignIn trigger. Use them sparingly, because this runs on each login attempt. |
OnCreateEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |
OnSignInEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |
OperationalStatus
Tenant operational-status controls.
The beforeSignIn trigger checks these switches at every sign-in, not only at new registrations.
| Property | Type | Description |
|---|---|---|
| maintenance | Maintenance | Maintenance mode. See Maintenance. |
| suspension | Suspension | Tenant suspension. See Suspension. |
Maintenance
Maintenance-mode configuration.
If enabled, the tenant blocks all sign-ins with an informational message (severity info).
| Property | Type | Description |
|---|---|---|
| enabled | bool | If true, the tenant blocks all sign-ins and shows a maintenance notice. |
| message | string | Text 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.
| Property | Type | Description |
|---|---|---|
| enabled | bool | If true, the tenant blocks all sign-ins with a suspension error. |
| message | string | Reason 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.
| Property | Type | Description |
|---|---|---|
| minLength | int32 | Minimum password length, from 6 to 30. Default: 6. |
| maxLength | int32 | Maximum password length, from 6 to 4096. Default: 4096. |
| requireUppercase | bool | If true, a password needs an uppercase letter. |
| requireLowercase | bool | If true, a password needs a lowercase letter. |
| requireNumeric | bool | If true, a password needs a digit. |
| requireNonAlphanumeric | bool | If 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.
| Property | Type | Description |
|---|---|---|
| disableUserSignup | bool | If true, end users cannot register a new account. The beforeCreate trigger enforces this for the tenant. |
| allowedEmailDomains | list of string | Only emails with a domain in this list can register. If the list is empty, no allowlist applies. |
| blockedEmailDomains | list of string | Emails 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.
| Property | Type | Description |
|---|---|---|
| anonymous | bool | If true, allows anonymous (guest) sign-in. No external provider or secret is necessary. |
| password | bool | If true, allows email/password and email-link sign-up and sign-in. |
| phone | bool | If true, allows SMS sign-in. This requires sms_region_policy, which prevents toll fraud. Validation fails without it. |
| bool | If true, enables Google sign-in (google.com). | |
| apple | bool | If true, enables Apple sign-in (apple.com). |
| bool | If true, enables Facebook sign-in (facebook.com). | |
| github | bool | If true, enables GitHub sign-in (github.com). The engine-generated login UI does not show it yet. |
| bool | If true, enables LinkedIn sign-in (linkedin.com). | |
| microsoft | bool | If true, enables Microsoft sign-in (microsoft.com). |
| googlePlay | bool | If true, enables Google Play Games sign-in (playgames.google.com). The engine-generated login UI does not show it yet. |
| bool | If true, enables Twitter/X sign-in (twitter.com). The engine-generated login UI does not show it yet. | |
| yahoo | bool | If true, enables Yahoo sign-in (yahoo.com). The engine-generated login UI does not show it yet. |
| oauth2 | list of string | NOT 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.
| Property | Type | Description |
|---|---|---|
| allowedRegions | list of string | ISO 3166-1 alpha-2 codes of the regions that can receive SMS verification codes. |
TestPhoneNumbersEntry
| Property | Type | Description |
|---|---|---|
| key | string | |
| value | string |