OAuth [config.openshift.io/v1]
- Description
-
OAuth holds cluster-wide information about OAuth. The canonical name is `cluster`. It is used to configure the integrated OAuth server. This configuration is only honored when the top level Authentication config has type set to IntegratedOAuth.
- Type
-
object - Required
-
-
spec
-
Specification
| Property | Type | 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/sig-architecture/api-conventions.md#resources |
|
|
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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
OAuthSpec contains desired cluster auth configuration |
|
|
OAuthStatus shows current known state of OAuth server in the cluster |
- Description
-
OAuthSpec contains desired cluster auth configuration
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
identityProviders is an ordered list of ways for a user to identify themselves. When this list is empty, no identities are provisioned for users. |
|
|
IdentityProvider provides identities for users authenticating using credentials |
|
|
templates allow you to customize pages like the login page. |
|
|
tokenConfig contains options for authorization and access tokens |
- Description
-
identityProviders is an ordered list of ways for a user to identify themselves. When this list is empty, no identities are provisioned for users.
- Type
-
array
- Description
-
IdentityProvider provides identities for users authenticating using credentials
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
basicAuth contains configuration options for the BasicAuth IdP |
|
|
github enables user authentication using GitHub credentials |
|
|
gitlab enables user authentication using GitLab credentials |
|
|
google enables user authentication using Google credentials |
|
|
htpasswd enables user authentication using an HTPasswd file to validate credentials |
|
|
keystone enables user authentication using keystone password credentials |
|
|
ldap enables user authentication using LDAP credentials |
|
|
mappingMethod determines how identities from this provider are mapped to users Defaults to "claim" |
|
|
name is used to qualify the identities returned by this provider. - It MUST be unique and not shared by any other identity provider used - It MUST be a valid path segment: name cannot equal "." or ".." or contain "/" or "%" or ":" Ref: https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName |
|
|
openID enables user authentication using OpenID credentials |
|
|
requestHeader enables user authentication using request header credentials |
|
|
type identifies the identity provider type for this entry. |
- Description
-
basicAuth contains configuration options for the BasicAuth IdP
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. |
|
|
tlsClientCert is an optional reference to a secret by name that contains the PeM-encoded TLS client certificate to present when connecting to the server. The key "tls.crt" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. |
|
|
tlsClientKey is an optional reference to a secret by name that contains the PeM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key "tls.key" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. |
|
|
url is the remote URL to connect to |
- Description
-
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced config map |
- Description
-
tlsClientCert is an optional reference to a secret by name that contains the PeM-encoded TLS client certificate to present when connecting to the server. The key "tls.crt" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
tlsClientKey is an optional reference to a secret by name that contains the PeM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key "tls.key" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
github enables user authentication using GitHub credentials
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. This can only be configured when hostname is set to a non-empty value. The namespace for this config map is openshift-config. |
|
|
clientID is the oauth client ID |
|
|
clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. |
|
|
hostname is the optional domain (e.g. "mycompany.com") for use with a hosted instance of GitHub enterprise. It must match the GitHub enterprise settings value configured at /setup/settings#hostname. |
|
|
organizations optionally restricts which organizations are allowed to log in |
|
|
teams optionally restricts which teams are allowed to log in. Format is <org>/<team>. |
- Description
-
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. This can only be configured when hostname is set to a non-empty value. The namespace for this config map is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced config map |
- Description
-
clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
gitlab enables user authentication using GitLab credentials
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. |
|
|
clientID is the oauth client ID |
|
|
clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. |
|
|
url is the oauth server base URL |
- Description
-
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced config map |
- Description
-
clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
google enables user authentication using Google credentials
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
clientID is the oauth client ID |
|
|
clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. |
|
|
hostedDomain is the optional Google App domain (e.g. "mycompany.com") to restrict logins to |
- Description
-
clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
htpasswd enables user authentication using an HTPasswd file to validate credentials
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
fileData is a required reference to a secret by name containing the data to use as the htpasswd file. The key "htpasswd" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. If the specified htpasswd data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. |
- Description
-
fileData is a required reference to a secret by name containing the data to use as the htpasswd file. The key "htpasswd" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. If the specified htpasswd data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
keystone enables user authentication using keystone password credentials
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. |
|
|
domainName is required for keystone v3 |
|
|
tlsClientCert is an optional reference to a secret by name that contains the PeM-encoded TLS client certificate to present when connecting to the server. The key "tls.crt" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. |
|
|
tlsClientKey is an optional reference to a secret by name that contains the PeM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key "tls.key" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. |
|
|
url is the remote URL to connect to |
- Description
-
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced config map |
- Description
-
tlsClientCert is an optional reference to a secret by name that contains the PeM-encoded TLS client certificate to present when connecting to the server. The key "tls.crt" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
tlsClientKey is an optional reference to a secret by name that contains the PeM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key "tls.key" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
ldap enables user authentication using LDAP credentials
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
attributes maps LDAP attributes to identities |
|
|
bindDN is an optional DN to bind with during the search phase. |
|
|
bindPassword is an optional reference to a secret by name containing a password to bind with during the search phase. The key "bindPassword" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. |
|
|
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. |
|
|
insecure, if true, indicates the connection should not use TLS WARNING: Should not be set to |
|
|
url is an RFC 2255 URL which specifies the LDAP search parameters to use. The syntax of the URL is: ldap://host:port/basedn?attribute?scope?filter |
- Description
-
attributes maps LDAP attributes to identities
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
email is the list of attributes whose values should be used as the email address. Optional. If unspecified, no email is set for the identity |
|
|
id is the list of attributes whose values should be used as the user ID. Required. First non-empty attribute is used. At least one attribute is required. If none of the listed attribute have a value, authentication fails. LDAP standard identity attribute is "dn" |
|
|
name is the list of attributes whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity LDAP standard display name attribute is "cn" |
|
|
preferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is "uid" |
- Description
-
bindPassword is an optional reference to a secret by name containing a password to bind with during the search phase. The key "bindPassword" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced config map |
- Description
-
openID enables user authentication using OpenID credentials
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config. |
|
|
claims mappings |
|
|
clientID is the oauth client ID |
|
|
clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config. |
|
|
extraAuthorizeParameters are any custom parameters to add to the authorize request. |
|
|
extraScopes are any scopes to request in addition to the standard "openid" scope. |
|
|
issuer is the URL that the OpenID Provider asserts as its Issuer Identifier. It must use the https scheme with no query or fragment component. |
- Description
-
ca is an optional reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca.crt" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced config map |
- Description
-
claims mappings
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
email is the list of claims whose values should be used as the email address. Optional. If unspecified, no email is set for the identity |
|
|
name is the list of claims whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity |
|
|
preferredUsername is the list of claims whose values should be used as the preferred username. If unspecified, the preferred username is determined from the value of the sub claim |
- Description
-
clientSecret is a required reference to the secret by name containing the oauth client secret. The key "clientSecret" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
requestHeader enables user authentication using request header credentials
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
ca is a required reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. Specifically, it allows verification of incoming requests to prevent header spoofing. The key "ca.crt" is used to locate the data. If the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. The namespace for this config map is openshift-config. |
|
|
challengeURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect WWW-Authenticate challenges will be redirected here. ${url} is replaced with the current URL, escaped to be safe in a query parameter https://www.example.com/sso-login?then=${url} ${query} is replaced with the current query string https://www.example.com/auth-proxy/oauth/authorize?${query} Required when challenge is set to true. |
|
|
clientCommonNames is an optional list of common names to require a match from. If empty, any client certificate validated against the clientCA bundle is considered authoritative. |
|
|
emailHeaders is the set of headers to check for the email address |
|
|
headers is the set of headers to check for identity information |
|
|
loginURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect interactive logins will be redirected here ${url} is replaced with the current URL, escaped to be safe in a query parameter https://www.example.com/sso-login?then=${url} ${query} is replaced with the current query string https://www.example.com/auth-proxy/oauth/authorize?${query} Required when login is set to true. |
|
|
nameHeaders is the set of headers to check for the display name |
|
|
preferredUsernameHeaders is the set of headers to check for the preferred username |
- Description
-
ca is a required reference to a config map by name containing the PeM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. Specifically, it allows verification of incoming requests to prevent header spoofing. The key "ca.crt" is used to locate the data. If the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. The namespace for this config map is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced config map |
- Description
-
templates allow you to customize pages like the login page.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
error is the name of a secret that specifies a go template to use to render error pages during the authentication or grant flow. The key "errors.html" is used to locate the template data. If specified and the secret or expected key is not found, the default error page is used. If the specified template is not valid, the default error page is used. If unspecified, the default error page is used. The namespace for this secret is openshift-config. |
|
|
login is the name of a secret that specifies a go template to use to render the login page. The key "login.html" is used to locate the template data. If specified and the secret or expected key is not found, the default login page is used. If the specified template is not valid, the default login page is used. If unspecified, the default login page is used. The namespace for this secret is openshift-config. |
|
|
providerSelection is the name of a secret that specifies a go template to use to render the provider selection page. The key "providers.html" is used to locate the template data. If specified and the secret or expected key is not found, the default provider selection page is used. If the specified template is not valid, the default provider selection page is used. If unspecified, the default provider selection page is used. The namespace for this secret is openshift-config. |
- Description
-
error is the name of a secret that specifies a go template to use to render error pages during the authentication or grant flow. The key "errors.html" is used to locate the template data. If specified and the secret or expected key is not found, the default error page is used. If the specified template is not valid, the default error page is used. If unspecified, the default error page is used. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
login is the name of a secret that specifies a go template to use to render the login page. The key "login.html" is used to locate the template data. If specified and the secret or expected key is not found, the default login page is used. If the specified template is not valid, the default login page is used. If unspecified, the default login page is used. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
providerSelection is the name of a secret that specifies a go template to use to render the provider selection page. The key "providers.html" is used to locate the template data. If specified and the secret or expected key is not found, the default provider selection page is used. If the specified template is not valid, the default provider selection page is used. If unspecified, the default provider selection page is used. The namespace for this secret is openshift-config.
- Type
-
object - Required
-
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
name is the metadata.name of the referenced secret |
- Description
-
tokenConfig contains options for authorization and access tokens
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
accessTokenInactivityTimeoutSeconds defines the default token inactivity timeout for tokens granted by any client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. Valid values are integer values: x < 0 Tokens time out is enabled but tokens never timeout unless configured per client (e.g. |
|
|
accessTokenMaxAgeSeconds defines the maximum age of access tokens |
- Description
-
OAuthStatus shows current known state of OAuth server in the cluster
- Type
-
object
API endpoints
The following API endpoints are available:
-
/apis/config.openshift.io/v1/oauths-
DeLeTe: delete collection of OAuth -
GeT: list objects of kind OAuth -
POST: create an OAuth
-
-
/apis/config.openshift.io/v1/oauths/{name}-
DeLeTe: delete an OAuth -
GeT: read the specified OAuth -
PATCH: partially update the specified OAuth -
PUT: replace the specified OAuth
-
-
/apis/config.openshift.io/v1/oauths/{name}/status-
GeT: read status of the specified OAuth -
PATCH: partially update status of the specified OAuth -
PUT: replace status of the specified OAuth
-
/apis/config.openshift.io/v1/oauths
| Parameter | Type | Description |
|---|---|---|
|
|
If 'true', then the output is pretty printed. |
- HTTP method
-
DeLeTe - Description
-
delete collection of OAuth
| Parameter | Type | Description |
|---|---|---|
|
|
allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 Resourceexpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
- HTTP method
-
GeT - Description
-
list objects of kind OAuth
| Parameter | Type | Description |
|---|---|---|
|
|
allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 Resourceexpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
- HTTP method
-
POST - Description
-
create an OAuth
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
empty |
/apis/config.openshift.io/v1/oauths/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
name of the OAuth |
| Parameter | Type | Description |
|---|---|---|
|
|
If 'true', then the output is pretty printed. |
- HTTP method
-
DeLeTe - Description
-
delete an OAuth
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
|
|
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. either this field or PropagationPolicy may be set, but not both. |
|
|
Whether and how garbage collection will be performed. either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized |
empty |
- HTTP method
-
GeT - Description
-
read the specified OAuth
| Parameter | Type | Description |
|---|---|---|
|
|
When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
- HTTP method
-
PATCH - Description
-
partially update the specified OAuth
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
- HTTP method
-
PUT - Description
-
replace the specified OAuth
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
empty |
/apis/config.openshift.io/v1/oauths/{name}/status
| Parameter | Type | Description |
|---|---|---|
|
|
name of the OAuth |
| Parameter | Type | Description |
|---|---|---|
|
|
If 'true', then the output is pretty printed. |
- HTTP method
-
GeT - Description
-
read status of the specified OAuth
| Parameter | Type | Description |
|---|---|---|
|
|
When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
- HTTP method
-
PATCH - Description
-
partially update status of the specified OAuth
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
- HTTP method
-
PUT - Description
-
replace status of the specified OAuth
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Type | Description |
|---|---|---|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
empty |