TeleportGithubConnector
resources.teleport.dev / v3
apiVersion: resources.teleport.dev/v3
kind: TeleportGithubConnector
metadata:
name: example
apiVersion
string
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/sig-architecture/api-conventions.md#resources
kind
string
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/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
GithubConnector resource definition v3 from Teleport
api_endpoint_url
string
APIEndpointURL is the URL of the API endpoint of the Github instance this connector is for.
client_id
string
ClientID is the Github OAuth app client ID.
client_redirect_settings object
ClientRedirectSettings defines which client redirect URLs are allowed for non-browser SSO logins other than the standard localhost ones.
allowed_https_hostnames
[]string
a list of hostnames allowed for https client redirect URLs
insecure_allowed_cidr_ranges
[]string
a list of CIDRs allowed for HTTP or HTTPS client redirect URLs
client_secret
string
ClientSecret is the Github OAuth app client secret. This field supports secret lookup. See the operator documentation for more details.
display
string
Display is the connector display name.
endpoint_url
string
EndpointURL is the URL of the GitHub instance this connector is for.
redirect_url
string
RedirectURL is the authorization callback URL.
teams_to_roles []object
TeamsToRoles maps Github team memberships onto allowed roles.
organization
string
Organization is a Github organization a user belongs to.
roles
[]string
Roles is a list of allowed logins for this org/team.
team
string
Team is a team within the organization a user belongs to.
user_matchers
[]string
UserMatchers is a set of glob patterns to narrow down which username(s) this auth connector should match for identifier-first login.
status object
Status defines the observed state of the Teleport resource
conditions []object
Conditions represent the latest available observations of an object's state
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This 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
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
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])$maxLength:
316
teleportResourceID
integer
format:
int64No matches. Try .spec.api_endpoint_url for an exact path