Skip to main content

Deletes the workload identity

DELETE 
/resources/cloudaccess.appvia.io/v2beta2/workspaces/:workspace/workloadidentities/:name

Deletes the workload identity

Request​

Path Parameters

    workspace stringrequired

    Workspace to use

    name stringrequired

    The name of the workload identity you wish to delete

Query Parameters

    dryRun string

    Set to 'All' to perform a server-side dry run of deleting this resource

    force string

    Set to 'true' to override read-only/ownership and skip certain validations

    owner string

    Use an explicit owner when deleting - this must match the owner used on create, if set

    cascade boolean

    If true then all objects owned by this object will be deleted too.

Responses​

Contains the workload identity definition

Schema

    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 is metadata that all persisted resources must have, which includes all objects users must create.

    annotations

    object

    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

    property name* string
    creationTimestamp string

    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

    deletionGracePeriodSeconds int64

    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.

    deletionTimestamp string

    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

    finalizers string[]

    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.

    generateName string

    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

    generation int64

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

    labels

    object

    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

    property name* string

    managedFields

    undefined[]

    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.

  • Array [

    • apiVersion string

    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.

    fieldsType string

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

    fieldsV1 string

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

    manager string

    Manager is an identifier of the workflow managing these fields.

    operation string

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

    subresource string

    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.

    time string

    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.

  • ]

    • name string

    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

    namespace string

    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

    ownerReferences

    undefined[]

    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.

  • Array [

    • apiVersion stringrequired

    API version of the referent.

    blockOwnerDeletion boolean

    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.

    controller boolean

    If true, this reference points to the managing controller.

    kind stringrequired

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

    name stringrequired

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

    uid stringrequired

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

  • ]

    • resourceVersion string

    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

    selfLink string

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

    uid string

    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

    spec

    WorkloadIdentitySpec defines the specification of a workload identity which should be provisioned

    cloud stringrequired

    Cloud defines which cloud provider this workload identity is for

    cloudAccessConfigRef

    required

    CloudAccessConfigRef defines which cloud access configuration to use to build this workload identity in

    name stringrequired
    namespace stringrequired
    cloudResourceName string

    CloudResourceName specifies the name of the workload identity in the cloudaccount Can be left blank so that the name is derived from the cluster name + resource name

    cluster

    required

    Cluster is a reference to the cluster which this workload identity will be used in.

    group stringrequired
    kind stringrequired
    name stringrequired
    namespace stringrequired
    version stringrequired

    clusterServiceAccount

    ClusterServiceAccount is the name and namespace of the service account which will use this identity in the target cluster. Required on AWS and GCP, optional (and unused) on Azure at this time.

    name stringrequired
    namespace stringrequired
    identityOnly boolean

    IdentityOnly will create an identity associated with a cluster with no specific permissions Must specify Role=None if this is true. In AWS:

    • An IAM role is created and associated with a specific Kubernetes service account
    • no inline or attached policies are managed (post creation of the IAM role)
    • It is a "user" responsibility to attach policies to the IAM role In Azure:
    • The user defined managed identity is created
    • No role definitions or role assignments are created
    • It is a "user" responsibility to create relevant role assignments

    providerDetails

    ProviderDetails provides additional fields which can be used for cloud-provider specific data needed to provision a workload identity.

    aws

    AWS holds parameters specific to AWS workload identities. Present only if type is AWS.

    customIAMPolicy object

    CustomIAMPolicy defines an additional dedicated IAM policy to create and bind to this workload identity.

    iamPolicies string[]

    IAMPolicies defines a list of (additional) IAM policies to bind to the workload identity role It is assumed that these will exist in the target AWS account for the cluster, therefore use either built-in AWS-managed policies or make sure that your process for managing policies in your accounts will always ensure these policies exist in any account this package may be deployed into. For AWS-managed policies, specify the full ARN (e.g. arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess) For self-managed policies, specify the ARN without an account ID (e.g. arn:aws:iam:::policy/myorg-policy-s3-write)

    azure

    Azure holds parameters specific to Azure workload identity. Present only if type is Azure.

    podSelector string

    PodSelector specifies the unique string that will be set on the Identity This allows AAD Pod Identity to find the pods that are associated with it. DEPRECATED: This is no longer used as AAD Pod Identity is deprecated.

    roleAssignments

    undefined[]

    RoleAssignments is a list of role assignments to create for the identity

  • Array [

    • roleDefinitionName stringrequired

    RoleDefinitionName is the name of the role definition to assign to the identity

    scope stringrequired

    Scope is the scope of the role assignment

  • ]

    • gcp

    GCP holds parameters specific to GCP workload identity. Present only if type is GCP.

    roleBindings

    undefined[]

    RoleBindings is a list of GCP role principal bindings to update for the identity A policy binding is a role and scope bound to the workload identity

  • Array [

    • role stringrequired

    Role is the name of the GCP role to bind to the identity

    scopeType stringrequired

    ScopeType is the API scope to bind the role to

  • ]

    • type stringrequired
    role string

    Role must be the name of a valid workload identity role known to Wayfinder Can optionally be None to indicate that no specific permissions are defined with the identity

    roleParameters

    object

    RoleParameters are any parameters required for the specified role

    property name* string

    status

    WorkloadIdentityStatus defines the status of a cloud account

    cloudResourcesCreated boolean

    conditions

    undefined[]

  • Array [

    • detail string
    lastTransitionTime stringrequired
    message string
    name stringrequired
    negativePolarity boolean
    observedGeneration int64
    reason stringrequired
    status stringrequired
    type stringrequired

  • ]

    • detail string
    identity string

    Identity contains a cloud-provider specific reference to the identity created for this resource, e.g. an AWS ARN or GCP service account email

    lastReconcile

    generation int64required
    time stringrequired

    lastSuccess

    generation int64required
    time stringrequired
    message string

    obsoleteResources

    undefined[]

  • Array [

    • kind stringrequired
    name stringrequired

  • ]

    • ownedResources

    cloudResources

    undefined[]

  • Array [

    • cloud string
    id string
    name string
    type string

  • ]

    • wayfinderResources

    undefined[]

  • Array [

    • kind string
    name string
    workspace string

  • ]

    • pendingSince

    generation int64required
    time stringrequired
    status stringrequired
    wayfinderVersion string
Loading...
Last updated