API Reference

Packages

• nauth.io/v1alpha1

nauth.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the nats v1alpha1 API group.

Resource Types

• Account
• AccountList
• User
• UserList

Account

Account is the Schema for the accounts API.

Appears in:

• AccountList

Field	Description	Default	Validation
apiVersion string	nauth.io/v1alpha1
kind string	Account
kind string	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
apiVersion string	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
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec AccountSpec
status AccountStatus

AccountClaims

Appears in:

• AccountStatus

Field	Description	Default	Validation
accountLimits AccountLimits
exports Exports
imports Imports
jetStreamLimits JetStreamLimits
natsLimits NatsLimits

AccountLimits

Appears in:

• AccountClaims
• AccountSpec

Field	Description	Default	Validation
imports integer		-1
exports integer		-1
wildcards boolean		true
conn integer		-1
leaf integer		-1

AccountList

AccountList contains a list of Account.

Field	Description	Default	Validation
apiVersion string	nauth.io/v1alpha1
kind string	AccountList
kind string	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
apiVersion string	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
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Account array

AccountRef

Appears in:

• Import

Field	Description	Default	Validation
name string
namespace string

AccountSpec

AccountSpec defines the desired state of Account.

Appears in:

• Account

Field	Description	Default	Validation
accountLimits AccountLimits
exports Exports
imports Imports
jetStreamLimits JetStreamLimits
natsLimits NatsLimits

AccountStatus

AccountStatus defines the observed state of Account.

Appears in:

• Account

Field	Description	Default	Validation
claims AccountClaims
conditions Condition array
observedGeneration integer
reconcileTimestamp Time
signingKey KeyInfo

CIDRList

Underlying type: TagList

Appears in:

• UserLimits

Export

Appears in:

• Exports

Field	Description	Default	Validation
name string
subject Subject
type ExportType			Enum: [stream service]
tokenReq boolean
revocations RevocationList
responseType ResponseType			Enum: [Singleton Stream Chunked]
responseThreshold Duration
serviceLatency ServiceLatency
accountTokenPosition integer
advertise boolean
allowTrace boolean

ExportType

Underlying type: string

ExportType defines the type of import/export.

Validation:

• Enum: [stream service]

Appears in:

• Export
• Import

Field	Description
stream	Stream defines the type field value for a stream “stream”
service	Service defines the type field value for a service “service”

Exports

Underlying type: Export

Appears in:

• AccountClaims
• AccountSpec

Field	Description	Default	Validation
name string
subject Subject
type ExportType			Enum: [stream service]
tokenReq boolean
revocations RevocationList
responseType ResponseType			Enum: [Singleton Stream Chunked]
responseThreshold Duration
serviceLatency ServiceLatency
accountTokenPosition integer
advertise boolean
allowTrace boolean

Import

Appears in:

• Imports

Field	Description	Default	Validation
accountRef AccountRef	AccountRefName references the account used to create the user.
name string
subject Subject	Subject field in an import is always from the perspective of the initial publisher - in the case of a stream it is the account owning the stream (the exporter), and in the case of a service it is the account making the request (the importer).
account string
localSubject RenamingSubject	Local subject used to subscribe (for streams) and publish (for services) to. This value only needs setting if you want to change the value of Subject. If the value of Subject ends in > then LocalSubject needs to end in > as well. LocalSubject can contain $ wildcard references where number references the nth wildcard in Subject. The sum of wildcard reference and * tokens needs to match the number of * token in Subject.
type ExportType			Enum: [stream service]
share boolean
allowTrace boolean

Imports

Underlying type: Import

Appears in:

• AccountClaims
• AccountSpec

Field	Description	Default	Validation
accountRef AccountRef	AccountRefName references the account used to create the user.
name string
subject Subject	Subject field in an import is always from the perspective of the initial publisher - in the case of a stream it is the account owning the stream (the exporter), and in the case of a service it is the account making the request (the importer).
account string
localSubject RenamingSubject	Local subject used to subscribe (for streams) and publish (for services) to. This value only needs setting if you want to change the value of Subject. If the value of Subject ends in > then LocalSubject needs to end in > as well. LocalSubject can contain $ wildcard references where number references the nth wildcard in Subject. The sum of wildcard reference and * tokens needs to match the number of * token in Subject.
type ExportType			Enum: [stream service]
share boolean
allowTrace boolean

JetStreamLimits

Appears in:

• AccountClaims
• AccountSpec

Field	Description	Default	Validation
memStorage integer		-1
diskStorage integer		-1
streams integer		-1
consumer integer		-1
maxAckPending integer		-1
memMaxStreamBytes integer		-1
diskMaxStreamBytes integer		-1
maxBytesRequired boolean		false

KeyInfo

Appears in:

• AccountStatus

Field	Description	Default	Validation
name string
creationDate Time
expirationDate Time

NatsLimits

Appears in:

• AccountClaims
• AccountSpec
• UserClaims
• UserSpec

Field	Description	Default	Validation
subs integer		-1
data integer		-1
payload integer		-1

Permission

Permission defines allow/deny subjects

Appears in:

• Permissions

Field	Description	Default	Validation
allow StringList
deny StringList

Permissions

Permissions are used to restrict subject access, either on a user or for everyone on a server by default

Appears in:

• UserClaims
• UserSpec

Field	Description	Default	Validation
pub Permission
sub Permission
resp ResponsePermission

RenamingSubject

Underlying type: Subject

Appears in:

• Import

ResponsePermission

ResponsePermission can be used to allow responses to any reply subject that is received on a valid subscription.

Appears in:

• Permissions

Field	Description	Default	Validation
max integer
ttl Duration

ResponseType

Underlying type: string

ResponseType is used to store an export response type

Validation:

• Enum: [Singleton Stream Chunked]

Appears in:

• Export

RevocationList

Underlying type: object

Appears in:

• Export

SamplingRate

Underlying type: integer

Appears in:

• ServiceLatency

ServiceLatency

Appears in:

• Export

Field	Description	Default	Validation
sampling SamplingRate
results Subject

StringList

Underlying type: string array

StringList is a wrapper for an array of strings

Appears in:

• Permission

Subject

Underlying type: string

Subject is a string that represents a NATS subject

Appears in:

• Export
• Import
• RenamingSubject
• ServiceLatency

TagList

Underlying type: string array

TagList is a unique array of lower case strings All tag list methods lower case the strings in the arguments

Appears in:

• CIDRList

TimeRange

TimeRange is used to represent a start and end time

Appears in:

• UserLimits

Field	Description	Default	Validation
start string
end string

User

User is the Schema for the users API.

Appears in:

• UserList

Field	Description	Default	Validation
apiVersion string	nauth.io/v1alpha1
kind string	User
kind string	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
apiVersion string	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
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec UserSpec
status UserStatus

UserClaims

Appears in:

• UserStatus

Field	Description	Default	Validation
accountName string
permissions Permissions
natsLimits NatsLimits
userLimits UserLimits

UserLimits

Appears in:

• UserClaims
• UserSpec

Field	Description	Default	Validation
src CIDRList	Src is a comma separated list of CIDR specifications
times TimeRange array
timesLocation string

UserList

UserList contains a list of User.

Field	Description	Default	Validation
apiVersion string	nauth.io/v1alpha1
kind string	UserList
kind string	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
apiVersion string	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
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items User array

UserSpec

UserSpec defines the desired state of User.

Appears in:

• User

Field	Description	Default	Validation
accountName string	AccountName references the account used to create the user.
permissions Permissions
userLimits UserLimits
natsLimits NatsLimits

UserStatus

UserStatus defines the observed state of User.

Appears in:

• User

Field	Description	Default	Validation
conditions Condition array
claims UserClaims
observedGeneration integer
reconcileTimestamp Time