Go API client for syncp

API for Synadia Control Plane / Synadia Cloud

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "github.com/synadia-io/control-plane-sdk-go/syncp"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value syncp.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), syncp.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value syncp.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), syncp.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using syncp.ContextOperationServerIndices and syncp.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), syncp.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), syncp.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost/api/core/beta

Class	Method	HTTP request	Description
AccountAPI	AssignAccountTeamAppUser	Post /accounts/{accountId}/app-users/{teamAppUserId}	Assign Team App User to Account
AccountAPI	CreateAccountSkGroup	Post /accounts/{accountId}/account-sk-groups	Create Account Signing Key Group
AccountAPI	CreateAlertRule	Post /accounts/{accountId}/alert-rules	Create Account Alert Rule
AccountAPI	CreateKvBucket	Post /accounts/{accountId}/jetstream/kv-buckets	Create KV Bucket
AccountAPI	CreateMirror	Post /accounts/{accountId}/jetstream/mirrors	Create Mirror
AccountAPI	CreateObjectBucket	Post /accounts/{accountId}/jetstream/object-buckets	Create Object Bucket
AccountAPI	CreateOrUpdateNatsUserRevocation	Put /accounts/{accountId}/nats-user-revocations/{userNkeyPublic}	Create or Update Revocation for a NATS User NKey
AccountAPI	CreateStream	Post /accounts/{accountId}/jetstream/streams	Create Stream
AccountAPI	CreateStreamExport	Post /accounts/{accountId}/stream-exports	Create Stream Export
AccountAPI	CreateStreamImport	Post /accounts/{accountId}/stream-imports	Create Stream Import
AccountAPI	CreateSubjectExport	Post /accounts/{accountId}/subject-exports	Create Subject Export
AccountAPI	CreateSubjectImport	Post /accounts/{accountId}/subject-imports	Create Subject Import
AccountAPI	CreateUser	Post /accounts/{accountId}/nats-users	Create NATS User
AccountAPI	DeleteAccount	Delete /accounts/{accountId}	Delete Account
AccountAPI	DeleteAlertRule	Delete /accounts/{accountId}/alert-rules/{alertRuleId}	Delete Account Alert Rule
AccountAPI	DeleteNatsUserRevocation	Delete /accounts/{accountId}/nats-user-revocations/{userNkeyPublic}	Delete a for a NATS User NKey
AccountAPI	GetAccount	Get /accounts/{accountId}	Get Account
AccountAPI	GetAccountInfo	Get /accounts/{accountId}/info	Get Account Info
AccountAPI	GetAccountMetrics	Get /accounts/{accountId}/metrics	Get Account Metrics
AccountAPI	GetAlertRule	Get /accounts/{accountId}/alert-rules/{alertRuleId}	Get Account Alert Rule
AccountAPI	GetJetStreamPlacementOptions	Get /accounts/{accountId}/jetstream/placement-options	Get JetStream Placement Options
AccountAPI	GetNatsUserRevocation	Get /accounts/{accountId}/nats-user-revocations/{userNkeyPublic}	Get Revocation for a NATS User NKey
AccountAPI	ListAccountConnections	Get /accounts/{accountId}/connections	List Account Connections
AccountAPI	ListAccountSkGroup	Get /accounts/{accountId}/account-sk-groups	List Account Signing Key Groups
AccountAPI	ListAccountTeamAppUsers	Get /accounts/{accountId}/app-users	List Account Team App Users
AccountAPI	ListAlertRules	Get /accounts/{accountId}/alert-rules	List Account Alert Rules
AccountAPI	ListJetStreamAssets	Get /accounts/{accountId}/jetstream	List JetStream Assets
AccountAPI	ListKvBuckets	Get /accounts/{accountId}/jetstream/kv-buckets	List KV buckets
AccountAPI	ListMirrors	Get /accounts/{accountId}/jetstream/mirrors	List Mirrors
AccountAPI	ListObjectBuckets	Get /accounts/{accountId}/jetstream/object-buckets	List Object buckets
AccountAPI	ListStreamExports	Get /accounts/{accountId}/stream-exports	List Stream Exports
AccountAPI	ListStreamExportsShared	Get /accounts/{accountId}/stream-imports/shared	List Shared Stream Exports
AccountAPI	ListStreamImports	Get /accounts/{accountId}/stream-imports	List Stream Imports
AccountAPI	ListStreams	Get /accounts/{accountId}/jetstream/streams	List Streams
AccountAPI	ListSubjectExports	Get /accounts/{accountId}/subject-exports	List Subject Exports
AccountAPI	ListSubjectExportsShared	Get /accounts/{accountId}/subject-imports/shared	List Shared Subject Exports
AccountAPI	ListSubjectImports	Get /accounts/{accountId}/subject-imports	List Subject Imports
AccountAPI	ListUsers	Get /accounts/{accountId}/nats-users	List NATS Users
AccountAPI	RunAlertRule	Get /accounts/{accountId}/alert-rules/{alertRuleId}/run	Run Account Alert Rule
AccountAPI	UnAssignAccountTeamAppUser	Delete /accounts/{accountId}/app-users/{teamAppUserId}	Unassign Team App User from Account
AccountAPI	UnmanageAccount	Delete /accounts/{accountId}/unmanage	Unmanage Account
AccountAPI	UpdateAccount	Patch /accounts/{accountId}	Update Account
AccountAPI	UpdateAlertRule	Patch /accounts/{accountId}/alert-rules/{alertRuleId}	Update Account Alert Rule
AgentTokenAPI	DeleteAgentToken	Delete /agent-tokens/{tokenId}	Delete Agent Token
AlertAPI	AcknowledgeAlert	Patch /alerts/{alertId}/acknowledge	Acknowledge Alert
AlertAPI	GetAlert	Get /alerts/{alertId}	Get Alert
AppServiceAccountAPI	CreateAppServiceAccountToken	Post /service-accounts/app/{serviceAccountId}/tokens	Create Acess Token for App Service Account
AppServiceAccountAPI	DeleteAppServiceAccount	Delete /service-accounts/app/{serviceAccountId}	Delete App Service Account
AppServiceAccountAPI	GetAppServiceAccount	Get /service-accounts/app/{serviceAccountId}	Get App Service Account
AppServiceAccountAPI	ListAppServiceAccountTokens	Get /service-accounts/app/{serviceAccountId}/tokens	List Access Tokens for App Service Account
AppServiceAccountAPI	UpdateAppServiceAccount	Patch /service-accounts/app/{serviceAccountId}	Update App Service Account
AppServiceAccountTokensAPI	DeleteAppServiceAccountToken	Delete /service-account-tokens/app/{tokenId}	Delete App Service Account Token
AppServiceAccountTokensAPI	GetAppServiceAccountToken	Get /service-account-tokens/app/{tokenId}	Get App Service Account Token
AppServiceAccountTokensAPI	UpdateAppServiceAccountToken	Patch /service-account-tokens/app/{tokenId}	Update App Service Account Token
AppUserAPI	AssignTeamAppUser	Post /app-users/{appUserId}/teams/{teamId}	Assign App User to Team
AppUserAPI	DeleteAppUser	Delete /app-users/{appUserId}	Delete App User
AppUserAPI	GetAppUser	Get /app-users/{appUserId}	Get App User
AppUserAPI	ListAppUserRoles	Get /app-users/{appUserId}/roles	List Roles
AppUserAPI	UpdateAppUser	Patch /app-users/{appUserId}	Update App User
AuthzAPI	Check	Post /authz/check	Check Authz Decisions
AuthzAPI	ListPolicies	Get /authz/policies	Get Policy List
AuthzAPI	ListRoles	Get /authz/roles	Get Authz roles List
IssuanceAPI	GetNatsUserIssuance	Get /nats-user-issuances/{issuanceId}	Get nats user issuance
KvBucketAPI	CreateKvPullConsumer	Post /jetstream/kv-bucket/{streamId}/consumers/pull	Create Pull Consumer
KvBucketAPI	CreateKvPushConsumer	Post /jetstream/kv-bucket/{streamId}/consumers/push	Create Push Consumer
KvBucketAPI	DeleteKvBucket	Delete /jetstream/kv-bucket/{streamId}	Delete KV Bucket
KvBucketAPI	GetKvBucket	Get /jetstream/kv-bucket/{streamId}	Get KV Bucket
KvBucketAPI	ListKvConsumers	Get /jetstream/kv-bucket/{streamId}/consumers	List Consumers
KvBucketAPI	PurgeKvBucket	Delete /jetstream/kv-bucket/{streamId}/purge	Purge KV Bucket
KvBucketAPI	UpdateKvBucket	Patch /jetstream/kv-bucket/{streamId}	Update KV Bucket
MirrorAPI	CreateMirrorPullConsumer	Post /jetstream/mirror/{streamId}/consumers/pull	Create Pull Consumer
MirrorAPI	CreateMirrorPushConsumer	Post /jetstream/mirror/{streamId}/consumers/push	Create Push consumer
MirrorAPI	DeleteMirror	Delete /jetstream/mirror/{streamId}	Delete Mirror
MirrorAPI	GetMirror	Get /jetstream/mirror/{streamId}	Get Mirror
MirrorAPI	ListMirrorConsumers	Get /jetstream/mirror/{streamId}/consumers	List Consumers
MirrorAPI	PurgeMirror	Delete /jetstream/mirror/{streamId}/purge	Purge Mirror
MirrorAPI	UpdateMirror	Patch /jetstream/mirror/{streamId}	Update Mirror
NatsUserAPI	AssignNatsUserTeamAppUser	Post /nats-users/{userId}/app-users/{teamAppUserId}	Assign Team App User to NATS User
NatsUserAPI	CopyNatsUser	Post /nats-users/{userId}/copy	Copy nats user
NatsUserAPI	DeleteNatsUser	Delete /nats-users/{userId}	Delete NATS User
NatsUserAPI	DownloadNatsUserBearerJwt	Post /nats-users/{userId}/bearer-jwt	Get Bearer JWT
NatsUserAPI	DownloadNatsUserCreds	Post /nats-users/{userId}/creds	Get Creds
NatsUserAPI	DownloadNatsUserHttpGwToken	Post /nats-users/{userId}/http-gw-token	Get HTTP Gateway Token
NatsUserAPI	GetNatsUser	Get /nats-users/{userId}	Get NATS User
NatsUserAPI	ListNatsUserConnections	Get /nats-users/{userId}/connections	List NATs User Connections
NatsUserAPI	ListNatsUserIssuances	Get /nats-users/{userId}/issuances	List nats user issuances
NatsUserAPI	ListNatsUserTeamAppUsers	Get /nats-users/{userId}/app-users	List Team App Users
NatsUserAPI	RotateNatsUser	Post /nats-users/{userId}/rotate	Rotate nats user nkey and seed
NatsUserAPI	UnAssignNatsUserTeamAppUser	Delete /nats-users/{userId}/app-users/{teamAppUserId}	Unassign Team App User from NATS User
NatsUserAPI	UpdateNatsUser	Patch /nats-users/{userId}	Update NATS User
ObjectBucketAPI	CreateObjPullConsumer	Post /jetstream/object-bucket/{streamId}/consumers/pull	Create Pull Consumer
ObjectBucketAPI	CreateObjPushConsumer	Post /jetstream/object-bucket/{streamId}/consumers/push	Create Push Consumer
ObjectBucketAPI	DeleteObjectBucket	Delete /jetstream/object-bucket/{streamId}	Delete Object Bucket
ObjectBucketAPI	GetObjectBucket	Get /jetstream/object-bucket/{streamId}	Get Object Bucket
ObjectBucketAPI	ListObjConsumers	Get /jetstream/object-bucket/{streamId}/consumers	List Consumers
ObjectBucketAPI	PurgeObjBucket	Delete /jetstream/object-bucket/{streamId}/purge	Purge Object Bucket
ObjectBucketAPI	UpdateObjectBucket	Patch /jetstream/object-bucket/{streamId}	Update Object Bucket
PersonalAccessTokenAPI	DeletePersonalAccessToken	Delete /personal-access-tokens/{tokenId}	Delete Personal Access Token
PersonalAccessTokenAPI	GetPersonalAccessToken	Get /personal-access-tokens/{tokenId}	Get Personal Access Token
PersonalAccessTokenAPI	UpdatePersonalAccessToken	Patch /personal-access-tokens/{tokenId}	Update Personal Access Token
PullConsumerAPI	DeletePullConsumer	Delete /consumers/pull/{consumerId}	Delete Pull Consumer
PullConsumerAPI	GetPullConsumerInfo	Get /consumers/pull/{consumerId}	Get Pull Consumer
PullConsumerAPI	UpdatePullConsumer	Patch /consumers/pull/{consumerId}	Update Pull Consumer
PushConsumerAPI	DeletePushConsumer	Delete /consumers/push/{consumerId}	Delete Push Consumer
PushConsumerAPI	GetPushConsumerInfo	Get /consumers/push/{consumerId}	Get Push Consumer
PushConsumerAPI	UpdatePushConsumer	Patch /consumers/push/{consumerId}	Update Push Consumer
SessionAPI	AcceptTerms	Post /terms/accept	Accept terms
SessionAPI	CreateAppServiceAccount	Post /service-accounts/app	Create App Service Account
SessionAPI	CreateAppUser	Post /app-users	Create App User
SessionAPI	CreatePersonalAccessToken	Post /personal-access-tokens	Create Personal Access Token
SessionAPI	CreateTeam	Post /teams	Create Team
SessionAPI	DecideInvitation	Post /invitations/{teamId}	Accept or reject team invitation
SessionAPI	GetVersion	Get /version	Get Version
SessionAPI	ListAlerts	Get /alerts	List Alerts
SessionAPI	ListAppServiceAccounts	Get /service-accounts/app	List App Service Accounts
SessionAPI	ListAppUsers	Get /app-users	List App Users
SessionAPI	ListInvitations	Get /invitations	List of pending invitations
SessionAPI	ListPersonalAccessTokens	Get /personal-access-tokens	List Personal Access Tokens
SessionAPI	ListTeams	Get /teams	List Teams
SigKeyAPI	DeleteAccountSk	Delete /account-sks/{keyId}	Delete Account Signing
SigKeyAPI	GetAccountSk	Get /account-sks/{keyId}	Get Account Signing
SigKeyAPI	UpdateAccountSk	Patch /account-sks/{keyId}	Update Account Signing
SigKeyGroupAPI	CopyAccountSkGroup	Post /account-sk-groups/{groupId}/copy	Copy Account SK Group
SigKeyGroupAPI	DeleteAccountSkGroup	Delete /account-sk-groups/{groupId}	Delete Account Signing Key Group
SigKeyGroupAPI	GetAccountSkGroup	Get /account-sk-groups/{groupId}	Get Account Signing Key Group
SigKeyGroupAPI	ListAccountSkGroupKeys	Get /account-sk-groups/{groupId}/account-sks	List Signing Keys
SigKeyGroupAPI	RotateAccountSk	Post /account-sk-groups/{groupId}/rotate-sk	Roate Active Signing Key
SigKeyGroupAPI	UpdateAccountSkGroup	Patch /account-sk-groups/{groupId}	Update Account Signing Key Group
StreamAPI	CreatePullConsumer	Post /jetstream/stream/{streamId}/consumers/pull	Create Pull Consumer
StreamAPI	CreatePushConsumer	Post /jetstream/stream/{streamId}/consumers/push	Create Push Consumer
StreamAPI	DeleteStream	Delete /jetstream/stream/{streamId}	Delete Stream
StreamAPI	GetStreamInfo	Get /jetstream/stream/{streamId}	Get Stream
StreamAPI	ListConsumers	Get /jetstream/stream/{streamId}/consumers	List Consumers
StreamAPI	PurgeStream	Delete /jetstream/stream/{streamId}/purge	Purge Stream
StreamAPI	UpdateStream	Patch /jetstream/stream/{streamId}	Update Stream
StreamExportAPI	CreateStreamShares	Post /stream-exports/{streamExportId}/shares	Create Stream Shares
StreamExportAPI	DeleteStreamExport	Delete /stream-exports/{streamExportId}	Delete Stream Export
StreamExportAPI	DeleteStreamShare	Delete /stream-exports/{streamExportId}/shares/{targetAccountNKeyPublic}	Delete Stream Share
StreamExportAPI	GetStreamExport	Get /stream-exports/{streamExportId}	Get Stream Export
StreamExportAPI	ListStreamShares	Get /stream-exports/{streamExportId}/shares	List Stream Shares
StreamImportAPI	DeleteStreamImport	Delete /stream-imports/{streamImportId}	Delete Stream Import
StreamImportAPI	GetStreamImport	Get /stream-imports/{streamImportId}	Get Stream Import
SubjectExportAPI	CreateSubjectShares	Post /subject-exports/{subjectExportId}/shares	Create Subject Shares
SubjectExportAPI	DeleteSubjectExport	Delete /subject-exports/{subjectExportId}	Delete Subject Export
SubjectExportAPI	DeleteSubjectShare	Delete /subject-exports/{subjectExportId}/shares/{targetAccountNKeyPublic}	Delete Subject Share
SubjectExportAPI	GetSubjectExport	Get /subject-exports/{subjectExportId}	Get Subject Export
SubjectExportAPI	ListSubjectShares	Get /subject-exports/{subjectExportId}/shares	List Subject Shares
SubjectExportAPI	UpdateSubjectExport	Patch /subject-exports/{subjectExportId}	Update Subject Export
SubjectImportAPI	DeleteSubjectImport	Delete /subject-imports/{subjectImportId}	Delete Subject Import
SubjectImportAPI	GetSubjectImport	Get /subject-imports/{subjectImportId}	Get Subject Import
SubjectImportAPI	UpdateSubjectImport	Patch /subject-imports/{subjectImportId}	Update Subject Import
SystemAPI	AssignSystemTeamAppUser	Post /systems/{systemId}/app-users/{teamAppUserId}	Assign Team App User to System
SystemAPI	CreateAccount	Post /systems/{systemId}/accounts	Create Account
SystemAPI	CreateSystemAlertRule	Post /systems/{systemId}/alert-rules	Create System Alert Rule
SystemAPI	DeleteSystem	Delete /systems/{systemId}	Delete System
SystemAPI	DeleteSystemAlertRule	Delete /systems/{systemId}/alert-rules/{alertRuleId}	Delete System Alert Rule
SystemAPI	GetCurrentAgentToken	Get /systems/{systemId}/agent-tokens/current	Get Current Agent Token
SystemAPI	GetSystem	Get /systems/{systemId}	Get System
SystemAPI	GetSystemAlertRule	Get /systems/{systemId}/alert-rules/{alertRuleId}	Get System Alert Rule
SystemAPI	GetSystemLimits	Get /systems/{systemId}/limits	Get System Limits
SystemAPI	GetSystemPrometheusMetrics	Get /systems/{systemId}/prometheus-metrics	Get Prometheus Metrics
SystemAPI	ImportAccount	Post /systems/{systemId}/import-account	Import Account
SystemAPI	ImportUser	Post /systems/{systemId}/import-user	Import User
SystemAPI	ListAccounts	Get /systems/{systemId}/accounts	List Accounts
SystemAPI	ListAccountsOverviewMetrics	Get /systems/{systemId}/accounts-overview-metrics	List Accounts overview metrics
SystemAPI	ListAgentTokens	Get /systems/{systemId}/agent-tokens	List Agent Tokens
SystemAPI	ListClusters	Get /systems/{systemId}/nats-clusters	List Clusters
SystemAPI	ListConnections	Get /systems/{systemId}/connections	List Connections
SystemAPI	ListServers	Get /systems/{systemId}/servers	List Servers
SystemAPI	ListSystemAlertRules	Get /systems/{systemId}/alert-rules	List System Alert Rules
SystemAPI	ListSystemInfoAccounts	Get /systems/{systemId}/info/accounts	List System Accounts Info
SystemAPI	ListSystemInfoServers	Get /systems/{systemId}/info/servers	List System Servers info
SystemAPI	ListSystemTeamAppUsers	Get /systems/{systemId}/app-users	List System Team App Users
SystemAPI	RotateAgentToken	Post /systems/{systemId}/agent-tokens	Rotate Agent Token
SystemAPI	RunSystemAlertRule	Get /systems/{systemId}/alert-rules/{alertRuleId}/run	Run System Alert Rule
SystemAPI	SystemJWTSync	Post /systems/{systemId}/jwt-sync	Re-sync JWTs of all accounts in this system
SystemAPI	UnAssignSystemTeamAppUser	Delete /systems/{systemId}/app-users/{teamAppUserId}	Unassign Team App User from System
SystemAPI	UnmanageSystem	Delete /systems/{systemId}/unmanage	Unmanage System
SystemAPI	UpdateSystem	Patch /systems/{systemId}	Update System
SystemAPI	UpdateSystemAlertRule	Patch /systems/{systemId}/alert-rules/{alertRuleId}	Update System Alert Rules
TeamAPI	CreateSystem	Post /teams/{teamId}/systems	Create System
TeamAPI	CreateTeamServiceAccount	Post /teams/{teamId}/service-accounts	Create Team Service Account
TeamAPI	DeleteTeam	Delete /teams/{teamId}	Delete Team
TeamAPI	GetTeam	Get /teams/{teamId}	Get Team
TeamAPI	GetTeamLimits	Get /teams/{teamId}/team-limits	Get Team Limits
TeamAPI	ImportSystem	Post /teams/{teamId}/import-system	Import a System
TeamAPI	InviteAppUser	Post /teams/{teamId}/app-users/invitations	Invite App Users
TeamAPI	LeaveTeam	Post /teams/{teamId}/app-users/leave	Leave Team
TeamAPI	ListTeamAccounts	Get /teams/{teamId}/accounts	List Accounts
TeamAPI	ListTeamAppUsers	Get /teams/{teamId}/app-users	List App Users
TeamAPI	ListTeamInfoAppUsers	Get /teams/{teamId}/info/app-users	List info of App Users in Team
TeamAPI	ListTeamNatsUsers	Get /teams/{teamId}/nats-users	List NATS Users
TeamAPI	ListTeamServiceAccounts	Get /teams/{teamId}/service-accounts	List Team Service Accounts
TeamAPI	ListTeamSystems	Get /teams/{teamId}/systems	List Systems
TeamAPI	UnAssignTeamAppUser	Delete /teams/{teamId}/app-users/{appUserId}	Unassign App User from Team
TeamAPI	UpdateTeam	Patch /teams/{teamId}	Update Team
TeamAPI	UpdateTeamAppUser	Patch /teams/{teamId}/app-users/{appUserId}	Update App User Team Assignment
TeamServiceAccountAPI	CreateTeamServiceAccountToken	Post /service-accounts/team/{serviceAccountId}/tokens	Create Acess Token for Team Service Account
TeamServiceAccountAPI	DeleteTeamServiceAccount	Delete /service-accounts/team/{serviceAccountId}	Delete Team Service Account
TeamServiceAccountAPI	GetTeamServiceAccount	Get /service-accounts/team/{serviceAccountId}	Get Team Service Account
TeamServiceAccountAPI	ListTeamServiceAccountTokens	Get /service-accounts/team/{serviceAccountId}/tokens	List Access Tokens for Team Service Account
TeamServiceAccountAPI	UpdateTeamServiceAccount	Patch /service-accounts/team/{serviceAccountId}	Update Team Service Account
TeamServiceAccountTokensAPI	DeleteTeamServiceAccountToken	Delete /service-account-tokens/team/{tokenId}	Delete Team Service Account Token
TeamServiceAccountTokensAPI	GetTeamServiceAccountToken	Get /service-account-tokens/team/{tokenId}	Get Team Service Account Token
TeamServiceAccountTokensAPI	UpdateTeamServiceAccountToken	Patch /service-account-tokens/team/{tokenId}	Update Team Service Account Token

Documentation For Models

• AcceptTermsResponse
• Account
• AccountChartType
• AccountClaims
• AccountClaimsInfo
• AccountConnectionsListResponse
• AccountCreateRequest
• AccountInfo
• AccountJWTSettings
• AccountJWTSettingsPatch
• AccountLimits
• AccountListResponse
• AccountMetrics
• AccountOverviewResponse
• AccountOverviewResponseMetrics
• AccountSearch
• AccountSearchListResponse
• AccountUpdateRequest
• AccountViewResponse
• AccountsOverviewListResponse
• AckPolicy
• Activation
• ActivationClaims
• AgentTokenCurrentResponse
• AgentTokenListResponse
• AgentTokenRotateResponse
• AgentTokenViewResponse
• AlertListResponse
• AlertRuleAccountCreateRequest
• AlertRuleBaseCreateRequest
• AlertRuleListResponse
• AlertRuleOperator
• AlertRuleSeverity
• AlertRuleThresholdMetric
• AlertRuleType
• AlertRuleUpdateRequest
• AlertRuleViewResponse
• AlertStatus
• AlertViewResponse
• ApexCoordinate
• ApexSeries
• AppPolicy
• AppPolicyGroup
• AppPolicyStatement
• AppRole
• AppRoleEffect
• AppRoleScope
• AppUserAccessTokenCreateRequest
• AppUserAccessTokenCreateResponse
• AppUserAccessTokenListResponse
• AppUserAccessTokenUpdateRequest
• AppUserAccessTokenViewResponse
• AppUserAssignListResponse
• AppUserAssignRequest
• AppUserAssignResponse
• AppUserCreateRequest
• AppUserCreateResponse
• AppUserInfo
• AppUserInfoListResponse
• AppUserInvitationRequest
• AppUserInvitationResponse
• AppUserListResponse
• AppUserType
• AppUserUpdateRequest
• AppUserUpdateResponse
• AppUserViewResponse
• AuthzRequest
• AuthzResponse
• ClaimsData
• ClusterChartType
• ClusterInfo
• ConnInfo
• Connz
• ConsumerConfig
• ConsumerInfo
• DataStats
• DeliverPolicy
• DiscardPolicy
• Export
• ExportPatch
• ExportType
• ExternalAuthorization
• ExternalAuthorizationPatch
• ExternalStream
• GatewayStat
• GenericFields
• HTTPGatewayConfig
• HTTPGatewayConfigPatch
• Import
• ImportPatch
• Info
• InvitationDecisionRequest
• InvitationListResponse
• JSApiError
• JSCommonConsumerConfigRequest
• JSCommonStreamConfig
• JSCommonStreamInfo
• JSConsumerInfoListResponse
• JSConsumerInfoResponse
• JSConsumerType
• JSKVBucketConfig
• JSKVBucketListResponse
• JSKVBucketUpdateRequest
• JSKVBucketViewResponse
• JSMirrorConfigRequest
• JSMirrorInfoListResponse
• JSMirrorInfoResponse
• JSObjectBucketConfig
• JSObjectBucketListResponse
• JSObjectBucketUpdateRequest
• JSObjectBucketViewResponse
• JSPlacementOptionsResponse
• JSPullConsumerConfigRequest
• JSPullConsumerInfoResponse
• JSPullConsumerUpdateRequest
• JSPushConsumerConfigRequest
• JSPushConsumerInfoResponse
• JSPushConsumerUpdateRequest
• JSStreamConfigRequest
• JSStreamInfoListResponse
• JSStreamInfoResponse
• JSType
• JetStreamAPIStats
• JetStreamAccountLimits
• JetStreamAccountStats
• JetStreamConfig
• JetStreamLimits
• JetStreamStats
• JetStreamTier
• JetStreamVarz
• JwtSyncStatus
• LeafInfo
• Leafz
• LostStreamData
• MetaClusterInfo
• NatsCluster
• NatsClusterListResponse
• NatsLimits
• NatsServer
• NatsServerInfoListResponse
• NatsServerListResponse
• NatsUserConnectionsListResponse
• NatsUserCopyRequest
• NatsUserCreateRequest
• NatsUserHTTPGWTokenCreateReply
• NatsUserInfo
• NatsUserIssuanceEvent
• NatsUserIssuanceEventType
• NatsUserIssuanceInfo
• NatsUserIssuanceStatus
• NatsUserIssuanceViewResponse
• NatsUserIssuancesListResponse
• NatsUserJwtSettings
• NatsUserJwtSettingsPatch
• NatsUserListResponse
• NatsUserRevocationRequest
• NatsUserRevocationViewResponse
• NatsUserUpdateRequest
• NatsUserViewResponse
• ObjectStoreConfig
• Operator
• OperatorClaims
• OperatorLimits
• OperatorLimitsPatch
• PeerInfo
• Permission
• PermissionPatch
• Permissions
• Placement
• PolicyListResponse
• PromSampleValue
• RePublish
• ReplayPolicy
• ResponsePermission
• ResponsePermissionPatch
• ResponseType
• RetentionPolicy
• RoleListResponse
• RouteStat
• S2Compression
• SequenceInfo
• ServerInfo
• ServerStats
• ServerStatsMsg
• ServiceAccountCreateRequest
• ServiceAccountListResponse
• ServiceAccountResourceScope
• ServiceAccountScope
• ServiceAccountUpdateRequest
• ServiceAccountViewResponse
• ServiceLatency
• ServiceLatencyPatch
• SigningKeyGroupCopyRequest
• SigningKeyGroupCreateRequest
• SigningKeyGroupCreateResponse
• SigningKeyGroupListResponse
• SigningKeyGroupUpdateRequest
• SigningKeyGroupViewResponse
• SigningKeyListResponse
• SigningKeyRotateResponse
• SigningKeyScope
• SigningKeyScopeType
• SigningKeyUpdateRequest
• SigningKeyViewResponse
• StorageType
• StreamAlternate
• StreamExportCreateRequest
• StreamExportListResponse
• StreamExportSharedListResponse
• StreamExportSharedViewResponse
• StreamExportViewResponse
• StreamImportCreateRequest
• StreamImportListResponse
• StreamImportViewResponse
• StreamShareCreateRequest
• StreamShareListResponse
• StreamShareViewResponse
• StreamSource
• StreamSourceInfo
• StreamState
• SubDetail
• SubjectExportChartTypes
• SubjectExportCreateRequest
• SubjectExportListResponse
• SubjectExportSharedListResponse
• SubjectExportSharedViewResponse
• SubjectExportUpdateRequest
• SubjectExportViewResponse
• SubjectImportCreateRequest
• SubjectImportListResponse
• SubjectImportUpdateRequest
• SubjectImportViewResponse
• SubjectShareCreateRequest
• SubjectShareListResponse
• SubjectShareViewResponse
• SubjectTransformConfig
• SystemAccountImportRequest
• SystemConnectionType
• SystemConnectionsListResponse
• SystemCreateRequest
• SystemDirectConnectionOpts
• SystemDirectConnectionOptsPatch
• SystemImportRequest
• SystemInfo
• SystemLimitsResponse
• SystemListResponse
• SystemState
• SystemUpdateRequest
• SystemUserImportRequest
• SystemViewResponse
• TLSMode
• TLSPeerCert
• TeamAppUserAssociation
• TeamAppUserInfo
• TeamAppUserListResponse
• TeamAppUserResourceType
• TeamAppUserViewResponse
• TeamCreateRequest
• TeamInfo
• TeamLimits
• TeamLimitsResponse
• TeamListResponse
• TeamUpdateRequest
• TeamViewResponse
• TenantLimits
• TimeRange
• UpdatableKVBucketConfig
• UpdatableObjectBucketConfig
• User
• UserClaims
• UserLimits
• UserPermissionLimits
• UserPermissionLimitsPatch
• VersionResponse
• WeightedMapping

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), syncp.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

sessionAuth

• Type: API key
• API key parameter name: control_plane_session
• Location:

Note, each API key must be added to a map of map[string]APIKey where the key is: control_plane_session and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		syncp.ContextAPIKeys,
		map[string]syncp.APIKey{
			"control_plane_session": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions and generic types to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author