Identity [<strong>user</strong>.openshift.io/v1] - <strong>user</strong>.openshift.io | API reference

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

Description

Identity records a successful authentication of a user with an identity provider. The information about the source of authentication is stored on the identity, and the identity is then associated with a single user object. Multiple identities can reference a single user. Information retrieved from the authentication provider is stored in the extra field using a schema determined by the provider.

Type

object

Required

providerName
provideruserName
user

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
`.extra`	`object (string)`	Extra holds extra information about this 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.
`.providerName`	`string`	ProviderName is the source of identity information
`.provideruserName`	`string`	ProvideruserName uniquely represents this identity in the scope of the provider
`.user`	`ObjectReference core/v1`	user is a reference to the user this identity is associated with Both Name and UID must be set

.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

.extra

object (string)

Extra holds extra information about this 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.

.providerName

string

ProviderName is the source of identity information

.provideruserName

string

ProvideruserName uniquely represents this identity in the scope of the provider

.user

ObjectReference core/v1

user is a reference to the user this identity is associated with Both Name and UID must be set

API endpoints

The following API endpoints are available:

/apis/user.openshift.io/v1/identities
- DELETE: delete collection of Identity
- GET: list or watch objects of kind Identity
- POST: create an Identity
/apis/user.openshift.io/v1/identities/{name}
- DELETE: delete an Identity
- GET: read the specified Identity
- PATCH: partially update the specified Identity
- PUT: replace the specified Identity

/apis/user.openshift.io/v1/identities

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

HTTP method: DELETE
Description: delete collection of Identity

Table 2. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

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

HTTP method: GET
Description: list or watch objects of kind Identity

Table 4. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

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

HTTP method: POST
Description: create an Identity

Table 6. Body parameters
Parameter	Type	Description
`body`	`Identity user.openshift.io/v1`

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

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

Table 8. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Identity

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

HTTP method: DELETE
Description: delete an Identity

Table 10. 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 11. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

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

HTTP method: GET
Description: read the specified Identity

Table 13. Query parameters
Parameter	Type	Description
`exact`	`boolean`	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
`export`	`boolean`	Should this value be exported. Export strips fields that a user can not specify.

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

HTTP method: PATCH
Description: partially update the specified Identity

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

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

HTTP method: PUT
Description: replace the specified Identity

Table 17. Body parameters
Parameter	Type	Description
`body`	`Identity user.openshift.io/v1`

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

Identity [user.openshift.io/v1]

Specification

API endpoints

/apis/user.openshift.io/v1/identities

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