Search

Chapter 6. UserOAuthAccessToken [oauth.openshift.io/v1]

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

6.1. Specification

PropertyTypeDescription

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

6.2. 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.

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

HTTP method
GET
Description
list or watch objects of kind UserOAuthAccessToken
Table 6.1. HTTP responses
HTTP codeReponse body

200 - OK

UserOAuthAccessTokenList schema

401 - Unauthorized

Empty

6.2.2. /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.
Table 6.2. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

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

Table 6.3. Global path parameters
ParameterTypeDescription

name

string

name of the UserOAuthAccessToken

HTTP method
DELETE
Description
delete an UserOAuthAccessToken
Table 6.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

Table 6.5. 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 UserOAuthAccessToken
Table 6.6. HTTP responses
HTTP codeReponse body

200 - OK

UserOAuthAccessToken schema

401 - Unauthorized

Empty

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

Table 6.7. Global path parameters
ParameterTypeDescription

name

string

name 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.
Table 6.8. 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.