Creates a new workload identity

Creates a new workload identity

Path Parameters

workspace stringrequired

Workspace to use

Query Parameters

dryRun string

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

owner string

Set an explicit owner for this resource

application/json

Request Body required

The specification for the workload identity you are creating

apiVersion string
kind string
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: http://kubernetes.io/docs/user-guide/annotations
property name* string
clusterName string
creationTimestamp string
deletionGracePeriodSeconds int64
deletionTimestamp string
finalizers string[]
generateName string
generation int64
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: http://kubernetes.io/docs/user-guide/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.
apiVersion string
fieldsType string
fieldsV1 string
manager string
operation string
subresource string
time string
name string
namespace string
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.
apiVersion stringrequired
blockOwnerDeletion boolean
controller boolean
kind stringrequired
name stringrequired
uid stringrequired
resourceVersion string
selfLink string
uid string
spec
WorkloadIdentitySpec defines the specification of a workload identity which should be provisioned
cloud stringrequired
cloudAccessConfigRef required
CloudAccessConfigRef defines which cloud access configuration to use to build this workload identity in
name stringrequired
namespace stringrequired
cloudResourceName string
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 represents the identity inside the cluster that will use the workload identity
name stringrequired
namespace stringrequired
identityOnly boolean
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
iamPolicies string[]
azure
Azure holds parameters specific to Azure workload identity. Present only if type is Azure.
podSelector string
gcp
type stringrequired
role stringrequired
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[]
detail string
lastTransitionTime stringrequired
message string
name stringrequired
negativePolarity boolean
observedGeneration int64
reason stringrequired
status stringrequired
type stringrequired
detail string
identity string
lastReconcile
generation int64required
time stringrequired
lastSuccess
generation int64required
time stringrequired
message string
obsoleteResources undefined[]
kind stringrequired
name stringrequired
status stringrequired
wayfinderVersion string

Responses

200

Contains the workload identity definition

application/json

Schema

Schema

apiVersion string
kind string
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: http://kubernetes.io/docs/user-guide/annotations
property name* string
clusterName string
creationTimestamp string
deletionGracePeriodSeconds int64
deletionTimestamp string
finalizers string[]
generateName string
generation int64
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: http://kubernetes.io/docs/user-guide/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.
apiVersion string
fieldsType string
fieldsV1 string
manager string
operation string
subresource string
time string
name string
namespace string
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.
apiVersion string
blockOwnerDeletion boolean
controller boolean
kind string
name string
uid string
resourceVersion string
selfLink string
uid string
spec
WorkloadIdentitySpec defines the specification of a workload identity which should be provisioned
cloud string
cloudAccessConfigRef
CloudAccessConfigRef defines which cloud access configuration to use to build this workload identity in
name string
namespace string
cloudResourceName string
cluster
Cluster is a reference to the cluster which this workload identity will be used in.
group string
kind string
name string
namespace string
version string
clusterServiceAccount
ClusterServiceAccount represents the identity inside the cluster that will use the workload identity
name string
namespace string
identityOnly boolean
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
iamPolicies string[]
azure
Azure holds parameters specific to Azure workload identity. Present only if type is Azure.
podSelector string
gcp
type string
role string
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[]
detail string
lastTransitionTime string
message string
name string
negativePolarity boolean
observedGeneration int64
reason string
status string
type string
detail string
identity string
lastReconcile
generation int64
time string
lastSuccess
generation int64
time string
message string
obsoleteResources undefined[]
kind string
name string
status string
wayfinderVersion string

Example (from schema)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": {},
    "clusterName": "string",
    "creationTimestamp": "string",
    "deletionGracePeriodSeconds": 0,
    "deletionTimestamp": "string",
    "finalizers": [
      "string"
    ],
    "generateName": "string",
    "generation": 0,
    "labels": {},
    "managedFields": [
      {
        "apiVersion": "string",
        "fieldsType": "string",
        "fieldsV1": "string",
        "manager": "string",
        "operation": "string",
        "subresource": "string",
        "time": "string"
      }
    ],
    "name": "string",
    "namespace": "string",
    "ownerReferences": [
      {
        "apiVersion": "string",
        "blockOwnerDeletion": true,
        "controller": true,
        "kind": "string",
        "name": "string",
        "uid": "string"
      }
    ],
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "cloud": "string",
    "cloudAccessConfigRef": {
      "name": "string",
      "namespace": "string"
    },
    "cloudResourceName": "string",
    "cluster": {
      "group": "string",
      "kind": "string",
      "name": "string",
      "namespace": "string",
      "version": "string"
    },
    "clusterServiceAccount": {
      "name": "string",
      "namespace": "string"
    },
    "identityOnly": true,
    "providerDetails": {
      "aws": {
        "customIAMPolicy": {},
        "iamPolicies": [
          "string"
        ]
      },
      "azure": {
        "podSelector": "string"
      },
      "type": "string"
    },
    "role": "string",
    "roleParameters": {}
  },
  "status": {
    "cloudResourcesCreated": true,
    "conditions": [
      {
        "detail": "string",
        "lastTransitionTime": "string",
        "message": "string",
        "name": "string",
        "negativePolarity": true,
        "observedGeneration": 0,
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "detail": "string",
    "identity": "string",
    "lastReconcile": {
      "generation": 0,
      "time": "string"
    },
    "lastSuccess": {
      "generation": 0,
      "time": "string"
    },
    "message": "string",
    "obsoleteResources": [
      {
        "kind": "string",
        "name": "string"
      }
    ],
    "status": "string",
    "wayfinderVersion": "string"
  }
}

400

Validation error of supplied parameters/body

application/json

Schema

Schema

code int32
fieldErrors undefined[]
errCode string
field string
message string
message string

Example (from schema)

{
  "code": 0,
  "fieldErrors": [
    {
      "errCode": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "message": "string"
}

401

If not authenticated

403

If authenticated but not authorized

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32
detail string
message string
uri string
verb string

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...