SupportoConsoleSviluppatoriInizia una provaContatti

Questo contenuto non è disponibile nella lingua selezionata.

Chapter 3. OAuthAuthorizeToken [oauth.openshift.io/v1]

Description

OAuthAuthorizeToken describes an OAuth authorization token

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
object

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

clientName

string

ClientName references the client that created this token.

codeChallenge

string

CodeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636

codeChallengeMethod

string

CodeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636

expiresIn

integer

ExpiresIn is the seconds from CreationTime before this token expires.

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.

scopes

array (string)

Scopes is an array of the requested scopes.

state

string

State data from request

userName

string

UserName is the user name associated with this token

userUID

string

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

3.2. API endpoints

The following API endpoints are available:

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

    • DELETE: delete collection of OAuthAuthorizeToken
    • GET: list or watch objects of kind OAuthAuthorizeToken
    • POST: create an OAuthAuthorizeToken

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

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

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

    • DELETE: delete an OAuthAuthorizeToken
    • GET: read the specified OAuthAuthorizeToken
    • PATCH: partially update the specified OAuthAuthorizeToken
    • PUT: replace the specified OAuthAuthorizeToken

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

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

3.2.1. /apis/oauth.openshift.io/v1/oauthauthorizetokens

HTTP method
DELETE
Description
delete collection of OAuthAuthorizeToken
Table 3.1. 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 3.2. HTTP responses
HTTP codeReponse body

200 - OK

Status_v6 schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list or watch objects of kind OAuthAuthorizeToken
Table 3.3. HTTP responses
HTTP codeReponse body

200 - OK

OAuthAuthorizeTokenList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create an OAuthAuthorizeToken
Table 3.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

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 3.5. Body parameters
ParameterTypeDescription

body

OAuthAuthorizeToken schema

 
Table 3.6. HTTP responses
HTTP codeReponse body

200 - OK

OAuthAuthorizeToken schema

201 - Created

OAuthAuthorizeToken schema

202 - Accepted

OAuthAuthorizeToken schema

401 - Unauthorized

Empty

3.2.2. /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens

HTTP method
GET
Description
watch individual changes to a list of OAuthAuthorizeToken. deprecated: use the 'watch' parameter with a list operation instead.
Table 3.7. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

3.2.3. /apis/oauth.openshift.io/v1/oauthauthorizetokens/{name}

Table 3.8. Global path parameters
ParameterTypeDescription

name

string

name of the OAuthAuthorizeToken

HTTP method
DELETE
Description
delete an OAuthAuthorizeToken
Table 3.9. 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 3.10. HTTP responses
HTTP codeReponse body

200 - OK

OAuthAuthorizeToken schema

202 - Accepted

OAuthAuthorizeToken schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified OAuthAuthorizeToken
Table 3.11. HTTP responses
HTTP codeReponse body

200 - OK

OAuthAuthorizeToken schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified OAuthAuthorizeToken
Table 3.12. 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

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 3.13. HTTP responses
HTTP codeReponse body

200 - OK

OAuthAuthorizeToken schema

201 - Created

OAuthAuthorizeToken schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified OAuthAuthorizeToken
Table 3.14. 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

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 3.15. Body parameters
ParameterTypeDescription

body

OAuthAuthorizeToken schema

 
Table 3.16. HTTP responses
HTTP codeReponse body

200 - OK

OAuthAuthorizeToken schema

201 - Created

OAuthAuthorizeToken schema

401 - Unauthorized

Empty

3.2.4. /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens/{name}

Table 3.17. Global path parameters
ParameterTypeDescription

name

string

name of the OAuthAuthorizeToken

HTTP method
GET
Description
watch changes to an object of kind OAuthAuthorizeToken. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
Table 3.18. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Formazione

Prova, acquista e vendi

Community

Informazioni sulla documentazione di Red Hat

Aiutiamo gli utenti Red Hat a innovarsi e raggiungere i propri obiettivi con i nostri prodotti e servizi grazie a contenuti di cui possono fidarsi.

Rendiamo l’open source più inclusivo

Red Hat si impegna a sostituire il linguaggio problematico nel codice, nella documentazione e nelle proprietà web. Per maggiori dettagli, visita ilBlog di Red Hat.

Informazioni su Red Hat

Forniamo soluzioni consolidate che rendono più semplice per le aziende lavorare su piattaforme e ambienti diversi, dal datacenter centrale all'edge della rete.

© 2024 Red Hat, Inc.