identityplatformconfig_v1beta1.json

{
  "properties": {
    "apiVersion": {
      "description": "apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "properties": {
        "authorizedDomains": {
          "description": "List of domains authorized for OAuth redirects",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "blockingFunctions": {
          "description": "Configuration related to blocking functions.",
          "properties": {
            "triggers": {
              "additionalProperties": {
                "properties": {
                  "functionUriRef": {
                    "oneOf": [
                      {
                        "not": {
                          "required": [
                            "external"
                          ]
                        },
                        "required": [
                          "name"
                        ]
                      },
                      {
                        "not": {
                          "anyOf": [
                            {
                              "required": [
                                "name"
                              ]
                            },
                            {
                              "required": [
                                "namespace"
                              ]
                            }
                          ]
                        },
                        "required": [
                          "external"
                        ]
                      }
                    ],
                    "properties": {
                      "external": {
                        "description": "HTTP URI trigger for the Cloud Function.\n\nAllowed value: The `httpsTrigger.url` field of a `CloudFunctionsFunction` resource.",
                        "type": "string"
                      },
                      "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                      },
                      "namespace": {
                        "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
                        "type": "string"
                      }
                    },
                    "type": "object",
                    "additionalProperties": false
                  },
                  "updateTime": {
                    "description": "When the trigger was changed.",
                    "format": "date-time",
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "description": "Map of Trigger to event type. Key should be one of the supported event types: \"beforeCreate\", \"beforeSignIn\"",
              "type": "object"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "client": {
          "description": "Options related to how clients making requests on behalf of a project should be configured.",
          "properties": {
            "permissions": {
              "description": "Configuration related to restricting a user's ability to affect their account.",
              "properties": {
                "disabledUserDeletion": {
                  "description": "When true, end users cannot delete their account on the associated project through any of our API methods",
                  "type": "boolean"
                },
                "disabledUserSignup": {
                  "description": "When true, end users cannot sign up for a new account on the associated project through any of our API methods",
                  "type": "boolean"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "mfa": {
          "description": "Configuration for this project's multi-factor authentication, including whether it is active and what factors can be used for the second factor",
          "properties": {
            "state": {
              "description": "Whether MultiFactor Authentication has been enabled for this project. Possible values: STATE_UNSPECIFIED, DISABLED, ENABLED, MANDATORY",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "monitoring": {
          "description": "Configuration related to monitoring project activity.",
          "properties": {
            "requestLogging": {
              "description": "Configuration for logging requests made to this project to Stackdriver Logging",
              "properties": {
                "enabled": {
                  "description": "Whether logging is enabled for this project or not.",
                  "type": "boolean"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "multiTenant": {
          "description": "Configuration related to multi-tenant functionality.",
          "properties": {
            "allowTenants": {
              "description": "Whether this project can have tenants or not.",
              "type": "boolean"
            },
            "defaultTenantLocationRef": {
              "oneOf": [
                {
                  "not": {
                    "required": [
                      "external"
                    ]
                  },
                  "required": [
                    "name",
                    "kind"
                  ]
                },
                {
                  "not": {
                    "anyOf": [
                      {
                        "required": [
                          "name"
                        ]
                      },
                      {
                        "required": [
                          "namespace"
                        ]
                      },
                      {
                        "required": [
                          "kind"
                        ]
                      }
                    ]
                  },
                  "required": [
                    "external"
                  ]
                }
              ],
              "properties": {
                "external": {
                  "description": "The default cloud parent org or folder that the tenant project should be created under. The parent resource name should be in the format of \"<type>/<number>\", such as \"folders/123\" or \"organizations/456\". If the value is not set, the tenant will be created under the same organization or folder as the agent project.\n\nAllowed values:\n* The Google Cloud resource name of a `Folder` resource (format: `folders/{{name}}`).\n* The Google Cloud resource name of a Google Cloud Organization (format: `organizations/{{name}}`).",
                  "type": "string"
                },
                "kind": {
                  "description": "Kind of the referent. Allowed values: Folder",
                  "type": "string"
                },
                "name": {
                  "description": "[WARNING] Organization not yet supported in Config Connector, use 'external' field to reference existing resources.\nName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                  "type": "string"
                },
                "namespace": {
                  "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "notification": {
          "description": "Configuration related to sending notifications to users.",
          "properties": {
            "defaultLocale": {
              "description": "Default locale used for email and SMS in IETF BCP 47 format.",
              "type": "string"
            },
            "sendEmail": {
              "description": "Options for email sending.",
              "properties": {
                "callbackUri": {
                  "description": "action url in email template.",
                  "type": "string"
                },
                "changeEmailTemplate": {
                  "description": "Email template for change email",
                  "properties": {
                    "body": {
                      "description": "Immutable. Email body",
                      "type": "string"
                    },
                    "bodyFormat": {
                      "description": "Email body format Possible values: BODY_FORMAT_UNSPECIFIED, PLAIN_TEXT, HTML",
                      "type": "string"
                    },
                    "replyTo": {
                      "description": "Reply-to address",
                      "type": "string"
                    },
                    "senderDisplayName": {
                      "description": "Sender display name",
                      "type": "string"
                    },
                    "senderLocalPart": {
                      "description": "Local part of From address",
                      "type": "string"
                    },
                    "subject": {
                      "description": "Subject of the email",
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "dnsInfo": {
                  "description": "Information of custom domain DNS verification.",
                  "properties": {
                    "useCustomDomain": {
                      "description": "Whether to use custom domain.",
                      "type": "boolean"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "method": {
                  "description": "The method used for sending an email. Possible values: METHOD_UNSPECIFIED, DEFAULT, CUSTOM_SMTP",
                  "type": "string"
                },
                "resetPasswordTemplate": {
                  "description": "Email template for reset password",
                  "properties": {
                    "body": {
                      "description": "Email body",
                      "type": "string"
                    },
                    "bodyFormat": {
                      "description": "Email body format Possible values: BODY_FORMAT_UNSPECIFIED, PLAIN_TEXT, HTML",
                      "type": "string"
                    },
                    "replyTo": {
                      "description": "Reply-to address",
                      "type": "string"
                    },
                    "senderDisplayName": {
                      "description": "Sender display name",
                      "type": "string"
                    },
                    "senderLocalPart": {
                      "description": "Local part of From address",
                      "type": "string"
                    },
                    "subject": {
                      "description": "Subject of the email",
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "revertSecondFactorAdditionTemplate": {
                  "description": "Email template for reverting second factor addition emails",
                  "properties": {
                    "body": {
                      "description": "Immutable. Email body",
                      "type": "string"
                    },
                    "bodyFormat": {
                      "description": "Email body format Possible values: BODY_FORMAT_UNSPECIFIED, PLAIN_TEXT, HTML",
                      "type": "string"
                    },
                    "replyTo": {
                      "description": "Reply-to address",
                      "type": "string"
                    },
                    "senderDisplayName": {
                      "description": "Sender display name",
                      "type": "string"
                    },
                    "senderLocalPart": {
                      "description": "Local part of From address",
                      "type": "string"
                    },
                    "subject": {
                      "description": "Subject of the email",
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "smtp": {
                  "description": "Use a custom SMTP relay",
                  "properties": {
                    "host": {
                      "description": "SMTP relay host",
                      "type": "string"
                    },
                    "password": {
                      "description": "SMTP relay password",
                      "oneOf": [
                        {
                          "not": {
                            "required": [
                              "valueFrom"
                            ]
                          },
                          "required": [
                            "value"
                          ]
                        },
                        {
                          "not": {
                            "required": [
                              "value"
                            ]
                          },
                          "required": [
                            "valueFrom"
                          ]
                        }
                      ],
                      "properties": {
                        "value": {
                          "description": "Value of the field. Cannot be used if 'valueFrom' is specified.",
                          "type": "string"
                        },
                        "valueFrom": {
                          "description": "Source for the field's value. Cannot be used if 'value' is specified.",
                          "properties": {
                            "secretKeyRef": {
                              "description": "Reference to a value with the given key in the given Secret in the resource's namespace.",
                              "properties": {
                                "key": {
                                  "description": "Key that identifies the value to be extracted.",
                                  "type": "string"
                                },
                                "name": {
                                  "description": "Name of the Secret to extract a value from.",
                                  "type": "string"
                                }
                              },
                              "required": [
                                "name",
                                "key"
                              ],
                              "type": "object",
                              "additionalProperties": false
                            }
                          },
                          "type": "object",
                          "additionalProperties": false
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    },
                    "port": {
                      "description": "SMTP relay port",
                      "format": "int64",
                      "type": "integer"
                    },
                    "securityMode": {
                      "description": "SMTP security mode. Possible values: SECURITY_MODE_UNSPECIFIED, SSL, START_TLS",
                      "type": "string"
                    },
                    "senderEmail": {
                      "description": "Sender email for the SMTP relay",
                      "type": "string"
                    },
                    "username": {
                      "description": "SMTP relay username",
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "verifyEmailTemplate": {
                  "description": "Email template for verify email",
                  "properties": {
                    "body": {
                      "description": "Immutable. Email body",
                      "type": "string"
                    },
                    "bodyFormat": {
                      "description": "Email body format Possible values: BODY_FORMAT_UNSPECIFIED, PLAIN_TEXT, HTML",
                      "type": "string"
                    },
                    "replyTo": {
                      "description": "Reply-to address",
                      "type": "string"
                    },
                    "senderDisplayName": {
                      "description": "Sender display name",
                      "type": "string"
                    },
                    "senderLocalPart": {
                      "description": "Local part of From address",
                      "type": "string"
                    },
                    "subject": {
                      "description": "Subject of the email",
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "sendSms": {
              "description": "Options for SMS sending.",
              "properties": {
                "useDeviceLocale": {
                  "description": "Whether to use the accept_language header for SMS.",
                  "type": "boolean"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "projectRef": {
          "description": "Immutable. The Project that this resource belongs to.",
          "oneOf": [
            {
              "not": {
                "required": [
                  "external"
                ]
              },
              "required": [
                "name"
              ]
            },
            {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "name"
                    ]
                  },
                  {
                    "required": [
                      "namespace"
                    ]
                  }
                ]
              },
              "required": [
                "external"
              ]
            }
          ],
          "properties": {
            "external": {
              "description": "The project of the resource\n\nAllowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`).",
              "type": "string"
            },
            "name": {
              "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
              "type": "string"
            },
            "namespace": {
              "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "quota": {
          "description": "Configuration related to quotas.",
          "properties": {
            "signUpQuotaConfig": {
              "description": "Quota for the Signup endpoint, if overwritten. Signup quota is measured in sign ups per project per hour per IP.",
              "properties": {
                "quota": {
                  "description": "Corresponds to the 'refill_token_count' field in QuotaServer config",
                  "format": "int64",
                  "type": "integer"
                },
                "quotaDuration": {
                  "description": "How long this quota will be active for",
                  "type": "string"
                },
                "startTime": {
                  "description": "When this quota will take affect",
                  "format": "date-time",
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "signIn": {
          "description": "Configuration related to local sign in methods.",
          "properties": {
            "allowDuplicateEmails": {
              "description": "Whether to allow more than one account to have the same email.",
              "type": "boolean"
            },
            "anonymous": {
              "description": "Configuration options related to authenticating an anonymous user.",
              "properties": {
                "enabled": {
                  "description": "Whether anonymous user auth is enabled for the project or not.",
                  "type": "boolean"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "email": {
              "description": "Configuration options related to authenticating a user by their email address.",
              "properties": {
                "enabled": {
                  "description": "Whether email auth is enabled for the project or not.",
                  "type": "boolean"
                },
                "passwordRequired": {
                  "description": "Whether a password is required for email auth or not. If true, both an email and password must be provided to sign in. If false, a user may sign in via either email/password or email link.",
                  "type": "boolean"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "phoneNumber": {
              "description": "Configuration options related to authenticated a user by their phone number.",
              "properties": {
                "enabled": {
                  "description": "Whether phone number auth is enabled for the project or not.",
                  "type": "boolean"
                },
                "testPhoneNumbers": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "description": "A map of that can be used for phone auth testing.",
                  "type": "object"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "projectRef"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "properties": {
        "client": {
          "properties": {
            "apiKey": {
              "description": "Output only. API key that can be used when making requests for this project.",
              "type": "string"
            },
            "firebaseSubdomain": {
              "description": "Output only. Firebase subdomain.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "conditions": {
          "description": "Conditions represent the latest available observation of the resource's current state.",
          "items": {
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.",
                "type": "string"
              },
              "message": {
                "description": "Human-readable message indicating details about last transition.",
                "type": "string"
              },
              "reason": {
                "description": "Unique, one-word, CamelCase reason for the condition's last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status is the status of the condition. Can be True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type is the type of the condition.",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "notification": {
          "properties": {
            "sendEmail": {
              "properties": {
                "changeEmailTemplate": {
                  "properties": {
                    "customized": {
                      "description": "Output only. Whether the body or subject of the email is customized.",
                      "type": "boolean"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "dnsInfo": {
                  "properties": {
                    "customDomain": {
                      "description": "Output only. The applied verified custom domain.",
                      "type": "string"
                    },
                    "customDomainState": {
                      "description": "Output only. The current verification state of the custom domain. The custom domain will only be used once the domain verification is successful. Possible values: VERIFICATION_STATE_UNSPECIFIED, NOT_STARTED, IN_PROGRESS, FAILED, SUCCEEDED",
                      "type": "string"
                    },
                    "domainVerificationRequestTime": {
                      "description": "Output only. The timestamp of initial request for the current domain verification.",
                      "format": "date-time",
                      "type": "string"
                    },
                    "pendingCustomDomain": {
                      "description": "Output only. The custom domain that's to be verified.",
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "resetPasswordTemplate": {
                  "properties": {
                    "customized": {
                      "description": "Output only. Whether the body or subject of the email is customized.",
                      "type": "boolean"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "revertSecondFactorAdditionTemplate": {
                  "properties": {
                    "customized": {
                      "description": "Output only. Whether the body or subject of the email is customized.",
                      "type": "boolean"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                },
                "verifyEmailTemplate": {
                  "properties": {
                    "customized": {
                      "description": "Output only. Whether the body or subject of the email is customized.",
                      "type": "boolean"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "sendSms": {
              "properties": {
                "smsTemplate": {
                  "description": "Output only. The template to use when sending an SMS.",
                  "properties": {
                    "content": {
                      "description": "Output only. The SMS's content. Can contain the following placeholders which will be replaced with the appropriate values: %APP_NAME% - For Android or iOS apps, the app's display name. For web apps, the domain hosting the application. %LOGIN_CODE% - The OOB code being sent in the SMS.",
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "observedGeneration": {
          "description": "ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.",
          "type": "integer"
        },
        "signIn": {
          "properties": {
            "email": {
              "properties": {
                "hashConfig": {
                  "description": "Output only. Hash config information.",
                  "properties": {
                    "algorithm": {
                      "description": "Output only. Different password hash algorithms used in Identity Toolkit. Possible values: HASH_ALGORITHM_UNSPECIFIED, HMAC_SHA256, HMAC_SHA1, HMAC_MD5, SCRYPT, PBKDF_SHA1, MD5, HMAC_SHA512, SHA1, BCRYPT, PBKDF2_SHA256, SHA256, SHA512, STANDARD_SCRYPT",
                      "type": "string"
                    },
                    "memoryCost": {
                      "description": "Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.",
                      "format": "int64",
                      "type": "integer"
                    },
                    "rounds": {
                      "description": "Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.",
                      "format": "int64",
                      "type": "integer"
                    },
                    "saltSeparator": {
                      "description": "Output only. Non-printable character to be inserted between the salt and plain text password in base64.",
                      "type": "string"
                    },
                    "signerKey": {
                      "description": "Output only. Signer key in base64.",
                      "type": "string"
                    }
                  },
                  "type": "object",
                  "additionalProperties": false
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "hashConfig": {
              "description": "Output only. Hash config information.",
              "properties": {
                "algorithm": {
                  "description": "Output only. Different password hash algorithms used in Identity Toolkit. Possible values: HASH_ALGORITHM_UNSPECIFIED, HMAC_SHA256, HMAC_SHA1, HMAC_MD5, SCRYPT, PBKDF_SHA1, MD5, HMAC_SHA512, SHA1, BCRYPT, PBKDF2_SHA256, SHA256, SHA512, STANDARD_SCRYPT",
                  "type": "string"
                },
                "memoryCost": {
                  "description": "Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.",
                  "format": "int64",
                  "type": "integer"
                },
                "rounds": {
                  "description": "Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.",
                  "format": "int64",
                  "type": "integer"
                },
                "saltSeparator": {
                  "description": "Output only. Non-printable character to be inserted between the salt and plain text password in base64.",
                  "type": "string"
                },
                "signerKey": {
                  "description": "Output only. Signer key in base64.",
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "subtype": {
          "description": "Output only. The subtype of this config. Possible values: SUBTYPE_UNSPECIFIED, IDENTITY_PLATFORM, FIREBASE_AUTH",
          "type": "string"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "spec"
  ],
  "type": "object"
}