Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
    2. history
×

v1.UserIdentityMapping

Description

UserIdentityMapping maps a user to an identity

Object Schema

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

apiVersion:

identity:

  apiVersion:

  fieldPath:

  kind:

  name:

  namespace:

  resourceVersion:

  uid:

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:

user:

  apiVersion:

  fieldPath:

  kind:

  name:

  namespace:

  resourceVersion:

  uid:

Operations

Create a UserIdentityMapping

Create an UserIdentityMapping

HTTP request

POST /apis/user.openshift.io/v1/useridentitymappings HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "UserIdentityMapping",
  "apiVersion": "user.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/user.openshift.io/v1/useridentitymappings <<'EOF'
{
  "kind": "UserIdentityMapping",
  "apiVersion": "user.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.UserIdentityMapping

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.UserIdentityMapping

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get a UserIdentityMapping

Read the specified UserIdentityMapping

HTTP request

GET /apis/user.openshift.io/v1/useridentitymappings/$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/user.openshift.io/v1/useridentitymappings/$NAME

Path parameters

Parameter Description

name

name of the UserIdentityMapping

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.UserIdentityMapping

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Update a UserIdentityMapping

Replace the specified UserIdentityMapping

HTTP request

PUT /apis/user.openshift.io/v1/useridentitymappings/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "UserIdentityMapping",
  "apiVersion": "user.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/user.openshift.io/v1/useridentitymappings/$NAME <<'EOF'
{
  "kind": "UserIdentityMapping",
  "apiVersion": "user.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.UserIdentityMapping

Path parameters

Parameter Description

name

name of the UserIdentityMapping

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.UserIdentityMapping

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch a UserIdentityMapping

Partially update the specified UserIdentityMapping

HTTP request

PATCH /apis/user.openshift.io/v1/useridentitymappings/$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/user.openshift.io/v1/useridentitymappings/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the UserIdentityMapping

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.UserIdentityMapping

401 Unauthorized

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 UserIdentityMapping

Delete an UserIdentityMapping

HTTP request

DELETE /apis/user.openshift.io/v1/useridentitymappings/$NAME 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/user.openshift.io/v1/useridentitymappings/$NAME

Path parameters

Parameter Description

name

name of the UserIdentityMapping

Query parameters

Parameter Description

pretty

If 'true', then the output is pretty printed.

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf