v1.OAuthClient

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

Description

OAuthClient describes an OAuth client

Object Schema

Expand or mouse-over a field for more information about it.

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

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",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/oauth.openshift.io/v1/oauthclients <<'EOF'
{
  "kind": "OAuthClient",
  "apiVersion": "oauth.openshift.io/v1",
  ...
}
EOF

HTTP body

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

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

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

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

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

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

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

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

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

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",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/oauth.openshift.io/v1/oauthclients/$NAME <<'EOF'
{
  "kind": "OAuthClient",
  "apiVersion": "oauth.openshift.io/v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

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

HTTP body

Path parameters

Query parameters

Responses

Consumes

• application/json-patch+json

• application/merge-patch+json

• application/strategic-merge-patch+json

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

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

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

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

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf