Alauda Container Platform

UserBinding [auth.alauda.io/v1]

Description
UserBinding is the Schema for the userbindings API
Type
object

Specification

PropertyTypeDescription
apiVersionstring

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

kindstring

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

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

UserBindingSpec defines the desired state of UserBinding

statusobject

UserBindingStatus defines the observed state of UserBinding

.spec

Description
UserBindingSpec defines the desired state of UserBinding
Type
object
PropertyTypeDescription
constraintarray
roleRefstring
scopestring
subjectsarray

.spec.constraint

Type
array

.spec.constraint[]

Type
object
PropertyTypeDescription
clusterstring
namespacestring
projectstring

.spec.subjects

Type
array

.spec.subjects[]

Type
object
Required
kindname
PropertyTypeDescription
kindstring
namestring

.status

Description
UserBindingStatus defines the observed state of UserBinding
Type
object
PropertyTypeDescription
bindingsCreatedobject

BindingsCreated records the count of created bindings

conditionsarray
failedClustersarray

FailedClusters lists clusters that failed to sync (global cluster only)

failureDetailsobject

FailureDetails contains detailed error information for troubleshooting

lastReconcileTimestring

LastReconcileTime records the last successful reconcile time Used to detect if reconciliation is stuck

lastSpecHashstring
nextRetryTimestring

NextRetryTime indicates when the next retry will be attempted

observedGenerationinteger

ObservedGeneration records the last processed Generation Used to determine if status is stale

phasestring
retryCountinteger

RetryCount tracks the number of retry attempts

syncedClustersarray

SyncedClusters lists successfully synced clusters (global cluster only)

.status.bindingsCreated

Description
BindingsCreated records the count of created bindings
Type
object
PropertyTypeDescription
clusterRoleBindingsinteger

ClusterRoleBindings count of created ClusterRoleBindings

roleBindingsinteger

RoleBindings count of created RoleBindings

.status.conditions

Type
array

.status.conditions[]

Type
object
PropertyTypeDescription
lastTransitionTimestring
messagestring
reasonstring
statusstring
typestring

.status.failedClusters

Description
FailedClusters lists clusters that failed to sync (global cluster only)
Type
array

.status.failedClusters[]

Type
string

.status.failureDetails

Description
FailureDetails contains detailed error information for troubleshooting
Type
object
PropertyTypeDescription
affectedItemsarray

AffectedItems lists the specific resources that failed

failureMessagestring

FailureMessage is a human-readable detailed error message

failureReasonstring

FailureReason is a short, machine-readable reason for the failure

lastFailureTimestring

LastFailureTime records when the last failure occurred

.status.failureDetails.affectedItems

Description
AffectedItems lists the specific resources that failed
Type
array

.status.failureDetails.affectedItems[]

Description
AffectedItem represents a specific resource that failed during reconciliation
Type
object
PropertyTypeDescription
errorstring

Error is the specific error message for this item

namestring

Name is the name of the affected resource

namespacestring

Namespace is the namespace of the resource (for RoleBinding)

typestring

Type is the resource type (ClusterRoleBinding, RoleBinding, etc.)

.status.syncedClusters

Description
SyncedClusters lists successfully synced clusters (global cluster only)
Type
array

.status.syncedClusters[]

Type
string

API Endpoints

The following API endpoints are available:

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

/apis/auth.alauda.io/v1/userbindings

HTTP method
DELETE
Description
delete collection of UserBinding
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind UserBinding
HTTP responses
HTTP codeResponse body
200 - OKUserBindingList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new UserBinding
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 parameters
ParameterTypeDescription
bodyUserBinding schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKUserBinding schema
201 - CreatedUserBinding schema
202 - AcceptedUserBinding schema
401 - UnauthorizedEmpty

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

HTTP method
DELETE
Description
delete the specified UserBinding
Query parameters
ParameterTypeDescription
dryRunstringWhen 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 responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified UserBinding
HTTP responses
HTTP codeResponse body
200 - OKUserBinding schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified UserBinding
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 responses
HTTP codeResponse body
200 - OKUserBinding schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified UserBinding
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 parameters
ParameterTypeDescription
bodyUserBinding schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKUserBinding schema
201 - CreatedUserBinding schema
401 - UnauthorizedEmpty

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

HTTP method
GET
Description
read status of the specified UserBinding
HTTP responses
HTTP codeResponse body
200 - OKUserBinding schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified UserBinding
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 responses
HTTP codeResponse body
200 - OKUserBinding schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified UserBinding
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 parameters
ParameterTypeDescription
bodyUserBinding schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKUserBinding schema
201 - CreatedUserBinding schema
401 - UnauthorizedEmpty