{
  "description": "GitHubIdentityProvider describes the configuration of an upstream GitHub identity provider.\nThis upstream provider can be configured with either a GitHub App or a GitHub OAuth2 App.\n\n\nRight now, only web-based logins are supported, for both the pinniped-cli client and clients configured\nas OIDCClients.",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "Spec for configuring the identity provider.",
      "properties": {
        "allowAuthentication": {
          "description": "AllowAuthentication allows customization of who can authenticate using this IDP and how.",
          "properties": {
            "organizations": {
              "description": "Organizations allows customization of which organizations can authenticate using this IDP.",
              "properties": {
                "allowed": {
                  "description": "Allowed, when specified, indicates that only users with membership in at least one of the listed\nGitHub organizations may log in. In addition, the group membership presented to Kubernetes will only include\nteams within the listed GitHub organizations. Additional login rules or group filtering can optionally be\nprovided as policy expression on any Pinniped Supervisor FederationDomain that includes this IDP.\n\n\nThe configured GitHub App or GitHub OAuth App must be allowed to see membership in the listed organizations,\notherwise Pinniped will not be aware that the user belongs to the listed organization or any teams\nwithin that organization.\n\n\nIf no organizations are listed, you must set organizations: AllGitHubUsers.",
                  "items": {
                    "type": "string"
                  },
                  "maxItems": 64,
                  "type": "array",
                  "x-kubernetes-list-type": "set"
                },
                "policy": {
                  "default": "OnlyUsersFromAllowedOrganizations",
                  "description": "Allowed values are \"OnlyUsersFromAllowedOrganizations\" or \"AllGitHubUsers\".\nDefaults to \"OnlyUsersFromAllowedOrganizations\".\n\n\nMust be set to \"AllGitHubUsers\" if the allowed field is empty.\n\n\nThis field only exists to ensure that Pinniped administrators are aware that an empty list of\nallowedOrganizations means all GitHub users are allowed to log in.",
                  "enum": [
                    "OnlyUsersFromAllowedOrganizations",
                    "AllGitHubUsers"
                  ],
                  "type": "string"
                }
              },
              "type": "object",
              "x-kubernetes-validations": [
                {
                  "message": "spec.allowAuthentication.organizations.policy must be 'OnlyUsersFromAllowedOrganizations' when spec.allowAuthentication.organizations.allowed has organizations listed",
                  "rule": "!(has(self.allowed) && size(self.allowed) > 0 && self.policy == 'AllGitHubUsers')"
                },
                {
                  "message": "spec.allowAuthentication.organizations.policy must be 'AllGitHubUsers' when spec.allowAuthentication.organizations.allowed is empty",
                  "rule": "!((!has(self.allowed) || size(self.allowed) == 0) && self.policy == 'OnlyUsersFromAllowedOrganizations')"
                }
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "organizations"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "claims": {
          "default": {},
          "description": "Claims allows customization of the username and groups claims.",
          "properties": {
            "groups": {
              "default": "slug",
              "description": "Groups configures which property of the GitHub team record shall determine the group names in Kubernetes.\n\n\nCan be either \"name\" or \"slug\". Defaults to \"slug\".\n\n\nGitHub team names can contain upper and lower case characters, whitespace, and punctuation (e.g. \"Kube admins!\").\n\n\nGitHub team slugs are lower case alphanumeric characters and may contain dashes and underscores (e.g. \"kube-admins\").\n\n\nGroup names as presented to Kubernetes will always be prefixed by the GitHub organization name followed by a\nforward slash (e.g. \"my-org/my-team\"). GitHub organization login names can only contain alphanumeric characters\nor single hyphens, so the first forward slash `/` will be the separator between the organization login name and\nthe team name or slug.\n\n\nIf desired, an admin could configure identity transformation expressions on the Pinniped Supervisor's\nFederationDomain to further customize how these group names are presented to Kubernetes.\n\n\nSee the response schema for\n[List teams for the authenticated user](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#list-teams-for-the-authenticated-user).",
              "enum": [
                "name",
                "slug"
              ],
              "type": "string"
            },
            "username": {
              "default": "login:id",
              "description": "Username configures which property of the GitHub user record shall determine the username in Kubernetes.\n\n\nCan be either \"id\", \"login\", or \"login:id\". Defaults to \"login:id\".\n\n\nGitHub's user login attributes can only contain alphanumeric characters and non-repeating hyphens,\nand may not start or end with hyphens. GitHub users are allowed to change their login name,\nalthough it is inconvenient. If a GitHub user changed their login name from \"foo\" to \"bar\",\nthen a second user might change their name from \"baz\" to \"foo\" in order to take the old\nusername of the first user. For this reason, it is not as safe to make authorization decisions\nbased only on the user's login attribute.\n\n\nIf desired, an admin could configure identity transformation expressions on the Pinniped Supervisor's\nFederationDomain to further customize how these usernames are presented to Kubernetes.\n\n\nDefaults to \"login:id\", which is the user login attribute, followed by a colon, followed by the unique and\nunchanging integer ID number attribute. This blends human-readable login names with the unchanging ID value\nfrom GitHub. Colons are not allowed in GitHub login attributes or ID numbers, so this is a reasonable\nchoice to concatenate the two values.\n\n\nSee the response schema for\n[Get the authenticated user](https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-the-authenticated-user).",
              "enum": [
                "id",
                "login",
                "login:id"
              ],
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "client": {
          "description": "Client identifies the secret with credentials for a GitHub App or GitHub OAuth2 App (a GitHub client).",
          "properties": {
            "secretName": {
              "description": "SecretName contains the name of a namespace-local Secret object that provides the clientID and\nclientSecret for an GitHub App or GitHub OAuth2 client.\n\n\nThis secret must be of type \"secrets.pinniped.dev/github-client\" with keys \"clientID\" and \"clientSecret\".",
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "secretName"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "githubAPI": {
          "default": {},
          "description": "GitHubAPI allows configuration for GitHub Enterprise Server",
          "properties": {
            "host": {
              "default": "github.com",
              "description": "Host is required only for GitHub Enterprise Server.\nDefaults to using GitHub's public API (\"github.com\").\nFor convenience, specifying \"github.com\" is equivalent to specifying \"api.github.com\".\nDo not specify a protocol or scheme since \"https://\" will always be used.\nPort is optional. Do not specify a path, query, fragment, or userinfo.\nOnly specify domain name or IP address, subdomains (optional), and port (optional).\nIPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address\nin square brackets. Example: \"[::1]:443\".",
              "minLength": 1,
              "type": "string"
            },
            "tls": {
              "description": "TLS configuration for GitHub Enterprise Server.\nNote that this field should not be needed when using GitHub's public API (\"github.com\").\nHowever, if you choose to specify this field when using GitHub's public API, you must\nspecify a CA bundle that will verify connections to \"api.github.com\".",
              "properties": {
                "certificateAuthorityData": {
                  "description": "X.509 Certificate Authority (base64-encoded PEM bundle). If omitted, a default set of system roots will be trusted.",
                  "type": "string"
                },
                "certificateAuthorityDataSource": {
                  "description": "Reference to a CA bundle in a secret or a configmap.\nAny changes to the CA bundle in the secret or configmap will be dynamically reloaded.",
                  "properties": {
                    "key": {
                      "description": "Key is the key name within the secret or configmap from which to read the CA bundle.\nThe value found at this key in the secret or configmap must not be empty, and must be a valid PEM-encoded\ncertificate bundle.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "kind": {
                      "description": "Kind configures whether the CA bundle is being sourced from a Kubernetes secret or a configmap.\nAllowed values are \"Secret\" or \"ConfigMap\".\n\"ConfigMap\" uses a Kubernetes configmap to source CA Bundles.\n\"Secret\" uses Kubernetes secrets of type kubernetes.io/tls or Opaque to source CA Bundles.",
                      "enum": [
                        "Secret",
                        "ConfigMap"
                      ],
                      "type": "string"
                    },
                    "name": {
                      "description": "Name is the resource name of the secret or configmap from which to read the CA bundle.\nThe referenced secret or configmap must be created in the same namespace where Pinniped Supervisor is installed.",
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "key",
                    "kind",
                    "name"
                  ],
                  "type": "object",
                  "additionalProperties": false
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "allowAuthentication",
        "client"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "Status of the identity provider.",
      "properties": {
        "conditions": {
          "description": "Conditions represents the observations of an identity provider's current state.",
          "items": {
            "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions.  For example,\n\n\n\ttype FooStatus struct{\n\t    // Represents the observations of a foo's current state.\n\t    // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t    // +patchMergeKey=type\n\t    // +patchStrategy=merge\n\t    // +listType=map\n\t    // +listMapKey=type\n\t    Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t    // other fields\n\t}",
            "properties": {
              "lastTransitionTime": {
                "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.",
                "format": "date-time",
                "type": "string"
              },
              "message": {
                "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
                "maxLength": 32768,
                "type": "string"
              },
              "observedGeneration": {
                "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
                "format": "int64",
                "minimum": 0,
                "type": "integer"
              },
              "reason": {
                "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
                "maxLength": 1024,
                "minLength": 1,
                "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
                "type": "string"
              },
              "status": {
                "description": "status of the condition, one of True, False, Unknown.",
                "enum": [
                  "True",
                  "False",
                  "Unknown"
                ],
                "type": "string"
              },
              "type": {
                "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
                "maxLength": 316,
                "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
                "type": "string"
              }
            },
            "required": [
              "lastTransitionTime",
              "message",
              "reason",
              "status",
              "type"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array",
          "x-kubernetes-list-map-keys": [
            "type"
          ],
          "x-kubernetes-list-type": "map"
        },
        "phase": {
          "default": "Pending",
          "description": "Phase summarizes the overall status of the GitHubIdentityProvider.",
          "enum": [
            "Pending",
            "Ready",
            "Error"
          ],
          "type": "string"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "spec"
  ],
  "type": "object"
}