eks.access-entries.update

Change an access entry’s Kubernetes username or extra groups

PATCH /eks/api/clusters/{cluster}/access-entries/{id}IAM eks:UpdateAccessEntryChanges stateDestructive

Request syntax

PATCH /eks/api/clusters/{cluster}/access-entries/{id}
{
  "username": "string",
  "kubernetesGroups": "array of string"
}

Path parameters

  • clusterRequired

    string

    Constraints: /^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$/

  • idRequired

    string

Request body

  • usernameOptional

    string

    Kubernetes username the entry’s tokens carry, prefixed ews: by the cluster (RBAC sees ews:<username>); 1–100 letters, digits and : . _ @ -, not starting system:. null clears it (tokens then carry the IAM user name of whoever gets them); unchanged when absent

    Constraints: 1-100 chars, /^[A-Za-z0-9][A-Za-z0-9:._@-]*$/

    May be null.

  • kubernetesGroupsOptional

    array of string

    Extra Kubernetes groups the entry’s tokens carry, for your own RBAC bindings; at most 20, each 1–100 letters, digits and : . _ @ -, not starting system: or ews:. Replaces the list; [] clears it; unchanged when absent

    Constraints: 1-100 chars, /^[A-Za-z0-9][A-Za-z0-9:._@-]*$/

Response

200 with the access entry after the change: id, principalType, principalId, principalName, username, kubernetesGroups, policies (policy, namespaces, scope: cluster | namespaces), createdAt. 400 when nothing is sent; 404 for an unknown cluster or entry, 403 without the permission. Tokens issued before keep the old name and groups until they expire (10 minutes).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow eks:UpdateAccessEntry on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud eks access-entries update cluster id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_eks_access-entries_update.