Skip to main content

Owned Access Key

Access keys let you authenticate with Loft API endpoints and Loft CLI in non-interactive environments such as from within CI/CD pipelines.

Example Owned Access Key​

An example Owned Access Key:

apiVersion: management.loft.sh/v1
kind: OwnedAccessKey
metadata:
  creationTimestamp: null
  name: my-access-key
spec:
  displayName: My Access Key
  ttl: 1728000
  type: User
  user: my-user
status: {}

Owned Access Key Reference​

kind required string pro​

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 required string pro​

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 required object pro​

name required string pro​

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

generateName required string pro​

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

namespace required string pro​

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid required string pro​

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

resourceVersion required string pro​

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

generation required integer pro​

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

creationTimestamp required object pro​

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionTimestamp required object pro​

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds required integer pro​

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

labels required object pro​

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

annotations required object pro​

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

ownerReferences required object[] pro​

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

apiVersion required string pro​

API version of the referent.

kind required string pro​

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name required string pro​

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

uid required string pro​

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

controller required boolean pro​

If true, this reference points to the managing controller.

blockOwnerDeletion required boolean pro​

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

finalizers required string[] pro​

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

managedFields required object[] pro​

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

manager required string pro​

Manager is an identifier of the workflow managing these fields.

operation required string pro​

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

apiVersion required string pro​

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

time required object pro​

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

fieldsType required string pro​

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

fieldsV1 required object pro​

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

subresource required string pro​

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

spec required object pro​

displayName required string pro​

The display name shown in the UI

description required string pro​

Description describes an app

user required string pro​

The user this access key refers to

team required string pro​

The team this access key refers to

subject required string pro​

Subject is a generic subject that can be used instead of user or team

groups required string[] pro​

Groups specifies extra groups to apply when using this access key

key required string pro​

The actual access key that will be used as a bearer token

disabled required boolean pro​

If this field is true, the access key is still allowed to exist, however will not work to access the api

ttl required integer pro​

The time to life for this access key

ttlAfterLastActivity required boolean pro​

If this is specified, the time to life for this access key will start after the lastActivity instead of creation timestamp

scope required object pro​

Scope defines the scope of the access key.

roles required object[] pro​

Roles is a set of managed permissions to apply to the access key.

role required string pro​

Role is the name of the role to apply to the access key scope.

projects required string[] pro​

Projects specifies the projects the access key should have access to.

virtualClusters required string[] pro​

VirtualClusters specifies the virtual clusters the access key is allowed to access.

projects required object[] pro​

Projects specifies the projects the access key should have access to.

project required string pro​

Project is the name of the project. You can specify * to select all projects.

spaces required object[] pro​

Spaces specifies the spaces the access key is allowed to access.

project required string pro​

Project is the name of the project.

space required string pro​

Space is the name of the space. You can specify * to select all spaces.

virtualClusters required object[] pro​

VirtualClusters specifies the virtual clusters the access key is allowed to access.

project required string pro​

Project is the name of the project.

virtualCluster required string pro​

VirtualCluster is the name of the virtual cluster to access. You can specify * to select all virtual clusters.

clusters required object[] pro​

Clusters specifies the project cluster the access key is allowed to access.

cluster required string pro​

Cluster is the name of the cluster to access. You can specify * to select all clusters.

rules required object[] pro​

DEPRECATED: Use Projects, Spaces and VirtualClusters instead Rules specifies the rules that should apply to the access key.

verbs required string[] pro​

The verbs that match this rule. An empty list implies every verb.

resources required object[] pro​

Resources that this rule matches. An empty list implies all kinds in all API groups.

group required string pro​

Group is the name of the API group that contains the resources. The empty string represents the core API group.

resources required string[] pro​

Resources is a list of resources this rule applies to.

For example: 'pods' matches pods. 'pods/log' matches the log subresource of pods. '' matches all resources and their subresources. 'pods/' matches all subresources of pods. '*/scale' matches all scale subresources.

If wildcard is present, the validation rule will ensure resources do not overlap with each other.

An empty list implies all resources and subresources in this API groups apply.

resourceNames required string[] pro​

ResourceNames is a list of resource instance names that the policy matches. Using this field requires Resources to be specified. An empty list implies that every instance of the resource is matched.

namespaces required string[] pro​

Namespaces that this rule matches. The empty string "" matches non-namespaced resources. An empty list implies every namespace.

nonResourceURLs required string[] pro​

NonResourceURLs is a set of URL paths that should be checked. s are allowed, but only as the full, final step in the path. Examples: "/metrics" - Log requests for apiserver metrics "/healthz" - Log all health checks

requestTargets required string[] pro​

RequestTargets is a list of request targets that are allowed. An empty list implies every request.

cluster required string pro​

Cluster that this rule matches. Only applies to cluster requests. If this is set, no requests for non cluster requests are allowed. An empty cluster means no restrictions will apply.

virtualClusters required object[] pro​

VirtualClusters that this rule matches. Only applies to virtual cluster requests. An empty list means no restrictions will apply.

name required string pro​

Name of the virtual cluster. Empty means all virtual clusters.

namespace required string pro​

Namespace of the virtual cluster. Empty means all namespaces.

allowLoftCli required boolean pro​

AllowLoftCLI allows certain read-only management requests to make sure loft cli works correctly with this specific access key.

Deprecated: Use the roles field instead

# Example:
roles:
  - role: loftCLI

type required string pro​

The type of an access key, which basically describes if the access key is user managed or managed by loft itself.

identity required object pro​

If available, contains information about the sso login data for this access key

userId required string pro​

The subject of the user

username required string pro​

The username

preferredUsername required string pro​

The preferred username / display name

email required string pro​

The user email

emailVerified required boolean pro​

If the user email was verified

groups required string[] pro​

The groups from the identity provider

connector required string pro​

Connector is the name of the connector this access key was created from

connectorData required string pro​

ConnectorData holds data used by the connector for subsequent requests after initial authentication, such as access tokens for upstream providers.

This data is never shared with end users, OAuth clients, or through the API.

identityRefresh required object pro​

The last time the identity was refreshed

oidcProvider required object pro​

If the token is a refresh token, contains information about it

clientId required string pro​

ClientId the token was generated for

nonce required string pro​

Nonce to use

redirectUri required string pro​

RedirectUri to use

scopes required string pro​

Scopes to use

parent required string pro​

DEPRECATED: do not use anymore Parent is used to share OIDC and external token information with multiple access keys. Since copying an OIDC refresh token would result in the other access keys becoming invalid after a refresh parent allows access keys to share that information.

The use case for this is primarily user generated access keys, which will have the users current access key as parent if it contains an OIDC token.

oidcLogin required object pro​

DEPRECATED: Use identity instead If available, contains information about the oidc login data for this access key

idToken required string pro​

The current id token that was created during login

accessToken required string pro​

The current access token that was created during login

refreshToken required string pro​

The current refresh token that was created during login

lastRefresh required object pro​

The last time the id token was refreshed

status required object pro​

lastActivity required object pro​

The last time this access key was used to access the api

Create: Owned Access Key​

You can either use curl or kubectl to create a new Owned Access Key.

Create a file object.yaml with the following contents:

apiVersion: management.loft.sh/v1
kind: OwnedAccessKey
metadata:
  creationTimestamp: null
  name: my-access-key
spec:
  displayName: My Access Key
  ttl: 1728000
  type: User
  user: my-user
status: {}

Then create the Owned Access Key my-access-key with:

kubectl create -f object.yaml

Update: Owned Access Key​

You can either use curl or kubectl to update Owned Access Keys.

Update Owned Access Key​

Run the following command to update Owned Access Key my-access-key:

kubectl edit ownedaccesskeys.management.loft.sh my-access-key

Then edit the object and upon save, kubectl will update the resource.

Patch Owned Access Key​

Patching a resource is useful if you want to generically exchange only a small portion of the object instead of retrieving the whole object first and then modifying it. To learn more about patches in Kubernetes, please take a look at the official docs.

Run the following kubectl command to add a new annotation my-annotation: my-value to the Owned Access Key my-access-key via a patch:

kubectl patch ownedaccesskeys.management.loft.sh my-access-key  \
        --type json \
        -p '[{"op": "add", "path": "/metadata/annotations/my-annotation", "value": "my-value"}]'

Delete: Owned Access Key​

You can either use curl or kubectl to delete Owned Access Keys.

Run the following command to delete Owned Access Key my-access-key:

kubectl delete ownedaccesskeys.management.loft.sh my-access-key