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

Specification
API endpoints

Description: OAuthAccessToken describes an OAuth access token. The name of a token must be prefixed with a sha256~ string, must not contain "/" or "%" characters and must be at least 32 characters long.

The name of the token is constructed from the actual token by sha256-hashing it and using URL-safe unpadded base64-encoding (as described in RFC4648) on the hashed result.

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
`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
`authorizeToken`	`string`	AuthorizeToken contains the token that authorized this token
`clientName`	`string`	ClientName references the client that created this token.
`expiresIn`	`integer`	ExpiresIn is the seconds from CreationTime before this token expires.
`inactivityTimeoutSeconds`	`integer`	InactivityTimeoutSeconds is the value in seconds, from the CreationTimestamp, after which this token can no longer be used. The value is automatically incremented when the token is used.
`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
`redirectURI`	`string`	RedirectURI is the redirection associated with the token.
`refreshToken`	`string`	RefreshToken is the value by which this token can be renewed. Can be blank.
`scopes`	`array (string)`	Scopes is an array of the requested scopes.
`userName`	`string`	UserName is the user name associated with this token
`userUID`	`string`	UserUID is the unique UID associated with this token

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

authorizeToken

string

AuthorizeToken contains the token that authorized this token

clientName

string

ClientName references the client that created this token.

expiresIn

integer

ExpiresIn is the seconds from CreationTime before this token expires.

inactivityTimeoutSeconds

integer

InactivityTimeoutSeconds is the value in seconds, from the CreationTimestamp, after which this token can no longer be used. The value is automatically incremented when the token is used.

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

redirectURI

string

RedirectURI is the redirection associated with the token.

refreshToken

string

RefreshToken is the value by which this token can be renewed. Can be blank.

scopes

array (string)

Scopes is an array of the requested scopes.

userName

string

UserName is the user name associated with this token

userUID

string

UserUID is the unique UID associated with this token

API endpoints

The following API endpoints are available:

/apis/oauth.openshift.io/v1/oauthaccesstokens
- DELETE: delete collection of OAuthAccessToken
- GET: list or watch objects of kind OAuthAccessToken
- POST: create an OAuthAccessToken
/apis/oauth.openshift.io/v1/watch/oauthaccesstokens
- GET: watch individual changes to a list of OAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead.
/apis/oauth.openshift.io/v1/oauthaccesstokens/{name}
- DELETE: delete an OAuthAccessToken
- GET: read the specified OAuthAccessToken
- PATCH: partially update the specified OAuthAccessToken
- PUT: replace the specified OAuthAccessToken
/apis/oauth.openshift.io/v1/watch/oauthaccesstokens/{name}
- GET: watch changes to an object of kind OAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

/apis/oauth.openshift.io/v1/oauthaccesstokens

HTTP method: DELETE
Description: delete collection of OAuthAccessToken

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 OAuthAccessToken

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

HTTP method: POST
Description: create an OAuthAccessToken

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`	`OAuthAccessToken` schema

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

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

HTTP method: GET
Description: watch individual changes to a list of OAuthAccessToken. 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/oauthaccesstokens/{name}

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

HTTP method: DELETE
Description: delete an OAuthAccessToken

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	`OAuthAccessToken` schema
202 - Accepted	`OAuthAccessToken` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified OAuthAccessToken

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

HTTP method: PATCH
Description: partially update the specified OAuthAccessToken

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	`OAuthAccessToken` schema
201 - Created	`OAuthAccessToken` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified OAuthAccessToken

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`	`OAuthAccessToken` schema

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

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

Table 17. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the OAuthAccessToken

HTTP method: GET
Description: watch changes to an object of kind OAuthAccessToken. 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