Chapter 4. UserIdentityMapping [user.openshift.io/v1]
Chapter 4. UserIdentityMapping [user.openshift.io/v1] Description UserIdentityMapping maps a user to an identity Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). Type object 4.1. Specification 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/sig-architecture/api-conventions.md#resources identity ObjectReference 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/sig-architecture/api-conventions.md#types-kinds metadata ObjectMeta metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata user ObjectReference User is a reference to a user 4.2. 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 4.2.1. /apis/user.openshift.io/v1/useridentitymappings Table 4.1. Global query parameters Parameter Type Description 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. HTTP method POST Description create an UserIdentityMapping Table 4.2. Body parameters Parameter Type Description body UserIdentityMapping schema Table 4.3. HTTP responses HTTP code Reponse body 200 - OK UserIdentityMapping schema 201 - Created UserIdentityMapping schema 202 - Accepted UserIdentityMapping schema 401 - Unauthorized Empty 4.2.2. /apis/user.openshift.io/v1/useridentitymappings/{name} Table 4.4. Global path parameters Parameter Type Description name string name of the UserIdentityMapping HTTP method DELETE Description delete an UserIdentityMapping Table 4.5. Query parameters Parameter Type Description 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 4.6. HTTP responses HTTP code Reponse body 200 - OK Status schema 202 - Accepted Status schema 401 - Unauthorized Empty HTTP method GET Description read the specified UserIdentityMapping Table 4.7. HTTP responses HTTP code Reponse body 200 - OK UserIdentityMapping schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified UserIdentityMapping Table 4.8. Query parameters Parameter Type Description 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 4.9. HTTP responses HTTP code Reponse body 200 - OK UserIdentityMapping schema 201 - Created UserIdentityMapping schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified UserIdentityMapping Table 4.10. Query parameters Parameter Type Description 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 4.11. Body parameters Parameter Type Description body UserIdentityMapping schema Table 4.12. HTTP responses HTTP code Reponse body 200 - OK UserIdentityMapping schema 201 - Created UserIdentityMapping schema 401 - Unauthorized Empty