User [auth.alauda.io/v1]

This API is installed only when the chart is deployed for the global cluster. It is not available on workload clusters.

描述: User is the Schema for the users API
类型: object

规格

属性	类型	描述
`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
`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`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	UserSpec defines the desired state of User
`status`	`object`	UserStatus defines the observed state of User

.spec

描述: UserSpec defines the desired state of User
类型: object
必填: connector_nameconnector_typeemailis_adminusername

属性	类型	描述
`account`	`string`
`connector_id`	`string`
`connector_name`	`string`
`connector_type`	`string`	INSERT ADDITIONAL SPEC FIELDS - desired state of cluster Important: Run "make" to regenerate code after modifying this file
`continuity_errors`	`integer`
`email`	`string`
`expired`	`object`	Expired ...
`groups`	`array`
`ids`	`array`
`is_admin`	`boolean`
`is_disabled`	`boolean`
`last_login_time`	`string`
`mail`	`string`
`mobile`	`string`
`old_password`	`string`
`password`	`string`
`state`	`string`	State is User's State
`username`	`string`
`valid`	`boolean`
`webhookType`	`string`
`webhookUrl`	`string`
`extra`	`object`	Extra contains additional arbitrary metadata for the user from third-party systems

.spec.expired

描述: Expired ...
类型: object
必填: beginend

属性	类型	描述
`begin`	`string`
`end`	`string`

.spec.groups

类型: array

.spec.groups[]

类型: string

.spec.ids

类型: array

.spec.ids[]

类型: object
必填: idtype

属性	类型	描述
`id`	`string`
`type`	`string`

.spec.extra

描述: Extra contains additional arbitrary metadata for the user from third-party systems
类型: object

.status

描述: UserStatus defines the observed state of User
类型: object

API 端点

可用的 API 端点如下：

/apis/auth.alauda.io/v1/users
- DELETE: delete collection of User
- GET: list objects of kind User
- POST: create a new User
/apis/auth.alauda.io/v1/users/{name}
- DELETE: delete the specified User
- GET: read the specified User
- PATCH: partially update the specified User
- PUT: replace the specified User
/apis/auth.alauda.io/v1/users/{name}/status
- GET: read status of the specified User
- PATCH: partially update status of the specified User
- PUT: replace status of the specified User

/apis/auth.alauda.io/v1/users

HTTP 方法: DELETE
描述: delete collection of User
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind User
HTTP 响应

HTTP 状态码	响应体
200 - OK	`UserList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new User

查询参数

参数	类型	描述
`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.

请求体参数

参数	类型	描述
`body`	`User` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`User` schema
201 - Created	`User` schema
202 - Accepted	`User` schema
401 - Unauthorized	Empty

/apis/auth.alauda.io/v1/users/{name}

HTTP 方法: DELETE
描述: delete the specified User

查询参数

参数	类型	描述
`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

HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified User
HTTP 响应

HTTP 状态码	响应体
200 - OK	`User` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified User

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`User` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified User

查询参数

参数	类型	描述
`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.

请求体参数

参数	类型	描述
`body`	`User` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`User` schema
201 - Created	`User` schema
401 - Unauthorized	Empty

/apis/auth.alauda.io/v1/users/{name}/status

HTTP 方法: GET
描述: read status of the specified User
HTTP 响应

HTTP 状态码	响应体
200 - OK	`User` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update status of the specified User

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`User` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace status of the specified User

查询参数

参数	类型	描述
`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.

请求体参数

参数	类型	描述
`body`	`User` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`User` schema
201 - Created	`User` schema
401 - Unauthorized	Empty

#User [auth.alauda.io/v1]

#规格

#.spec

#.spec.expired

#.spec.groups

#.spec.groups[]

#.spec.ids

#.spec.ids[]

#.spec.extra

#.status

API 端点#

/apis/auth.alauda.io/v1/users#

/apis/auth.alauda.io/v1/users/{name}#

/apis/auth.alauda.io/v1/users/{name}/status#

User [auth.alauda.io/v1]

规格

.spec

.spec.expired

.spec.groups

.spec.groups[]

.spec.ids

.spec.ids[]

.spec.extra

.status

API 端点

/apis/auth.alauda.io/v1/users

/apis/auth.alauda.io/v1/users/{name}

/apis/auth.alauda.io/v1/users/{name}/status