AccessGrant resource
Permission to redeem access tokens for links to the local site. A remote site can use a token containing the grant URL and secret code to obtain a certificate signed by the grant's certificate authority (CA), within a certain expiration window and for a limited number of redemptions.
The code, url, and ca properties of the resource
status are used to generate access tokens from the grant.
Metadata properties
name
The name of the resource.
| See also | Kubernetes object names |
|---|
namespace
The namespace of the resource.
| See also | Platform concept, Kubernetes namespaces, System namespaces |
|---|
Spec properties
redemptionsAllowed
The number of times an access token for this grant can be redeemed.
| Default | 1 |
|---|
expirationWindow
The period of time in which an access token for this grant can be redeemed.
| Default |
|
|---|
code
The secret code to use to authenticate access tokens submitted for redemption.
If not set, a value is generated and placed in the code
status property.
issuer
The name of a Kubernetes secret used to generate a certificate when redeeming a token for this grant.
If not set, defaultIssuer on the Site rsource is used.
| See also | Router TLS, Kubernetes TLS secrets |
|---|
settings
A map containing additional settings. Each map entry has a string name and a string value.
Note: In general, we recommend not changing settings from their default values.
| See also | Resource settings |
|---|
Status properties
status
The current state of the resource.
Pending: The resource is being processed.Error: There was an error processing the resource. Seemessagefor more information.Ready: The resource is ready to use.
| See also | Resource status |
|---|
message
A human-readable status message. Error messages are reported here.
| See also | Resource status |
|---|
redemptions
The number of times a token for this grant has been redeemed.
expirationTime
The point in time when the grant expires.
url
The URL of the token-redemption service for this grant.
ca
The trusted server certificate of the token-redemption service for this grant.
code
The secret code used to authenticate access tokens submitted for redemption.
| Default | Generated |
|---|
conditions
A set of named conditions describing the current state of the resource.
Processed: The controller has accepted the grant.Resolved: The grant service is available to process tokens for this grant.Ready: The grant is ready to use. All other conditions are true.
| See also | Resource status, Kubernetes conditions |
|---|