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.

apiVersion: skupper.io/v1alpha1
kind: AccessGrant
metadata:  # Metadata properties
spec:      # Spec properties
status:    # Status properties

Metadata properties

Spec properties

  • redemptionsAllowed integer

    The number of times an access token for this grant can be redeemed.

    Default1
    PlatformsKubernetes, Docker
  • expirationWindow string (duration)

    The period of time in which an access token for this grant can be redeemed.

    Default

    15m

    PlatformsKubernetes, Docker
  • code string

    The secret code used to authenticate access tokens submitted for redemption.

    If not set, a value for the code field in the status is generated.

    PlatformsKubernetes, Docker
  • issuer string

    PlatformsKubernetes, Docker

    What is this?

  • options object

    Additional settings.

    PlatformsKubernetes, Docker

Status properties

  • redeemed integer

    The number of times a token for this grant has been redeemed.

    PlatformsKubernetes, Docker

    Suggest "redemptions" instead, to match "redemptionsAllowed" and avoid the impression that it's a boolean.

  • expiration string (date-time)

    The point in time when the grant expires.

    PlatformsKubernetes, Docker

    Suggest "expirationTime" instead. It seems to be the most conventional name.

  • url string

    The URL of the token-redemption service for this grant.

    PlatformsKubernetes, Docker
  • ca string

    The trusted server certificate of the token-redemption service for this grant.

    PlatformsKubernetes, Docker
  • code string

    The secret code used to authenticate access tokens submitted for redemption.

    Default

    Generated

    PlatformsKubernetes, Docker
  • status string

    The current state of the resource.

    PlatformsKubernetes, Docker