Skip to main content
POST
Create a cluster access grant

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

cluster_id
string<uuid4>
required

Body

application/json
role
enum<string>
required
Available options:
view,
edit,
admin,
cluster-admin
scope
enum<string>
required
Available options:
cluster,
namespace
user_email
string
required
expires_in
string | null

Relative window for a time-boxed grant: a duration such as 30m or 4h, or whole days such as 7d. Mutually exclusive with expires_at. Omit both for a standing grant.

expires_at
string<date-time> | null

Absolute expiry for a time-boxed grant (RFC 3339). Mutually exclusive with expires_in. Re-posting a matching live grant with an expiry re-times it in place.

reason
string | null

Why the access is granted; recorded on the grant and in the audit log.

Required string length: 3 - 500
namespace
string | null

Response

Successful Response

grant
ClusterAccessGrant · object
required