# TeleportSAMLConnector This guide is a comprehensive reference to the fields in the `TeleportSAMLConnector` resource, which you can apply after installing the Teleport Kubernetes operator. ## resources.teleport.dev/v2 **apiVersion:** resources.teleport.dev/v2 | Field | Type | Description | | ---------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 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: | | 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: | | metadata | object | | | spec | [object](#spec) | SAMLConnector resource definition v2 from Teleport | ### spec | Field | Type | Description | | --------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | acs | string | AssertionConsumerService is a URL for assertion consumer service on the service provider (Teleport's side). | | allow\_idp\_initiated | boolean | AllowIDPInitiated is a flag that indicates if the connector can be used for IdP-initiated logins. | | assertion\_key\_pair | [object](#specassertion_key_pair) | EncryptionKeyPair is a key pair used for decrypting SAML assertions. | | attributes\_to\_roles | \[][object](#specattributes_to_roles-items) | AttributesToRoles is a list of mappings of attribute statements to roles. | | audience | string | Audience uniquely identifies our service provider. | | cert | string | Cert is the identity provider certificate PEM. IDP signs `` responses using this certificate. | | client\_redirect\_settings | [object](#specclient_redirect_settings) | ClientRedirectSettings defines which client redirect URLs are allowed for non-browser SSO logins other than the standard localhost ones. | | credentials | [object](#speccredentials) | SAMLConnectorCredentials configures authentication for the connector to authenticate against the identity provider for performing ancillary operations, e.g. for standalone Entra SAML connectors to authenticate against MS Graph API. | | display | string | Display controls how this connector is displayed. | | entity\_descriptor | string | EntityDescriptor is XML with descriptor. It can be used to supply configuration parameters in one XML file rather than supplying them in the individual elements. | | entity\_descriptor\_url | string | EntityDescriptorURL is a URL that supplies a configuration XML. | | entra\_id\_groups\_provider | [object](#specentra_id_groups_provider) | EntraIDGroupsProvider configures out-of-band user groups provider. It works by following through the "groups.link" SAML assertion attribute, which is sent instead of the "groups" attribute, when the user's group membership exceeds 150 max item limit. | | force\_authn | string or integer | ForceAuthn specified whether re-authentication should be forced on login. UNSPECIFIED is treated as NO. Can be either the string or the integer representation of each option. | | include\_subject | boolean | IncludeSubject is a flag that indicates whether the Subject element is included in the SAML authentication request. Defaults to false. Note: Some IdPs will reject requests that contain a Subject. | | issuer | string | Issuer is the identity provider issuer. | | mfa | [object](#specmfa) | MFASettings contains settings to enable SSO MFA checks through this auth connector. | | preferred\_request\_binding | string | PreferredRequestBinding is a preferred SAML request binding method. Value must be either "http-post" or "http-redirect". In general, the SAML identity provider lists request binding methods it supports. And the SAML service provider uses one of the IdP supported request binding method that it prefers. But we never honored request binding value provided by the IdP and always used http-redirect binding as a default. Setting up PreferredRequestBinding value lets us preserve existing auth connector behavior and only use http-post binding if it is explicitly configured. | | provider | string | Provider is the external identity provider. | | service\_provider\_issuer | string | ServiceProviderIssuer is the issuer of the service provider (Teleport). | | signing\_key\_pair | [object](#specsigning_key_pair) | SigningKeyPair is an x509 key pair used to sign AuthnRequest. | | single\_logout\_url | string | SingleLogoutURL is the SAML Single log-out URL to initiate SAML SLO (single log-out). If this is not provided, SLO is disabled. | | sso | string | SSO is the URL of the identity provider's SSO service. | | 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. | ### spec.assertion\_key\_pair | Field | Type | Description | | ------------ | ------ | --------------------------------------------- | | cert | string | Cert is a PEM-encoded x509 certificate. | | private\_key | string | PrivateKey is a PEM encoded x509 private key. | ### spec.attributes\_to\_roles items | Field | Type | Description | | ----- | --------- | --------------------------------------------------- | | name | string | Name is an attribute statement name. | | roles | \[]string | Roles is a list of static teleport roles to map to. | | value | string | Value is an attribute statement value to match. | ### spec.client\_redirect\_settings | Field | Type | Description | | ------------------------------- | --------- | -------------------------------------------------------------- | | 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 | ### spec.credentials | Field | Type | Description | | ----- | ------------------------------- | --------------------------------------------------------------------------------------- | | oauth | [object](#speccredentialsoauth) | OAuthClientCredentials holds the credentials to use for OAuth client credentials grant. | ### spec.credentials.oauth | Field | Type | Description | | -------------- | ------ | ---------------------------------------------------------------------------- | | client\_id | string | ClientID is the client ID to use for OAuth client credentials grant. | | client\_secret | string | ClientSecret is the client secret to use for OAuth client credentials grant. | ### spec.entra\_id\_groups\_provider | Field | Type | Description | | --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | disabled | boolean | Disabled specifies that the groups provider should be disabled even when Entra ID responds with a groups claim source. User may choose to disable it if they are using integrations such as SCIM or similar groups importer as connector based role mapping may be not needed in such a scenario. | | graph\_endpoint | string | GraphEndpoint is a Microsoft Graph API endpoint. The groups claim source endpoint provided by Entra ID points to the now-retired Azure AD Graph endpoint (""). To convert it to the newer Microsoft Graph API endpoint, Teleport defaults to the Microsoft Graph global service endpoint (""). Update GraphEndpoint to point to a different Microsoft Graph national cloud deployment endpoint. | | group\_type | string | GroupType is a user group type filter. Defaults to "security-groups". Value can be "security-groups", "directory-roles", "all-groups". | ### spec.mfa | Field | Type | Description | | ----------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | cert | string | Cert is the identity provider certificate PEM. IDP signs `` responses using this certificate. | | enabled | boolean | Enabled specified whether this SAML connector supports MFA checks. Defaults to false. | | entity\_descriptor | string | EntityDescriptor is XML with descriptor. It can be used to supply configuration parameters in one XML file rather than supplying them in the individual elements. Usually set from EntityDescriptorUrl. | | entity\_descriptor\_url | string | EntityDescriptorUrl is a URL that supplies a configuration XML. | | force\_authn | string or integer | ForceAuthn specified whether re-authentication should be forced for MFA checks. UNSPECIFIED is treated as YES to always re-authentication for MFA checks. This should only be set to NO if the IdP is setup to perform MFA checks on top of active user sessions. Can be either the string or the integer representation of each option. | | issuer | string | Issuer is the identity provider issuer. Usually set from EntityDescriptor. | | sso | string | SSO is the URL of the identity provider's SSO service. Usually set from EntityDescriptor. | ### spec.signing\_key\_pair | Field | Type | Description | | ------------ | ------ | --------------------------------------------- | | cert | string | Cert is a PEM-encoded x509 certificate. | | private\_key | string | PrivateKey is a PEM encoded x509 private key. |