Skip to main content

UserOAuthAccessToken [oauth.openshift.io/v1]

Description
UserOAuthAccessToken is a virtual resource to mirror OAuthAccessTokens to the user the access token was issued for
Type
`object`

Specification​

PropertyTypeDescription
apiVersionstringAPIVersion 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
authorizeTokenstringauthorizeToken contains the token that authorized this token
clientNamestringclientName references the client that created this token.
expiresInintegerexpiresIn is the seconds from CreationTime before this token expires.
inactivityTimeoutSecondsintegerinactivityTimeoutSeconds 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.
kindstringKind 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
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
redirectURIstringredirectURI is the redirection associated with the token.
refreshTokenstringrefreshToken is the value by which this token can be renewed. Can be blank.
scopesarray (string)scopes is an array of the requested scopes.
userNamestringuserName is the user name associated with this token
userUIDstringuserUID is the unique UID associated with this token

API endpoints​

The following API endpoints are available:

  • /apis/oauth.openshift.io/v1/useroauthaccesstokens
    • GET: list or watch objects of kind UserOAuthAccessToken
  • /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens
    • GET: watch individual changes to a list of UserOAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead.
  • /apis/oauth.openshift.io/v1/useroauthaccesstokens/{name}
    • DELETE: delete an UserOAuthAccessToken
    • GET: read the specified UserOAuthAccessToken
  • /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens/{name}
    • GET: watch changes to an object of kind UserOAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

/apis/oauth.openshift.io/v1/useroauthaccesstokens​

HTTP method
`GET`
Description
list or watch objects of kind UserOAuthAccessToken

HTTP responses

HTTP codeReponse body
200 - OKUserOAuthAccessTokenList schema
401 - UnauthorizedEmpty

/apis/oauth.openshift.io/v1/watch/useroauthaccesstokens​

HTTP method
`GET`
Description
watch individual changes to a list of UserOAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead.

HTTP responses

HTTP codeReponse body
200 - OKWatchEvent schema
401 - UnauthorizedEmpty

/apis/oauth.openshift.io/v1/useroauthaccesstokens/{name}​

Global path parameters

ParameterTypeDescription
namestringname of the UserOAuthAccessToken
HTTP method
`DELETE`
Description
delete an UserOAuthAccessToken

Query parameters

ParameterTypeDescription
dryRunstringWhen 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

HTTP responses

HTTP codeReponse body
200 - OKStatus_v2 schema
202 - AcceptedStatus_v2 schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
read the specified UserOAuthAccessToken

HTTP responses

HTTP codeReponse body
200 - OKUserOAuthAccessToken schema
401 - UnauthorizedEmpty

/apis/oauth.openshift.io/v1/watch/useroauthaccesstokens/{name}​

Global path parameters

ParameterTypeDescription
namestringname of the UserOAuthAccessToken
HTTP method
`GET`
Description
watch changes to an object of kind UserOAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

HTTP responses

HTTP codeReponse body
200 - OKWatchEvent schema
401 - UnauthorizedEmpty