UserIdentityMapping [user.openshift.io/v1] - user.openshift.io | API reference

Important

Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.

Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us

Specification
API endpoints
- /apis/user.openshift.io/v1/useridentitymappings
- /apis/user.openshift.io/v1/useridentitymappings/{name}

Description: UserIdentityMapping maps a user to an identity
Type: object

Specification

Property Type Description

Property	Type	Description
`.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/api-conventions.md#resources
`.identity`	`ObjectReference core/v1`	Identity is a reference to an identity
`.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/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object’s metadata.
`.user`	`ObjectReference core/v1`	User is a reference to a user

.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/api-conventions.md#resources

.identity

ObjectReference core/v1

Identity is a reference to an identity

.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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata.

.user

ObjectReference core/v1

User is a reference to a user

API endpoints

The following API endpoints are available:

/apis/user.openshift.io/v1/useridentitymappings
- POST: create an UserIdentityMapping
/apis/user.openshift.io/v1/useridentitymappings/{name}
- DELETE: delete an UserIdentityMapping
- GET: read the specified UserIdentityMapping
- PATCH: partially update the specified UserIdentityMapping
- PUT: replace the specified UserIdentityMapping

/apis/user.openshift.io/v1/useridentitymappings

Table 1. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: POST
Description: create an UserIdentityMapping

Table 2. Body parameters
Parameter	Type	Description
`body`	`UserIdentityMapping user.openshift.io/v1`

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`UserIdentityMapping user.openshift.io/v1`
201 - Created	`UserIdentityMapping user.openshift.io/v1`
202 - Accepted	`UserIdentityMapping user.openshift.io/v1`
401 - Unauthorized	Empty

/apis/user.openshift.io/v1/useridentitymappings/{name}

Table 4. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the UserIdentityMapping

Table 5. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete an UserIdentityMapping

Table 6. Query parameters
Parameter	Type	Description
`gracePeriodSeconds`	`integer`	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`	`boolean`	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`	`string`	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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 7. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified UserIdentityMapping

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`UserIdentityMapping user.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified UserIdentityMapping

Table 10. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`UserIdentityMapping user.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified UserIdentityMapping

Table 12. Body parameters
Parameter	Type	Description
`body`	`UserIdentityMapping user.openshift.io/v1`

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`UserIdentityMapping user.openshift.io/v1`
201 - Created	`UserIdentityMapping user.openshift.io/v1`
401 - Unauthorized	Empty