Chapter 5. OAuthClient [oauth.openshift.io/v1]


Description

OAuthClient describes an OAuth client

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
object

5.1. Specification

PropertyTypeDescription

accessTokenInactivityTimeoutSeconds

integer

AccessTokenInactivityTimeoutSeconds overrides the default token inactivity timeout for tokens granted to this 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. This value needs to be set only if the default set in configuration is not appropriate for this client. Valid values are: - 0: Tokens for this client never time out - X: Tokens time out if there is no activity for X seconds The current minimum allowed value for X is 300 (5 minutes)

WARNING: existing tokens' timeout will not be affected (lowered) by changing this value

accessTokenMaxAgeSeconds

integer

AccessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. 0 means no expiration.

additionalSecrets

array (string)

AdditionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation and for service account token validation

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

grantMethod

string

GrantMethod is a required field which determines how to handle grants for this client. Valid grant handling methods are: - auto: always approves grant requests, useful for trusted clients - prompt: prompts the end user for approval of grant requests, useful for third-party clients

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

ObjectMeta_v2

metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

redirectURIs

array (string)

RedirectURIs is the valid redirection URIs associated with a client

respondWithChallenges

boolean

RespondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects

scopeRestrictions

array

ScopeRestrictions describes which scopes this client can request. Each requested scope is checked against each restriction. If any restriction matches, then the scope is allowed. If no restriction matches, then the scope is denied.

scopeRestrictions[]

object

ScopeRestriction describe one restriction on scopes. Exactly one option must be non-nil.

secret

string

Secret is the unique secret associated with a client

5.1.1. .scopeRestrictions

Description
ScopeRestrictions describes which scopes this client can request. Each requested scope is checked against each restriction. If any restriction matches, then the scope is allowed. If no restriction matches, then the scope is denied.
Type
array

5.1.2. .scopeRestrictions[]

Description
ScopeRestriction describe one restriction on scopes. Exactly one option must be non-nil.
Type
object
PropertyTypeDescription

clusterRole

object

ClusterRoleScopeRestriction describes restrictions on cluster role scopes

literals

array (string)

ExactValues means the scope has to match a particular set of strings exactly

5.1.3. .scopeRestrictions[].clusterRole

Description
ClusterRoleScopeRestriction describes restrictions on cluster role scopes
Type
object
Required
  • roleNames
  • namespaces
  • allowEscalation
PropertyTypeDescription

allowEscalation

boolean

AllowEscalation indicates whether you can request roles and their escalating resources

namespaces

array (string)

Namespaces is the list of namespaces that can be referenced. * means any of them (including *)

roleNames

array (string)

RoleNames is the list of cluster roles that can referenced. * means anything

5.2. API endpoints

The following API endpoints are available:

  • /apis/oauth.openshift.io/v1/oauthclients

    • DELETE: delete collection of OAuthClient
    • GET: list or watch objects of kind OAuthClient
    • POST: create an OAuthClient
  • /apis/oauth.openshift.io/v1/watch/oauthclients

    • GET: watch individual changes to a list of OAuthClient. deprecated: use the 'watch' parameter with a list operation instead.
  • /apis/oauth.openshift.io/v1/oauthclients/{name}

    • DELETE: delete an OAuthClient
    • GET: read the specified OAuthClient
    • PATCH: partially update the specified OAuthClient
    • PUT: replace the specified OAuthClient
  • /apis/oauth.openshift.io/v1/watch/oauthclients/{name}

    • GET: watch changes to an object of kind OAuthClient. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

5.2.1. /apis/oauth.openshift.io/v1/oauthclients

HTTP method
DELETE
Description
delete collection of OAuthClient
Table 5.1. Query parameters
ParameterTypeDescription

dryRun

string

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

Table 5.2. HTTP responses
HTTP codeReponse body

200 - OK

Status_v6 schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list or watch objects of kind OAuthClient
Table 5.3. HTTP responses
HTTP codeReponse body

200 - OK

OAuthClientList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create an OAuthClient
Table 5.4. Query parameters
ParameterTypeDescription

dryRun

string

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 5.5. Body parameters
ParameterTypeDescription

body

OAuthClient schema

 
Table 5.6. HTTP responses
HTTP codeReponse body

200 - OK

OAuthClient schema

201 - Created

OAuthClient schema

202 - Accepted

OAuthClient schema

401 - Unauthorized

Empty

5.2.2. /apis/oauth.openshift.io/v1/watch/oauthclients

HTTP method
GET
Description
watch individual changes to a list of OAuthClient. deprecated: use the 'watch' parameter with a list operation instead.
Table 5.7. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

5.2.3. /apis/oauth.openshift.io/v1/oauthclients/{name}

Table 5.8. Global path parameters
ParameterTypeDescription

name

string

name of the OAuthClient

HTTP method
DELETE
Description
delete an OAuthClient
Table 5.9. Query parameters
ParameterTypeDescription

dryRun

string

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

Table 5.10. HTTP responses
HTTP codeReponse body

200 - OK

Status_v6 schema

202 - Accepted

Status_v6 schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified OAuthClient
Table 5.11. HTTP responses
HTTP codeReponse body

200 - OK

OAuthClient schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified OAuthClient
Table 5.12. Query parameters
ParameterTypeDescription

dryRun

string

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 5.13. HTTP responses
HTTP codeReponse body

200 - OK

OAuthClient schema

201 - Created

OAuthClient schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified OAuthClient
Table 5.14. Query parameters
ParameterTypeDescription

dryRun

string

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 5.15. Body parameters
ParameterTypeDescription

body

OAuthClient schema

 
Table 5.16. HTTP responses
HTTP codeReponse body

200 - OK

OAuthClient schema

201 - Created

OAuthClient schema

401 - Unauthorized

Empty

5.2.4. /apis/oauth.openshift.io/v1/watch/oauthclients/{name}

Table 5.17. Global path parameters
ParameterTypeDescription

name

string

name of the OAuthClient

HTTP method
GET
Description
watch changes to an object of kind OAuthClient. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
Table 5.18. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.