UserIdentityMapping [user.openshift.io/v1]

    UserIdentityMapping maps a user to an identity

    Type

    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}

      • GET: read the specified UserIdentityMapping

      • PATCH: partially update the specified UserIdentityMapping

      • PUT: replace the specified UserIdentityMapping

    Table 1. Global query parameters
    ParameterTypeDescription

    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

    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 .

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    Description

    create an UserIdentityMapping

    Table 2. Body parameters
    ParameterTypeDescription

    body

    UserIdentityMapping user.openshift.io/v1

    Table 3. HTTP responses
    HTTP codeReponse body

    200 - OK

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

    Table 4. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the UserIdentityMapping

    HTTP method

    DELETE

    Description

    delete an UserIdentityMapping

    Table 6. Query parameters
    ParameterTypeDescription

    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 7. Body parameters
    ParameterTypeDescription

    body

    Table 8. HTTP responses
    HTTP codeReponse body

    200 - OK

    Status meta/v1

    HTTP method

    GET

    read the specified UserIdentityMapping

    Table 9. HTTP responses
    HTTP codeReponse body

    200 - OK

    HTTP method

    PATCH

    Description

    partially update the specified UserIdentityMapping

    Table 11. Body parameters
    ParameterTypeDescription

    body

    Patch meta/v1

    Table 12. HTTP responses
    HTTP codeReponse body

    200 - OK

    HTTP method

    PUT

    Description

    replace the specified UserIdentityMapping

    Table 13. Query parameters
    ParameterTypeDescription

    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 14. Body parameters
    ParameterTypeDescription

    body