Returns a specific cloud access check
GET/resources/cloudaccess.appvia.io/v2beta2/workspaces/:workspace/cloudaccesschecks/:name
Returns a specific cloud access check
Request
Path Parameters
Workspace to use
The name of the cloud access check you wish to retrieve
Responses
- 200
- 401
- 403
- 404
- 500
Contains the cloud access check definition
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
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 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
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
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 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
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 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
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
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 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 is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
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 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 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 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 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.
API version of the referent.
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.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
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
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
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
aws
AWS provides the details for an AWS account. Only one of AWS, GCP or Azure can be populated.
Account is the AWS account to use.
DefaultRegion is an optional default region to use for API access in this account when no region is specified for the operation. This is used to determine, for example, which region to use to talk to global services such as Route53 in AWS. E.g. eu-west-2
azure
Azure provides the details for an Azure subscription. Only one of AWS, GCP or Azure can be populated.
ClientID is an optional client ID to use to perform the actions in this cloud access config when federating from AWS or GCP. This field can only be provided when the Cloud Identity in use is not an Azure cloud identity. Must be a lowercase UUID
Subscription is the identifier for the subscription to use. Must be a lowercase UUID
TenantID is the identifier for the tenant in which this subscription lives. Must be a lowercase UUID
Cloud defines which cloud provider this credential is for
cloudIdentity
CloudIdentity defines the proposed cloud identity credentials
aws
AWS is the cloud-specific settings for this cloud identity for AWS
RoleARN is the IAM role being used when type is AWSIAMRoleForServiceAccount. If provided, will be used to validate on usage that Wayfinder is in the expected role.
UserARN is the IAM user being used when type is AWSIAMUserKey. If provided, will be used to validate on usage that Wayfinder is in the expected user.
azure
Azure is the cloud-specific settings for this cloud identity for Azure
ClientID is the client ID that this Azure identity references. If provided, will be used to validate on usage that Wayfinder is using the expected client ID.
TenantID is the tenant in which this Azure identity resides.
Cloud defines which cloud provider this credential is for
credentialsInputData
object
CredentialsInputData can be used to populate the secret when creating/updating a credential. This will never be populated when the credential is returned from the API.
If specified, this must include the correct set of keys for credentials for the cloud provider that CloudAccount references.
CredentialsUpdated should be set to the current time when an underlying secret is updated. This will be automatically set to the current time if CredentialsInputData is set. If you manually change the secret outside Wayfinder, update this field to trigger re-verification of this credential.
gcp
GCP is the cloud-specific settings for this cloud identity for GCP
ServiceAccount is the GCP service account email that this GCP identity references. If provided, will be used to validate on usage that Wayfinder is using the expected service account.
secretRef
SecretRef is a reference to the Kubernetes secret containing the actual key data for this credential. If the secret does not exist but CredentialsInputData is populated, this secret will be created. This can also be a reference to an existing secret managed outside Wayfinder.
Where CredentialsInputData is specified but this is left blank, Wayfinder will assign this value.
name is unique within a namespace to reference a secret resource.
namespace defines the space within which the secret name must be unique.
Type is the identity type in cloud that this represents
cloudIdentityRef
CloudIdentityRef is a reference to the credential for Wayfinder to identify itself to this cloud provider to validate this configuration.
Cloud that this cloud identity references.
Name for the credential, specify empty for implicit credentials
Namespace is deprecated, included only for backwards-compatibility with v2beta1. Deprecated: No namespace field will be present in v2 for a cloud identity reference.
gcp
GCP provides the details for a GCP project. Only one of AWS, GCP or Azure can be populated.
Project is the user assigned projectId "name" of the GCP project to use. See https://cloud.google.com/resource-manager/reference/rest/v1/projects
ProjectNumber is the number of the GCP project to use. This is only required when accessing GCP from AWS or Azure.
WorkloadIdentityPoolID is the ID of the workload identity pool to use for this project. This is only required when accessing GCP from AWS or Azure. From the GCP validation: "This value can contain the characters a–z and 0–9.", "Must be at least 4 characters long."
WorkloadIdentityProviderID is the ID of the workload identity provider to use for this project. This is only required when accessing GCP from AWS or Azure. From the GCP validation: "This value can contain the characters a–z and 0–9.", "Must be at least 4 characters long."
permissions
undefined[]
Permissions defines the set of permissions to validate for this check.
AWSRole defines an AWS IAM role (via ARN or name) that should be assumed by Wayfinder when using this permission. Only valid if this CloudAccessConfig refers to an AWS account. For more information, see: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
AzureCloudIdentityName defines the name of a CloudIdentity in the same workspace as this CloudAccessConfig which should be used by Wayfinder when using this permission. Deprecated: Included for backwards-compatibility with v2beta1 and will be removed in v2. Use spec.azure.clientID field on CloudAccessConfig instead.
GCPServiceAccount defines a GCP service account that should be assumed by Wayfinder when using this permission. Only valid if this CloudAccessConfig refers to a GCP project.
Permission identifies which of Wayfinder's built-in permission sets this allows access to.
status
conditions
undefined[]
identity
Identity is the status of the existing cloud identity or the provided credentials
Message defined a human-readable description of any problem using the identity
Valid indicates if the supplied identity is valid
lastReconcile
lastSuccess
newCloudIdentityStatus
NewCloudIdentityStatus will be populated with a 'status' if a cloud identity spec is provided in the check. This status can be used to determine certain details used to establish cross-cloud trust.
AzurePrincipalID is the Principal ID when known This is set when Wayfinder is installed on an AKS cluster Can be referenced and used when creating Azure role assignments for Wayfinder
AzureTenantID is the Tenant ID when known For an implicit identity, this will be detected from the environment in which Wayfinder is running.
conditions
undefined[]
GCPServiceAccountID is the Service Account ID It will be obtained dynamically
Identity is the unique reference to the cloud principle e.g. aws role, gcp service-account etc.
lastReconcile
lastSuccess
obsoleteResources
undefined[]
oidc
OIDC provides details of an OIDC issuer that can be used to verify/trust this identity when operating in cross-cloud flows.
Audience is the audience to verify in order to validate this identity in cross-cloud flows.
Issuer is the URL of the OIDC issuer to trust in order to validate this identity.
Subject is the subject to verify in order to validate this identity in cross-cloud flows.
ownedResources
cloudResources
undefined[]
wayfinderResources
undefined[]
pendingSince
Verified checks that the credentials are ok and valid
obsoleteResources
undefined[]
ownedResources
cloudResources
undefined[]
wayfinderResources
undefined[]
pendingSince
permissions
undefined[]
Permissions is the status of the permissions we've been asked to validate
CanAccess indicates whether or not the provider role/identity is accessible
Message defined a human-readable description of any problem using the permission
MissingPermissions indicates if the role/identity has missing permissions
Permission is the Wayfinder cloud permission that this has been validated for
PermissionsCorrect indicates if the permissions are correct
Valid defines whether the permission is valid
Valid indicates if the identity and all provided roles are valid
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"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": {
"aws": {
"account": "string",
"defaultRegion": "string"
},
"azure": {
"clientID": "string",
"subscription": "string",
"tenantID": "string"
},
"cloud": "string",
"cloudIdentity": {
"aws": {
"roleARN": "string",
"userARN": "string"
},
"azure": {
"clientID": "string",
"tenantID": "string"
},
"cloud": "string",
"credentialsInputData": {},
"credentialsUpdated": "string",
"gcp": {
"serviceAccount": "string"
},
"secretRef": {
"name": "string",
"namespace": "string"
},
"type": "string"
},
"cloudIdentityRef": {
"cloud": "string",
"name": "string",
"namespace": "string"
},
"gcp": {
"project": "string",
"projectNumber": 0,
"workloadIdentityPoolID": "string",
"workloadIdentityProviderID": "string"
},
"permissions": [
{
"awsRole": "string",
"azureCloudIdentityName": "string",
"gcpServiceAccount": "string",
"permission": "string"
}
]
},
"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": {
"message": "string",
"valid": true
},
"lastReconcile": {
"generation": 0,
"time": "string"
},
"lastSuccess": {
"generation": 0,
"time": "string"
},
"message": "string",
"newCloudIdentityStatus": {
"azurePrincipalID": "string",
"azureTenantID": "string",
"cloudResourcesCreated": true,
"conditions": [
{
"detail": "string",
"lastTransitionTime": "string",
"message": "string",
"name": "string",
"negativePolarity": true,
"observedGeneration": 0,
"reason": "string",
"status": "string",
"type": "string"
}
],
"detail": "string",
"gcpServiceAccountID": "string",
"identity": "string",
"lastReconcile": {
"generation": 0,
"time": "string"
},
"lastSuccess": {
"generation": 0,
"time": "string"
},
"message": "string",
"obsoleteResources": [
{
"kind": "string",
"name": "string"
}
],
"oidc": {
"audience": "string",
"issuer": "string",
"subject": "string"
},
"ownedResources": {
"cloudResources": [
{
"cloud": "string",
"id": "string",
"name": "string",
"type": "string"
}
],
"wayfinderResources": [
{
"kind": "string",
"name": "string",
"workspace": "string"
}
]
},
"pendingSince": {
"generation": 0,
"time": "string"
},
"status": "string",
"verified": true,
"wayfinderVersion": "string"
},
"obsoleteResources": [
{
"kind": "string",
"name": "string"
}
],
"ownedResources": {
"cloudResources": [
{
"cloud": "string",
"id": "string",
"name": "string",
"type": "string"
}
],
"wayfinderResources": [
{
"kind": "string",
"name": "string",
"workspace": "string"
}
]
},
"pendingSince": {
"generation": 0,
"time": "string"
},
"permissions": [
{
"canAccess": true,
"message": "string",
"missingPermissions": [
"string"
],
"permission": "string",
"permissionsCorrect": true,
"valid": true
}
],
"status": "string",
"valid": true,
"wayfinderVersion": "string"
}
}
If not authenticated
If authenticated but not authorized
the cloud access check with the given name doesn't exist
A generic API error containing the cause of the error
- application/json
- Schema
- Example (from schema)
Schema
{
"code": 0,
"detail": "string",
"message": "string",
"uri": "string",
"verb": "string"
}