OAuthClient [oauth.openshift.io/v1] - OAuth APIs | API reference

Specification
API endpoints

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

Specification

Property Type Description

Property	Type	Description
`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

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

.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

.scopeRestrictions[]

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

Property Type Description

Property	Type	Description
`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

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

.scopeRestrictions[].clusterRole

Description

ClusterRoleScopeRestriction describes restrictions on cluster role scopes

Type

object

Required

roleNames
namespaces
allowEscalation

Property Type Description

Property	Type	Description
`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

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

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.

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

HTTP method: DELETE
Description: delete collection of OAuthClient

Table 1. Query parameters
Parameter	Type	Description
`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 2. HTTP responses
HTTP code	Reponse body
200 - OK	`Status_v6` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list or watch objects of kind OAuthClient

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`OAuthClientList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create an OAuthClient

Table 4. Query parameters
Parameter	Type	Description
`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. Body parameters
Parameter	Type	Description
`body`	`OAuthClient` schema

Table 6. HTTP responses
HTTP code	Reponse body
200 - OK	`OAuthClient` schema
201 - Created	`OAuthClient` schema
202 - Accepted	`OAuthClient` schema
401 - Unauthorized	Empty

/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 7. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

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

Table 8. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the OAuthClient

HTTP method: DELETE
Description: delete an OAuthClient

Table 9. Query parameters
Parameter	Type	Description
`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 10. HTTP responses
HTTP code	Reponse body
200 - OK	`Status_v6` schema
202 - Accepted	`Status_v6` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified OAuthClient

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`OAuthClient` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified OAuthClient

Table 12. Query parameters
Parameter	Type	Description
`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 13. HTTP responses
HTTP code	Reponse body
200 - OK	`OAuthClient` schema
201 - Created	`OAuthClient` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified OAuthClient

Table 14. Query parameters
Parameter	Type	Description
`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 15. Body parameters
Parameter	Type	Description
`body`	`OAuthClient` schema

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`OAuthClient` schema
201 - Created	`OAuthClient` schema
401 - Unauthorized	Empty

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

Table 17. Global path parameters
Parameter	Type	Description
`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 18. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty