Ce contenu n'est pas disponible dans la langue sélectionnée.

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_v2`
`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
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`pretty`	`string`	If 'true', then the output is pretty printed.

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

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

HTTP method: DELETE
Description: delete an UserIdentityMapping

Table 4.6. 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
`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 4.7. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions` schema

Table 4.8. 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.9. HTTP responses
HTTP code	Reponse body
200 - OK	`UserIdentityMapping` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update 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
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`force`	`boolean`	Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Table 4.11. Body parameters
Parameter	Type	Description
`body`	`Patch` schema

Table 4.12. 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.13. 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
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 4.14. Body parameters
Parameter	Type	Description
`body`	`UserIdentityMapping` schema

Table 4.15. HTTP responses
HTTP code	Reponse body
200 - OK	`UserIdentityMapping` schema
201 - Created	`UserIdentityMapping` schema
401 - Unauthorized	Empty

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez leBlog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

© 2024 Red Hat, Inc.