API Reference
Packages
iam.evroclabs.net/v1alpha3
Package v1alpha3 contains API Schema definitions for the iam v1alpha3 API group
Resource Types
- OrgPermissionSet
- OrgPermissionSetList
- PermissionSet
- PermissionSetList
- ResourceGroup
- ResourceGroupList
- ServiceAccount
- ServiceAccountList
OrgPermissionSet
OrgPermissionSet is the Schema for the organization permission sets API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | iam.evroclabs.net/v1alpha3 | ||
kind string | OrgPermissionSet | ||
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 | ||
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 | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec OrgPermissionSetSpec | |||
status OrgPermissionSetStatus |
OrgPermissionSetList
OrgPermissionSetList contains a list of OrgPermissionSets.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | iam.evroclabs.net/v1alpha3 | ||
kind string | OrgPermissionSetList | ||
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 | ||
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 | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items OrgPermissionSet array |
OrgPermissionSetSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
admin boolean | |||
subject Subject |
OrgPermissionSetStatus
OrgPermissionSetStatus defines the observed state of organization permission sets.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Conditions represents the state of the evroc PermissionSet over time. |
PermissionSet
PermissionSet is the Schema for the permission sets API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | iam.evroclabs.net/v1alpha3 | ||
kind string | PermissionSet | ||
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 | ||
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 | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec PermissionSetSpec | |||
status PermissionSetStatus |
PermissionSetList
PermissionSetList contains an list of PermissionSets.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | iam.evroclabs.net/v1alpha3 | ||
kind string | PermissionSetList | ||
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 | ||
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 | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items PermissionSet array |
PermissionSetSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
admin boolean | |||
subject Subject |
PermissionSetStatus
PermissionSetStatus defines the observed state of permission sets.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Conditions represents the state of the PermissionSet over time. |
ResourceGroup
ResourceGroup is the Schema for the resource group API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | iam.evroclabs.net/v1alpha3 | ||
kind string | ResourceGroup | ||
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 | ||
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 | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ResourceGroupSpec | |||
status ResourceGroupStatus |
ResourceGroupList
ResourceGroupList contains a list of resource groups.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | iam.evroclabs.net/v1alpha3 | ||
kind string | ResourceGroupList | ||
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 | ||
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 | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items ResourceGroup array |
ResourceGroupSpec
ResourceGroupSpec defines the desired state of resource group.
Appears in:
ResourceGroupStatus
ResourceGroupStatus defines the observed state of resource group.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Conditions represents the state of the ResourceGroup over time. Each condition follows the Kubernetes API conventions for a condition: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties Conditions ConditionsSet json:"conditions,omitempty" | ||
workspaceHash string | The KCP hash of the workspace that implements this ResourceGroup. | ||
fullPath string | The full path from the root of the organization down to the current ResourceGroup included. | ||
organization string | The ID of the organization this resource group is part of Deprecated: the Organization name is present as a label instead |
ServiceAccount
ServiceAccount is the Schema for the serviceaccounts API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | iam.evroclabs.net/v1alpha3 | ||
kind string | ServiceAccount | ||
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 | ||
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 | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ServiceAccountSpec | |||
status ServiceAccountStatus |
ServiceAccountList
ServiceAccountList contains a list of ServiceAccount.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | iam.evroclabs.net/v1alpha3 | ||
kind string | ServiceAccountList | ||
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 | ||
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 | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items ServiceAccount array |
ServiceAccountSpec
ServiceAccountSpec defines the desired state of ServiceAccount.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
s3CredsSecretName string | S3CredsSecretName contains the name of the secret that was created to connect to the S3 API |
ServiceAccountStatus
ServiceAccountStatus defines the observed state of ServiceAccount.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Conditions represents the state of the ServiceAccount over time. Each condition follows the Kubernetes API conventions for a condition: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties Conditions ConditionsSet json:"conditions,omitempty" |
Subject
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
user UserSubject | |||
type Type | Enum: [user] |
Type
Underlying type: string
Appears in:
| Field | Description |
|---|---|
user |
UserSubject
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
email string | Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]\{2,\}$ |