Skip to main content

Identity Provider

IdentityProvider

Defines the high-level intent for a customer-facing identity provider.

Translates into identity platform configurations, supporting social sign-in (Google, GitHub, etc.), email/password, and other standard identity protocols, driving authentication flows and branding for end-user applications.

PropertyTypeDescription
apiVersionstring
kindstring
metadatamap
specSpec

Spec

Contains the user-defined configuration for the identity provider. Encapsulates configuration for supported login methods, user flow permissions (signup/deletion), and visual branding elements.

PropertyTypeDescription
descriptionstringThis description is optional but will drastically improve the understand of the AI assistant about the structural elements of the organization
disabledboolIf true, this identity provider configuration will be disabled.
permissionsPermissions
displayNamestringThe display name for the identity provider, which will be shown to end-users on the login page.
modestringDefines the way social sign-in is handled. Possible values are 'POPUP' and 'REDIRECT'.
providersProvidersA block to enable or disable specific third-party identity providers. For each provider set to true, the identity provider configuration is updated, and the platform expects corresponding client StateID and secret to be present in the centralized secret manager.
termsOfServicestringA URL to the terms of service document for the application. If absolute, it must use the https scheme. If relative, it must be relative to the domain where the application is hosted.
privacyPolicystringA URL to the privacy policy document for the application. If absolute, it must use the https scheme. If relative, it must be relative to the domain where the application is hosted.
logoUrlstringA URL to the logo that will be displayed on the sign-in page.
iconUrlstringA URL to the icon that will be displayed on the sign-in page.
buttonColorstringThe color of the button used on the sign-in page for this provider. This MUST be a hex color code.
styleUrlstringURL to a custom CSS stylesheet for this tenant. Overrides the ingress-level styleUrl. Must be HTTPS if absolute.
heroImageUrlstringURL to a hero/background image displayed in the login page's hero panel.
heroBackgroundstringCSS background value for the hero panel (e.g., "linear-gradient(135deg, #667eea, #764ba2)").
immediateFederatedRedirectboolWhen true and exactly one federated provider is configured, skip the sign-in UI and redirect immediately to the provider.
redirectOnLoginstringRedirect URL after successful sign-in. Overrides the ingress-level default.
redirectOnLogoutstringRedirect URL after sign-out. Overrides the ingress-level default.
passwordPolicyPasswordPolicyPassword policy for this tenant. Applied at the GCIP tenant level in multi-tenant setups.
smsRegionPolicySmsRegionPolicyControls which geographic regions can receive SMS for phone authentication. Required when phone auth is enabled to prevent toll fraud.
testPhoneNumberslist of TestPhoneNumbersEntryTesting phone numbers for this tenant. Maps phone number (E.164 format) to a fixed verification code. Maximum 10 entries.

PasswordPolicy

Password policy enforced at the GCIP tenant level. Only effective in multi-tenant mode.

PropertyTypeDescription
minLengthint32Minimum password length (6-30). Default: 6.
maxLengthint32Maximum password length (max 4096). Default: 4096.
requireUppercaseboolRequire at least one uppercase letter.
requireLowercaseboolRequire at least one lowercase letter.
requireNumericboolRequire at least one numeric character.
requireNonAlphanumericboolRequire at least one non-alphanumeric character.

Permissions

PropertyTypeDescription
disableUserSignupboolIf true, end-users will not be able to sign up for a new account using this provider.
disableUserDeletionboolIf true, end-users will not be able to delete their own account using this provider. Disabling this option will prevent GDPR compliance.

Providers

PropertyTypeDescription
anonymousbool
passwordbool
phonebool
googlebool
applebool
facebookbool
githubbool
linkedInbool
microsoftbool
googlePlaybool
twitterbool
yahoobool
oauth2list of stringGeneric OAuth 2.0

SmsRegionPolicy

SMS region policy restricting which geographic regions can receive SMS verification codes.

PropertyTypeDescription
allowedRegionslist of stringAllowlist mode: only these region codes (ISO 3166-1 alpha-2) can receive SMS.

TestPhoneNumbersEntry

PropertyTypeDescription
keystring
valuestring