1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/identity-provider-basic-authentication-CR.adoc
2025-10-29 16:59:21 +00:00

45 lines
1.5 KiB
Plaintext

// Module included in the following assemblies:
//
// * authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc
:_mod-docs-content-type: REFERENCE
[id="identity-provider-basic-authentication-CR_{context}"]
= Sample basic authentication CR
The following custom resource (CR) shows the parameters and acceptable values for a
basic authentication identity provider.
.Basic authentication CR
[source,yaml]
----
apiVersion: config.openshift.io/v1
kind: OAuth
metadata:
name: cluster
spec:
identityProviders:
- name: basicidp <1>
mappingMethod: claim <2>
type: BasicAuth
basicAuth:
url: https://www.example.com/remote-idp <3>
ca: <4>
name: ca-config-map
tlsClientCert: <5>
name: client-cert-secret
tlsClientKey: <6>
name: client-key-secret
----
<1> This provider name is prefixed to the returned user ID to form an identity
name.
<2> Controls how mappings are established between this provider's identities and `User` objects.
<3> URL accepting credentials in Basic authentication headers.
<4> Optional: Reference to an {product-title} `ConfigMap` object containing the
PEM-encoded certificate authority bundle to use in validating server
certificates for the configured URL.
<5> Optional: Reference to an {product-title} `Secret` object containing the client
certificate to present when making requests to the configured URL.
<6> Reference to an {product-title} `Secret` object containing the key for the
client certificate. Required if `tlsClientCert` is specified.