POST /apis/oauth.openshift.io/v1/oauthclients HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "OAuthClient",
"apiVersion": "oauth.openshift.io/v1",
...
}
×
v1.OAuthClient
Object Schema
Expand or mouse-over a field for more information about it.
accessTokenMaxAgeSeconds:additionalSecrets:
- [string]:apiVersion:grantMethod:kind:metadata:
annotations:
[string]:clusterName:creationTimestamp:deletionGracePeriodSeconds:deletionTimestamp:finalizers:
- [string]:generateName:generation:initializers:
pending:
- name:result:
apiVersion:code:details:
causes:
- field:message:reason:group:kind:name:retryAfterSeconds:uid:kind:message:metadata:
resourceVersion:selfLink:reason:status:labels:
[string]:name:namespace:ownerReferences:
- apiVersion:blockOwnerDeletion:controller:kind:name:uid:resourceVersion:selfLink:uid:redirectURIs:
- [string]:respondWithChallenges:scopeRestrictions:
- clusterRole:
- allowEscalation:namespaces:
- [string]:roleNames:
- [string]:literals:
- [string]:secret:
Operations
Create a OAuthClient
Create an OAuthClient
HTTP request
Get a OAuthClient
Read the specified OAuthClient
HTTP request
GET /apis/oauth.openshift.io/v1/oauthclients/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/oauth.openshift.io/v1/oauthclients/$NAME
Get all OAuthClients
List or watch objects of kind OAuthClient
HTTP request
GET /apis/oauth.openshift.io/v1/oauthclients HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/oauth.openshift.io/v1/oauthclients
Query parameters
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch a OAuthClient
Watch changes to an object of kind OAuthClient
HTTP request
GET /apis/oauth.openshift.io/v1/watch/oauthclients/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/oauth.openshift.io/v1/watch/oauthclients/$NAME
Query parameters
| Parameter | Description |
|---|---|
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
pretty |
If 'true', then the output is pretty printed. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch all OAuthClients
Watch individual changes to a list of OAuthClient
HTTP request
GET /apis/oauth.openshift.io/v1/watch/oauthclients HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/oauth.openshift.io/v1/watch/oauthclients
Query parameters
| Parameter | Description |
|---|---|
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
pretty |
If 'true', then the output is pretty printed. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Update a OAuthClient
Replace the specified OAuthClient
HTTP request
PUT /apis/oauth.openshift.io/v1/oauthclients/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "OAuthClient",
"apiVersion": "oauth.openshift.io/v1",
...
}
Patch a OAuthClient
Partially update the specified OAuthClient
HTTP request
PATCH /apis/oauth.openshift.io/v1/oauthclients/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
...
}
Curl request
$ curl -k \
-X PATCH \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json-patch+json' \
https://$ENDPOINT/apis/oauth.openshift.io/v1/oauthclients/$NAME <<'EOF'
{
...
}
EOF
Delete a OAuthClient
Delete an OAuthClient
HTTP request
DELETE /apis/oauth.openshift.io/v1/oauthclients/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
...
}
Curl request
$ curl -k \
-X DELETE \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/oauth.openshift.io/v1/oauthclients/$NAME <<'EOF'
{
...
}
EOF
Query parameters
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
Delete all OAuthClients
Delete collection of OAuthClient
HTTP request
DELETE /apis/oauth.openshift.io/v1/oauthclients HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X DELETE \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/oauth.openshift.io/v1/oauthclients
Query parameters
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |