×
Description

OAuthClientAuthorization describes an authorization created by 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

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

clientName

string

ClientName references the client that created this authorization

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

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

scopes

array (string)

Scopes is an array of the granted scopes.

userName

string

UserName is the user name that authorized this client

userUID

string

UserUID is the unique UID associated with this authorization. UserUID and UserName must both match for this authorization to be valid.

API endpoints

The following API endpoints are available:

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

    • DELETE: delete collection of OAuthClientAuthorization

    • GET: list or watch objects of kind OAuthClientAuthorization

    • POST: create an OAuthClientAuthorization

  • /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations

    • GET: watch individual changes to a list of OAuthClientAuthorization. deprecated: use the 'watch' parameter with a list operation instead.

  • /apis/oauth.openshift.io/v1/oauthclientauthorizations/{name}

    • DELETE: delete an OAuthClientAuthorization

    • GET: read the specified OAuthClientAuthorization

    • PATCH: partially update the specified OAuthClientAuthorization

    • PUT: replace the specified OAuthClientAuthorization

  • /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations/{name}

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

/apis/oauth.openshift.io/v1/oauthclientauthorizations

HTTP method

DELETE

Description

delete collection of OAuthClientAuthorization

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 schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list or watch objects of kind OAuthClientAuthorization

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

OAuthClientAuthorizationList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create an OAuthClientAuthorization

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

OAuthClientAuthorization schema

Table 6. HTTP responses
HTTP code Reponse body

200 - OK

OAuthClientAuthorization schema

201 - Created

OAuthClientAuthorization schema

202 - Accepted

OAuthClientAuthorization schema

401 - Unauthorized

Empty

/apis/oauth.openshift.io/v1/watch/oauthclientauthorizations

HTTP method

GET

Description

watch individual changes to a list of OAuthClientAuthorization. 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/oauthclientauthorizations/{name}

Table 8. Global path parameters
Parameter Type Description

name

string

name of the OAuthClientAuthorization

HTTP method

DELETE

Description

delete an OAuthClientAuthorization

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 schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified OAuthClientAuthorization

Table 11. HTTP responses
HTTP code Reponse body

200 - OK

OAuthClientAuthorization schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified OAuthClientAuthorization

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

OAuthClientAuthorization schema

201 - Created

OAuthClientAuthorization schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified OAuthClientAuthorization

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

OAuthClientAuthorization schema

Table 16. HTTP responses
HTTP code Reponse body

200 - OK

OAuthClientAuthorization schema

201 - Created

OAuthClientAuthorization schema

401 - Unauthorized

Empty

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

Table 17. Global path parameters
Parameter Type Description

name

string

name of the OAuthClientAuthorization

HTTP method

GET

Description

watch changes to an object of kind OAuthClientAuthorization. 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