mdsv1

package module
v0.0.0-...-b922b35 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 23, 2024 License: Apache-2.0 Imports: 23 Imported by: 14

README

Go API client for mdsv1

Confluent Metadata API - Swagger UI

This tool (SwaggerUI) and the Open API spec file are provided for development / test purposes only:

  • Do not enable in Production.
  • This tool only works with HTTP.
Authenticating

Authentication is performed by HTTP Basic Auth or by presenting a bearer token. In this UI, click Authorize to enter credentials.

To get a bearer token, first call the authenticate endpoint with basic auth, and then extract the auth_token part of the request, and pass that as the bearer token.

Access Restrictions - Who can call what?

Some endpoints can be called by any authenticated user, while others can only be called by "admins". Additionally, many of the endpoints in the API involve two users: the user who is calling the endpoint (the "calling" principal) and the user that the API call is about (the "target" principal).

Example: User "alice", who has the UserAdmin role, and is identifed by her basic auth credentials or a bearer token, calls the CRUD endpoint to modify role bindings about user "bob".

To document what access restrictions each endpoint has, use the following legend, which lists access in order from least restrictive to most restrictive:

  • LDAP: Any authenticated LDAP user
  • Admins+User: Admins or the user requesting information about themself
  • Admins+ResourceOwners: Admins or users with ResourceOwner role
  • Admins+AclUsers: Admins or the user having the required ACL permissions
  • Admins: Admins only, which can be UserAdmin, SystemAdmin, broker super.user, or SecurityAdmin as "Read"
Overview of Responses

Valid

  • 200 - Successful call with a return body.
  • 204 - Sucessuful call with no return body.

Errors

  • 400 - Invalid request. JSON parsing error, or otherwise incorrect request.
  • 401 - Not Authenticated. You need to pass valid basic auth credentials or a user bearer token.
  • 403 - Not Authorized. Valid request, but you aren't authorized to perform the requested action.
  • 404 - Invalid URL. If you get this error from the authenticate endpoint, it means bearer token authentication needs to be enabled in the configuration.
    • confluent.metadata.server.authentication.method=BEARER
  • 405 - Method Not Allowed. Using the wrong HTTP method on a valid endpoint (for example, GET instead of POST).
  • 409 - Conflict. Adding a new resource or updating an existing resource which would result in a conflict with existing state.
    • can be thrown by Audit Logs and Cluster Registry APIs
  • 415 - Invalid Content Type. Usually, not sending "application/json" as request body header.
  • 500 - Server Error.
Special Resource Types

Cluster and KsqlCluster are special ResourceTypes because they grant resource-scoped roles like ResourceOwner and DeveloperManage limited access to cluster-level operations (for example, Describe Configs on Kafka clusters). These special resource types only accept LITERAL patterns with the values "kafka-cluster" and "kql-cluster", respectively.

Private RBAC UI Endpoints

These endpoints were developed specifically to power the Confluent Control Center UI. As such, they only focus on those use cases and have only been tested in the context of Confluent Control Center. These endpoints have not been tested, nor has their usability been evaluated with respect to manual API calls.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoDeprecatedClientCodegen

Installation

Install the following dependencies:

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

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

import "./mdsv1"

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AuditLogConfigurationApi GetConfig Get /security/1.0/audit/config Get the entire audit log configuration, including the live retention time policy values (``retention_ms``) for the destination topics.
AuditLogConfigurationApi ListRoutes Get /security/1.0/audit/routes Lists all currently defined routes that match the queried resource or its sub-resources.
AuditLogConfigurationApi PutConfig Put /security/1.0/audit/config Update the entire audit log configuration on the MDS cluster and all Kafka clusters known to the cluster registry.
AuditLogConfigurationApi ResolveResourceRoute Get /security/1.0/audit/lookup Returns the route describing how messages regarding this CRN would be routed.
AuthorizationApi Authorize Put /security/1.0/authorize Authorize operations against resourceType for a given user.
ClusterRegistryApi ClusterRegistryList Get /security/1.0/registry/clusters Returns a list of all clusters in the registry, optionally filtered by cluster type.
ClusterRegistryApi DeleteNamedCluster Delete /security/1.0/registry/clusters/{clusterName} Remove a named cluster from the registry.
ClusterRegistryApi GetNamedCluster Get /security/1.0/registry/clusters/{clusterName} Returns the information for a single named cluster, assuming the cluster exists and is visible to the calling principal.
ClusterRegistryApi UpdateClusters Post /security/1.0/registry/clusters Define/overwrite named clusters.
KafkaACLManagementApi AddAclBinding Post /security/1.0/acls Creates Kafka ACLs for given AclBinding.
KafkaACLManagementApi RemoveAclBindings Delete /security/1.0/acls Deletes Kafka ACLs according to the supplied filter.
KafkaACLManagementApi SearchAclBinding Post /security/1.0/acls:search Lists Kafka ACLs according to the supplied filter.
MetadataServiceOperationsApi Activenodes Get /security/1.0/activenodes/{protocol} Returns all the nodes running the Metadata Service REST API.
MetadataServiceOperationsApi Features Get /security/1.0/features What features the running version of MDS supports.
MetadataServiceOperationsApi MetadataClusterId Get /security/1.0/metadataClusterId Returns the ID of the Kafka cluster that MDS is running on.
PrivateRBACUICachedUserStoreInformationApi UsersGroupsList Post /security/1.0/rbac/principals List of MDS cached users and groups.
PrivateRBACUIClusterVisibilityApi ListManagedClusters Get /security/1.0/lookup/managed/clusters/principal/{principal} Identifies the scopes for the rolebindings that a user can see.
PrivateRBACUIClusterVisibilityApi Visibility Post /security/1.0/lookup/principals/{principal}/visibility Endpoint for Confluent Control Center to determine visibilty of Kafka and its sub-clusters for the specifed principal.
PrivateRBACUICreationGuidelinesApi LookupCreateGuidelines Post /security/1.0/lookup/principal/{principal}/resource/{resourceType}/operation/{operation} Summarizes what resources and rolebindings this principal is allowed to create.
PrivateRBACUIManageRoleBindingsApi ClusterAccessInfo Post /security/1.0/lookup/managed/clusters/principal/{principal} Identify the rolebinding abilities (view vs manage) the user has on the specified scope.
PrivateRBACUIManageRoleBindingsApi ManagedRoleBindings Post /security/1.0/lookup/managed/rolebindings/principal/{principal} Identify the rolebindings this user can see and manage.
PrivateRBACUIMyRoleBindingsApi MyRoleBindingsAll Get /security/1.0/lookup/rolebindings/principal/{principal} List all rolebindings for the specifed principal for all scopes and clusters that have any rolebindings.
PrivateRBACUIMyRoleBindingsApi MyRoleBindingsSingleScope Post /security/1.0/lookup/rolebindings/principal/{principal} List all rolebindings for the specifed principal and scope.
RBACRoleBindingCRUDApi AddRoleForPrincipal Post /security/1.0/principals/{principal}/roles/{roleName} Binds the principal to a cluster-scoped role for a specific cluster or in the given scope.
RBACRoleBindingCRUDApi AddRoleResourcesForPrincipal Post /security/1.0/principals/{principal}/roles/{roleName}/bindings Incrementally grant the resources to the principal at the given scope/cluster using the given role.
RBACRoleBindingCRUDApi DeleteRoleForPrincipal Delete /security/1.0/principals/{principal}/roles/{roleName} Remove the role (cluster or resource scoped) from the principal at the given scope/cluster.
RBACRoleBindingCRUDApi GetRoleResourcesForPrincipal Post /security/1.0/principals/{principal}/roles/{roleName}/resources Look up the rolebindings for the principal at the given scope/cluster using the given role.
RBACRoleBindingCRUDApi RemoveRoleResourcesForPrincipal Delete /security/1.0/principals/{principal}/roles/{roleName}/bindings Incrementally remove the resources from the principal at the given scope/cluster using the given role.
RBACRoleBindingCRUDApi SetRoleResourcesForPrincipal Put /security/1.0/principals/{principal}/roles/{roleName}/bindings Overwrite existing resource grants.
RBACRoleBindingSummariesApi LookupPrincipalsWithRole Post /security/1.0/lookup/role/{roleName} Look up the KafkaPrincipals who have the given role for the given scope.
RBACRoleBindingSummariesApi LookupPrincipalsWithRoleOnResource Post /security/1.0/lookup/role/{roleName}/resource/{resourceType}/name/{resourceName} Look up the KafkaPrincipals who have the given role on the specified resource for the given scope.
RBACRoleBindingSummariesApi LookupResourcesForPrincipal Post /security/1.0/lookup/principal/{principal}/resources Look up the resource bindings for the principal at the given scope/cluster.
RBACRoleBindingSummariesApi ScopedPrincipalRolenames Post /security/1.0/lookup/principals/{principal}/roleNames Returns the effective list of role names for a principal.
RBACRoleDefinitionsApi RoleDetail Get /security/1.0/roles/{roleName} List the resourceType and operations allowed for a given role.
RBACRoleDefinitionsApi Rolenames Get /security/1.0/roleNames Returns the names of all the roles defined in the system.
RBACRoleDefinitionsApi Roles Get /security/1.0/roles Returns all the roles defined in the system.
SSODeviceAuthorizationApi CheckDeviceAuth Post /security/1.0/oidc/device/check-auth Provides information about current status of user authentication
SSODeviceAuthorizationApi ExtendDeviceAuth Post /security/1.0/oidc/device/extend-auth Extend auth by generating a new token
SSODeviceAuthorizationApi Security10OidcDeviceAuthenticatePost Post /security/1.0/oidc/device/authenticate Provides user authentication details and device polling for authentication status
TokensAndAuthenticationApi GetToken Get /security/1.0/authenticate Get a bearer token.

Documentation For Models

Documentation For Authorization

basicAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), mdsv1.ContextBasicAuth, mdsv1.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

bearerAuth

  • Type: HTTP Bearer token authentication

Example

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

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	AuditLogConfigurationApi AuditLogConfigurationApi

	AuthorizationApi AuthorizationApi

	ClusterRegistryApi ClusterRegistryApi

	KafkaACLManagementApi KafkaACLManagementApi

	MetadataServiceOperationsApi MetadataServiceOperationsApi

	PrivateRBACUICachedUserStoreInformationApi PrivateRBACUICachedUserStoreInformationApi

	PrivateRBACUIClusterVisibilityApi PrivateRBACUIClusterVisibilityApi

	PrivateRBACUICreationGuidelinesApi PrivateRBACUICreationGuidelinesApi

	PrivateRBACUIManageRoleBindingsApi PrivateRBACUIManageRoleBindingsApi

	PrivateRBACUIMyRoleBindingsApi PrivateRBACUIMyRoleBindingsApi

	RBACRoleBindingCRUDApi RBACRoleBindingCRUDApi

	RBACRoleBindingSummariesApi RBACRoleBindingSummariesApi

	RBACRoleDefinitionsApi RBACRoleDefinitionsApi

	SSODeviceAuthorizationApi SSODeviceAuthorizationApi

	TokensAndAuthenticationApi TokensAndAuthenticationApi
	// contains filtered or unexported fields
}

APIClient manages communication with the MDS API API v1.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AccessControlEntry 

type AccessControlEntry struct {
	Principal      string            `json:"principal"`
	Host           string            `json:"host"`
	Operation      AclOperation      `json:"operation"`
	PermissionType AclPermissionType `json:"permissionType"`
}

AccessControlEntry struct for AccessControlEntry

type AccessControlEntryFilter 

type AccessControlEntryFilter struct {
	Principal      string            `json:"principal,omitempty"`
	Host           string            `json:"host,omitempty"`
	Operation      AclOperation      `json:"operation"`
	PermissionType AclPermissionType `json:"permissionType"`
}

AccessControlEntryFilter struct for AccessControlEntryFilter

type AccessPolicy 

type AccessPolicy struct {
	ScopeType         string      `json:"scopeType,omitempty"`
	AllowedOperations []Operation `json:"allowedOperations,omitempty"`
}

AccessPolicy struct for AccessPolicy

type AclBinding 

type AclBinding struct {
	Pattern KafkaResourcePattern `json:"pattern"`
	Entry   AccessControlEntry   `json:"entry"`
}

AclBinding struct for AclBinding

type AclBindingFilter 

type AclBindingFilter struct {
	PatternFilter KafkaResourcePatternFilter `json:"patternFilter"`
	EntryFilter   AccessControlEntryFilter   `json:"entryFilter"`
}

AclBindingFilter struct for AclBindingFilter

type AclFilterRequest 

type AclFilterRequest struct {
	Scope            KafkaScope       `json:"scope"`
	AclBindingFilter AclBindingFilter `json:"aclBindingFilter"`
}

AclFilterRequest struct for AclFilterRequest

type AclOperation 

type AclOperation string

AclOperation the model 'AclOperation' 

const (
	ACLOPERATION_UNKNOWN          AclOperation = "UNKNOWN"
	ACLOPERATION_ANY              AclOperation = "ANY"
	ACLOPERATION_ALL              AclOperation = "ALL"
	ACLOPERATION_READ             AclOperation = "READ"
	ACLOPERATION_WRITE            AclOperation = "WRITE"
	ACLOPERATION_CREATE           AclOperation = "CREATE"
	ACLOPERATION_DELETE           AclOperation = "DELETE"
	ACLOPERATION_ALTER            AclOperation = "ALTER"
	ACLOPERATION_DESCRIBE         AclOperation = "DESCRIBE"
	ACLOPERATION_CLUSTER_ACTION   AclOperation = "CLUSTER_ACTION"
	ACLOPERATION_DESCRIBE_CONFIGS AclOperation = "DESCRIBE_CONFIGS"
	ACLOPERATION_ALTER_CONFIGS    AclOperation = "ALTER_CONFIGS"
	ACLOPERATION_IDEMPOTENT_WRITE AclOperation = "IDEMPOTENT_WRITE"
)

List of AclOperation

type AclPermissionType 

type AclPermissionType string

AclPermissionType the model 'AclPermissionType' 

const (
	ACLPERMISSIONTYPE_UNKNOWN AclPermissionType = "UNKNOWN"
	ACLPERMISSIONTYPE_ANY     AclPermissionType = "ANY"
	ACLPERMISSIONTYPE_DENY    AclPermissionType = "DENY"
	ACLPERMISSIONTYPE_ALLOW   AclPermissionType = "ALLOW"
)

List of AclPermissionType

type AclResourceType 

type AclResourceType string

AclResourceType the model 'AclResourceType' 

const (
	ACLRESOURCETYPE_UNKNOWN          AclResourceType = "UNKNOWN"
	ACLRESOURCETYPE_ANY              AclResourceType = "ANY"
	ACLRESOURCETYPE_TOPIC            AclResourceType = "TOPIC"
	ACLRESOURCETYPE_GROUP            AclResourceType = "GROUP"
	ACLRESOURCETYPE_CLUSTER          AclResourceType = "CLUSTER"
	ACLRESOURCETYPE_TRANSACTIONAL_ID AclResourceType = "TRANSACTIONAL_ID"
)

List of AclResourceType

type Action 

type Action struct {
	Scope        Scope  `json:"scope"`
	Operation    string `json:"operation"`
	ResourceType string `json:"resourceType"`
	ResourceName string `json:"resourceName"`
}

Action struct for Action

type AuditLogConfigDefaultTopics 

type AuditLogConfigDefaultTopics struct {
	// The name of one of the destination Kafka topics, defined elsewhere in the audit log configuration, that shall receive messages about attempted actions when they are \"allowed\" by the system based on security access policies.  You can set this value to an empty string instead, to discard the \"allowed\" events routed here. The empty string is the only valid value other than one of the Kafka topic names in the spec's “destinations“ section.  This field specifies the default destination for events related to \"allowed\" actions in the following categories: “authentication“, “management“, and “authorize“. All other event categories are discarded by default. Events only follow the default behavior if they do not match any of the audit log configuration “routes“ CRN patterns, or if their selected route omits (or leaves “null“) the destination topic.
	Allowed string `json:"allowed"`
	// The name of one of the destination Kafka topics, defined elsewhere in the audit log configuration, that shall receive messages about attempted actions when they are \"denied\" by the system based on security access policies.  You can set this value to an empty string instead, to discard the \"denied\" events routed here.The empty string is the only valid value other than one of the Kafka topic names in the spec's “destinations“ section.  This field specifies the default destination for events related to \"denied\" actions in the following categories: “authentication“, “management“, and “authorize“. All other event categories are discarded by default. Events only follow the default behavior if they do not match any of the audit log configuration “routes“ CRN patterns, or if their selected route omits (or leaves “null“) the destination topic.
	Denied string `json:"denied"`
}

AuditLogConfigDefaultTopics struct for AuditLogConfigDefaultTopics

type AuditLogConfigDestinationConfig 

type AuditLogConfigDestinationConfig struct {
	// The number of milliseconds to keep events sent to this topic
	RetentionMs int64 `json:"retention_ms"`
}

AuditLogConfigDestinationConfig struct for AuditLogConfigDestinationConfig

type AuditLogConfigDestinations 

type AuditLogConfigDestinations struct {
	// A list of Kafka broker endpoints, used when configuring the Kafka producer(s) that will emit audit log events as they occur.  See Kafka Producer Configuration “bootstrap.servers“: https://kafka.apache.org/documentation/#producerconfigs
	BootstrapServers []string `json:"bootstrap_servers,omitempty"`
	// The destination Kafka topics that can receive audit log events. The keys are Kafka topic names used in routes within the audit log configuration specification. The values are the configuration details for each destination topic. Note that topic names must match the pattern “^confluent-audit-log-events[-_a-zA-Z0-9]*$“ and be 249 characters or less.
	Topics map[string]AuditLogConfigDestinationConfig `json:"topics"`
}

AuditLogConfigDestinations struct for AuditLogConfigDestinations

type AuditLogConfigListRoutesResponse 

type AuditLogConfigListRoutesResponse struct {
	DefaultTopics AuditLogConfigDefaultTopics `json:"default_topics,omitempty"`
	// Events are matched to exactly one of these route patterns (or else to the “default_topics“). The route patterns can be any valid Confluent resource name (CRN), or even a CRN containing wildcards. The most specific pattern that matches an event will be chosen. Consider these example route patterns that match events on Kafka topic resources. They are ordered here from most to least specific:  “crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/topic=clicks“  “crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/topic=*“  “crn://mds1.example.com/kafka=*_/topic=clicks“  “crn://mds1.example.com/kafka=*_/topic=*“  “crn:///kafka=abcde_FGHIJKL-01234567/topic=clicks“  “crn:///kafka=*_/topic=*“  For a CRN pattern to match a CRN, the Authority sections must match and the CRN pattern and the CRN must have all of the same path element types in the same order. The Authority section of a CRN is between the second and third slash (\"mds1.example.com\" in “crn://mds1.example.com/kafka=*_/topic=*“). It may be left empty (as in “crn:///kafka=*_/topic=*“). A CRN pattern with an empty Authority section matches a CRN with ANY Authority. The converse is not true: A CRN pattern with a non-empty Authority will not match a CRN with an empty Authority. A resource with an empty Authority CRN can only be matched by a CRN pattern with an empty Authority.  So an event on the resource with the CRN...  “crn://confluent.cloud/kafka=abcde_FGHIJKL-01234567/topic=clicks“  ... would not match a route with pattern ...  “crn://confluent.cloud/kafka=abcde_FGHIJKL-01234567“  ... because they do not have matching path element types.  Once the most specific matching route for an event is determined, it is then matched within that route to exactly one event category, and then based on whether it was \"allowed\" or \"denied\", matched to exactly one destination topic (or discarded, if the rule's destination topic name is the empty string). If the category rule's destination topic is “null“ then it either falls through to the “default_topics“ (for “authentication“, “authorize“, and “management“ categories), or is discarded (which is the default for all other categories of events).
	Routes *map[string]AuditLogConfigRouteCategories `json:"routes,omitempty"`
}

AuditLogConfigListRoutesResponse struct for AuditLogConfigListRoutesResponse

type AuditLogConfigMetadata 

type AuditLogConfigMetadata struct {
	// An opaque, server-generated marker, used to detect concurrent modification collisions. When submitting an update, the request will be rejected unless this value agrees with the version expected by the server. GET the current configuration first, to find out the expected “resource_version“.
	ResourceVersion string `json:"resource_version"`
	// When the audit log configuration was last modified. This value is set by the server, and ignored when submitted.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
	// When the server detects that the audit log configuration has been modified through another mechanism but is not sure when the modification occurred, the “updated_at“ property is renamed to “modified_since“. This value is set by the server, and ignored when submitted.
	ModifiedSince *time.Time `json:"modified_since,omitempty"`
}

AuditLogConfigMetadata struct for AuditLogConfigMetadata

type AuditLogConfigResolveResourceRouteResponse 

type AuditLogConfigResolveResourceRouteResponse struct {
	// The Confluent resource name (CRN) pattern of the route, or else the string “\"default\"“.
	Route      string                        `json:"route,omitempty"`
	Categories AuditLogConfigRouteCategories `json:"categories,omitempty"`
}

AuditLogConfigResolveResourceRouteResponse struct for AuditLogConfigResolveResourceRouteResponse

type AuditLogConfigRouteCategories 

type AuditLogConfigRouteCategories struct {
	Other          *AuditLogConfigRouteCategoryTopics `json:"other,omitempty"`
	Authentication *AuditLogConfigRouteCategoryTopics `json:"authentication,omitempty"`
	Authorize      *AuditLogConfigRouteCategoryTopics `json:"authorize,omitempty"`
	Management     *AuditLogConfigRouteCategoryTopics `json:"management,omitempty"`
	Produce        *AuditLogConfigRouteCategoryTopics `json:"produce,omitempty"`
	Consume        *AuditLogConfigRouteCategoryTopics `json:"consume,omitempty"`
	Interbroker    *AuditLogConfigRouteCategoryTopics `json:"interbroker,omitempty"`
	Heartbeat      *AuditLogConfigRouteCategoryTopics `json:"heartbeat,omitempty"`
	Describe       *AuditLogConfigRouteCategoryTopics `json:"describe,omitempty"`
}

AuditLogConfigRouteCategories Once the most specific matching route for an event is selected based on the event's associated resource (CRN), it is then matched within that route to exactly one event category rule, based on the category of event, and finally matched within the category rule to a logging destination based on whether the event was \"allowed\" or \"denied\". Event categories include “authorize“, “management“, “authentication“, “interbroker“, “produce“, “consume“, “heartbeat“, and “describe“. The “authorize“ category of events are those where the metadata service was asked to check whether the principal was authorized via RBAC to perform an operation on a resource. The “management“ category of events are those involving Kafka APIs that alter cluster or topic configuration settings, create, delete or modify topics or delegation tokens, initiate shutdown, etc. The “produce“, “consume“, “interbroker“, “heartbeat“, and “describe“ categories may include a potentially high volume of events. For example, every \"fetch\" request received by a Kafka broker from a Kafka consumer could result in one or more auditable events in the “consume“ category. Consider the possible write load on your audit log destination cluster before enabling audit logging for these categories. If the matched rule's logging destination is the empty string, the event is discarded. If the logging destination is “null“, matched events in the “authentication“, “authorize“ and “management“ categories will be routed to the corresponding entry in “default_topics“; but matched events in any other category will be discarded. Note: the “other“ category is deprecated and will be removed in a future version.

type AuditLogConfigRouteCategoryTopics 

type AuditLogConfigRouteCategoryTopics struct {
	// The name of one of the destination Kafka topics, defined elsewhere in the audit log configuration, that shall receive messages about attempted actions when they are \"allowed\" by the system based on security access policies.  You can set this value to an empty string, to discard the events instead.  You can set this value to “null“ (or omit this property) to use the default behavior. By default the “authentication“, “authorize“, and “management“ categories of events are routed according to the destination specified in “default_topics“. Events in all other categories are discarded by default.  The empty string or a “null“ value are the only valid values other than one of the defined destination Kafka topic names.  This route will only be selected for an event if the routing rule's CRN pattern matches the event's associated resource CRN, and its CRN pattern is the most specific among those that match the event.
	Allowed *string `json:"allowed"`
	// The name of one of the destination Kafka topics, defined elsewhere in the audit log configuration, that shall receive messages about attempted actions when they are \"denied\" by the system based on security access policies.  You can set this value to an empty string, to discard the events instead.  You can set this value to “null“ (or omit this property) to use the default behavior. By default the “authentication“, “authorize“, and “management“ categories of events are routed according to the destination specified in “default_topics“. Events in all other categories are discarded by default.  The empty string or a “null“ value are the only valid values other than one of the defined destination Kafka topic names.  This route will only be selected for an event if the routing rule's CRN pattern matches the event's associated resource CRN, and its CRN pattern is the most specific among those that match the event.
	Denied *string `json:"denied"`
}

AuditLogConfigRouteCategoryTopics struct for AuditLogConfigRouteCategoryTopics

type AuditLogConfigSpec 

type AuditLogConfigSpec struct {
	Destinations AuditLogConfigDestinations `json:"destinations"`
	// A list of security principals to exclude from the audit log. The list may be empty.
	ExcludedPrincipals *[]string                   `json:"excluded_principals,omitempty"`
	DefaultTopics      AuditLogConfigDefaultTopics `json:"default_topics"`
	// Events are matched to exactly one of these route patterns (or else to the “default_topics“). The route patterns can be any valid Confluent resource name (CRN), or even a CRN containing wildcards. The most specific pattern that matches an event will be chosen. Consider these example route patterns that match events on Kafka topic resources. They are ordered here from most to least specific:  “crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/topic=clicks“  “crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/topic=*“  “crn://mds1.example.com/kafka=*_/topic=clicks“  “crn://mds1.example.com/kafka=*_/topic=*“  “crn:///kafka=abcde_FGHIJKL-01234567/topic=clicks“  “crn:///kafka=*_/topic=*“  For a CRN pattern to match a CRN, the Authority sections must match and the CRN pattern and the CRN must have all of the same path element types in the same order. The Authority section of a CRN is between the second and third slash (\"mds1.example.com\" in “crn://mds1.example.com/kafka=*_/topic=*“). It may be left empty (as in “crn:///kafka=*_/topic=*“). A CRN pattern with an empty Authority section matches a CRN with ANY Authority. The converse is not true: A CRN pattern with a non-empty Authority will not match a CRN with an empty Authority. A resource with an empty Authority CRN can only be matched by a CRN pattern with an empty Authority.  So an event on the resource with the CRN...  “crn://confluent.cloud/kafka=abcde_FGHIJKL-01234567/topic=clicks“  ... would not match a route with pattern ...  “crn://confluent.cloud/kafka=abcde_FGHIJKL-01234567“  ... because they do not have matching path element types.  Once the most specific matching route for an event is determined, it is then matched within that route to exactly one event category, and then based on whether it was \"allowed\" or \"denied\", matched to exactly one destination topic (or discarded, if the rule's destination topic name is the empty string). If the category rule's destination topic is “null“ then it either falls through to the “default_topics“ (for “authentication“, “authorize“, and “management“ categories), or is discarded (which is the default for all other categories of events).
	Routes   *map[string]AuditLogConfigRouteCategories `json:"routes,omitempty"`
	Metadata *AuditLogConfigMetadata                   `json:"metadata"`
}

AuditLogConfigSpec struct for AuditLogConfigSpec

type AuditLogConfigurationApi 

type AuditLogConfigurationApi interface {

	/*
	 * GetConfig Get the entire audit log configuration, including the live retention time policy values (“retention_ms“) for the destination topics.
	 *
	 * Requires the \"AuditAdmin\" role on the metadata service (MDS) cluster and every Kafka cluster in the cluster registry.  Callable by Admins.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return AuditLogConfigSpec
	 */
	GetConfig(ctx _context.Context) (AuditLogConfigSpec, *_nethttp.Response, error)

	/*
	 * ListRoutes Lists all currently defined routes that match the queried resource or its sub-resources.
	 *
	 * Multiple routes may match a resource, but only the most specific route will be selected for events related to the resource. This endpoint returns all matching routes regardless of whether or not they would actually be selected, or ignored in favor of a more specific route.  Requires the \"AuditAdmin\" role on the metadata service (MDS) cluster and every Kafka cluster in the cluster registry.  Callable by Admins.  The CRN patterns in the audit log config routes can contain wildcards. So a route with a CRN pattern like ``crn://mds.example.com/kafka=*_/topic=finance-*`` would match events associated with the topic at address ``crn://mds.example.com/kafka=abc123/topic=finance-deposits``, or events associated with the topic at ``crn://mds.example.com/kafka=xyz789/topic=finance-chargebacks``, but would not match events associated with the topic ``crn://mds.example.com/kafka=abc123/topic=server-deployments``. So a route's CRN pattern can match events from more than one resource, based on where the pattern's wildcards are.  It is possible to write multiple routes with different CRN patterns that match a given resource's CRN. For example: the resource at ``crn://mds.example.com/kafka=abc123/topic=finance-chargebacks`` is matched by any of the following route CRN patterns:  * ``crn://mds.example.com/kafka=*_/topic=*`` * ``crn://mds.example.com/kafka=abc123/topic=*`` * ``crn://mds.example.com/kafka=*_/topic=finance-*``  When there are multiple matching routes for an event, we select the matching route with the most specific CRN pattern. The most specific CRN pattern is the one with the greatest length before its first wildcard. So in the above example, ``crn://mds.example.com/kafka=abc123/topic=*`` wins.  To break a tie, ignore the prefix that the patterns have in common. So, for example ``crn://mds.example.com/kafka=*_/topic=finance-*`` is more specific than ``crn://mds.example.com/kafka=*_/topic=*``.  This endpoint lists all currently defined routes that match the queried resource or its sub-resources, regardless of whether or not they would actually be selected, or ignored in favor of a more specific route.  A query pattern like ...  ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=qa-test``  ... would match all of the following routes ...  ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=qa-test/connector=from-db4``  ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=qa-test/connector=*``  ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=*_/connector=*``  ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=qa-*``  ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=*``  ``crn://mds1.example.com/kafka=*_/connect=qa-*``  ``crn://mds1.example.com/kafka=*_/connect=qa-*_/connector=*``  ... but would not match any of these routes ...  ``crn://mds1.example.com/kafka=*_/ksql=*``  ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567``  ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=stg-*``  ``crn://mds1.example.com/kafka=zyxwv-UTSRQPO_98765432/connect=qa-*``  ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/topic=qa-*``
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param optional nil or *ListRoutesOpts - Optional Parameters:
	 * @param "Q" (optional.String) -  A Confluent resource name (CRN) .
	 * @return AuditLogConfigListRoutesResponse
	 */
	ListRoutes(ctx _context.Context, localVarOptionals *ListRoutesOpts) (AuditLogConfigListRoutesResponse, *_nethttp.Response, error)

	/*
	 * PutConfig Update the entire audit log configuration on the MDS cluster and all Kafka clusters known to the cluster registry.
	 *
	 * Also creates missing destination topics on the destination cluster and updates the retention time policy of destination topics, if necessary.  Requires the \"AuditAdmin\" role on the MDS cluster and every Kafka cluster in the cluster registry.  May result in a 409 conflict error status if the ``resource_version`` in the JSON body of the request does not match the current version.  Callable by Admins.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param auditLogConfigSpec
	 * @return AuditLogConfigSpec
	 */
	PutConfig(ctx _context.Context, auditLogConfigSpec AuditLogConfigSpec) (AuditLogConfigSpec, *_nethttp.Response, error)

	/*
	 * ResolveResourceRoute Returns the route describing how messages regarding this CRN would be routed.
	 *
	 * Requires the \"AuditAdmin\" role on the metadata service (MDS) cluster and every Kafka cluster in the cluster registry.  The CRN patterns in the audit log config routes can contain wildcards. So a route with a CRN pattern like ``crn://mds.example.com/kafka=*_/topic=finance-*`` would match events associated with the topic at address ``crn://mds.example.com/kafka=abc123/topic=finance-deposits``, or events associated with the topic at ``crn://mds.example.com/kafka=xyz789/topic=finance-chargebacks``, but would not match events associated with the topic ``crn://mds.example.com/kafka=abc123/topic=server-deployments``. So a route's CRN pattern can match events from more than one resource, based on where the pattern's wildcards are.  It is possible to write multiple routes with different CRN patterns that match a given resource's CRN. For example: the resource at ``crn://mds.example.com/kafka=abc123/topic=finance-chargebacks`` is matched by any of the following route CRN patterns:  * ``crn://mds.example.com/kafka=*_/topic=*`` * ``crn://mds.example.com/kafka=abc123/topic=*`` * ``crn://mds.example.com/kafka=*_/topic=finance-*``  When there are multiple matching routes for an event, we select the matching route with the most specific CRN pattern. The most specific CRN pattern is the one with the greatest length before its first wildcard. So in the above example, ``crn://mds.example.com/kafka=abc123/topic=*`` wins.  To break a tie, ignore the prefix that the patterns have in common. So, for example ``crn://mds.example.com/kafka=*_/topic=finance-*`` is more specific than ``crn://mds.example.com/kafka=*_/topic=*``.  This endpoint resolves the matching and precedence rules of all configured audit log routes for you, and returns the one selected (most specific) matching route describing how messages regarding the given CRN would be routed. Callable by Admins.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param optional nil or *ResolveResourceRouteOpts - Optional Parameters:
	 * @param "Crn" (optional.String) -  A Confluent resource name (CRN).
	 * @return AuditLogConfigResolveResourceRouteResponse
	 */
	ResolveResourceRoute(ctx _context.Context, localVarOptionals *ResolveResourceRouteOpts) (AuditLogConfigResolveResourceRouteResponse, *_nethttp.Response, error)
}

type AuditLogConfigurationApiService 

type AuditLogConfigurationApiService service

AuditLogConfigurationApiService AuditLogConfigurationApi service

func (*AuditLogConfigurationApiService) GetConfig 

func (a *AuditLogConfigurationApiService) GetConfig(ctx _context.Context) (AuditLogConfigSpec, *_nethttp.Response, error)

* GetConfig Get the entire audit log configuration, including the live retention time policy values (“retention_ms“) for the destination topics. * * Requires the \"AuditAdmin\" role on the metadata service (MDS) cluster and every Kafka cluster in the cluster registry. Callable by Admins. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return AuditLogConfigSpec

func (*AuditLogConfigurationApiService) ListRoutes 

func (a *AuditLogConfigurationApiService) ListRoutes(ctx _context.Context, localVarOptionals *ListRoutesOpts) (AuditLogConfigListRoutesResponse, *_nethttp.Response, error)

* ListRoutes Lists all currently defined routes that match the queried resource or its sub-resources. * * Multiple routes may match a resource, but only the most specific route will be selected for events related to the resource. This endpoint returns all matching routes regardless of whether or not they would actually be selected, or ignored in favor of a more specific route. Requires the \"AuditAdmin\" role on the metadata service (MDS) cluster and every Kafka cluster in the cluster registry. Callable by Admins. The CRN patterns in the audit log config routes can contain wildcards. So a route with a CRN pattern like ``crn://mds.example.com/kafka=*_/topic=finance-*`` would match events associated with the topic at address ``crn://mds.example.com/kafka=abc123/topic=finance-deposits``, or events associated with the topic at ``crn://mds.example.com/kafka=xyz789/topic=finance-chargebacks``, but would not match events associated with the topic ``crn://mds.example.com/kafka=abc123/topic=server-deployments``. So a route's CRN pattern can match events from more than one resource, based on where the pattern's wildcards are. It is possible to write multiple routes with different CRN patterns that match a given resource's CRN. For example: the resource at ``crn://mds.example.com/kafka=abc123/topic=finance-chargebacks`` is matched by any of the following route CRN patterns: * ``crn://mds.example.com/kafka=*_/topic=*`` * ``crn://mds.example.com/kafka=abc123/topic=*`` * ``crn://mds.example.com/kafka=*_/topic=finance-*`` When there are multiple matching routes for an event, we select the matching route with the most specific CRN pattern. The most specific CRN pattern is the one with the greatest length before its first wildcard. So in the above example, ``crn://mds.example.com/kafka=abc123/topic=*`` wins. To break a tie, ignore the prefix that the patterns have in common. So, for example ``crn://mds.example.com/kafka=*_/topic=finance-*`` is more specific than ``crn://mds.example.com/kafka=*_/topic=*``. This endpoint lists all currently defined routes that match the queried resource or its sub-resources, regardless of whether or not they would actually be selected, or ignored in favor of a more specific route. A query pattern like ... ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=qa-test`` ... would match all of the following routes ... ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=qa-test/connector=from-db4`` ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=qa-test/connector=*`` ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=*_/connector=*`` ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=qa-*`` ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=*`` ``crn://mds1.example.com/kafka=*_/connect=qa-*`` ``crn://mds1.example.com/kafka=*_/connect=qa-*_/connector=*`` ... but would not match any of these routes ... ``crn://mds1.example.com/kafka=*_/ksql=*`` ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567`` ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/connect=stg-*`` ``crn://mds1.example.com/kafka=zyxwv-UTSRQPO_98765432/connect=qa-*`` ``crn://mds1.example.com/kafka=abcde_FGHIJKL-01234567/topic=qa-*`` * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param optional nil or *ListRoutesOpts - Optional Parameters: * @param "Q" (optional.String) - A Confluent resource name (CRN) . * @return AuditLogConfigListRoutesResponse

func (*AuditLogConfigurationApiService) PutConfig 

func (a *AuditLogConfigurationApiService) PutConfig(ctx _context.Context, auditLogConfigSpec AuditLogConfigSpec) (AuditLogConfigSpec, *_nethttp.Response, error)

* PutConfig Update the entire audit log configuration on the MDS cluster and all Kafka clusters known to the cluster registry. * * Also creates missing destination topics on the destination cluster and updates the retention time policy of destination topics, if necessary. Requires the \"AuditAdmin\" role on the MDS cluster and every Kafka cluster in the cluster registry. May result in a 409 conflict error status if the ``resource_version`` in the JSON body of the request does not match the current version. Callable by Admins. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param auditLogConfigSpec * @return AuditLogConfigSpec

func (*AuditLogConfigurationApiService) ResolveResourceRoute 

func (a *AuditLogConfigurationApiService) ResolveResourceRoute(ctx _context.Context, localVarOptionals *ResolveResourceRouteOpts) (AuditLogConfigResolveResourceRouteResponse, *_nethttp.Response, error)

* ResolveResourceRoute Returns the route describing how messages regarding this CRN would be routed. * * Requires the \"AuditAdmin\" role on the metadata service (MDS) cluster and every Kafka cluster in the cluster registry. The CRN patterns in the audit log config routes can contain wildcards. So a route with a CRN pattern like ``crn://mds.example.com/kafka=*_/topic=finance-*`` would match events associated with the topic at address ``crn://mds.example.com/kafka=abc123/topic=finance-deposits``, or events associated with the topic at ``crn://mds.example.com/kafka=xyz789/topic=finance-chargebacks``, but would not match events associated with the topic ``crn://mds.example.com/kafka=abc123/topic=server-deployments``. So a route's CRN pattern can match events from more than one resource, based on where the pattern's wildcards are. It is possible to write multiple routes with different CRN patterns that match a given resource's CRN. For example: the resource at ``crn://mds.example.com/kafka=abc123/topic=finance-chargebacks`` is matched by any of the following route CRN patterns: * ``crn://mds.example.com/kafka=*_/topic=*`` * ``crn://mds.example.com/kafka=abc123/topic=*`` * ``crn://mds.example.com/kafka=*_/topic=finance-*`` When there are multiple matching routes for an event, we select the matching route with the most specific CRN pattern. The most specific CRN pattern is the one with the greatest length before its first wildcard. So in the above example, ``crn://mds.example.com/kafka=abc123/topic=*`` wins. To break a tie, ignore the prefix that the patterns have in common. So, for example ``crn://mds.example.com/kafka=*_/topic=finance-*`` is more specific than ``crn://mds.example.com/kafka=*_/topic=*``. This endpoint resolves the matching and precedence rules of all configured audit log routes for you, and returns the one selected (most specific) matching route describing how messages regarding the given CRN would be routed. Callable by Admins. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param optional nil or *ResolveResourceRouteOpts - Optional Parameters: * @param "Crn" (optional.String) - A Confluent resource name (CRN). * @return AuditLogConfigResolveResourceRouteResponse

type AuthenticationResponse 

type AuthenticationResponse struct {
	AuthToken string  `json:"auth_token,omitempty"`
	TokenType string  `json:"token_type,omitempty"`
	ExpiresIn float32 `json:"expires_in,omitempty"`
}

AuthenticationResponse struct for AuthenticationResponse

type AuthorizationApi 

type AuthorizationApi interface {

	/*
	 * Authorize Authorize operations against resourceType for a given user.
	 *
	 * Callable by Admins+User.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param authorizeRequest
	 * @return []string
	 */
	Authorize(ctx _context.Context, authorizeRequest AuthorizeRequest) ([]string, *_nethttp.Response, error)
}

type AuthorizationApiService 

type AuthorizationApiService service

AuthorizationApiService AuthorizationApi service

func (*AuthorizationApiService) Authorize 

func (a *AuthorizationApiService) Authorize(ctx _context.Context, authorizeRequest AuthorizeRequest) ([]string, *_nethttp.Response, error)

* Authorize Authorize operations against resourceType for a given user. * * Callable by Admins+User. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param authorizeRequest * @return []string

type AuthorizeRequest 

type AuthorizeRequest struct {
	// The 'target' user principal.
	UserPrincipal string `json:"userPrincipal"`
	// Actions to authorize.
	Actions []Action `json:"actions"`
}

AuthorizeRequest struct for AuthorizeRequest

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CheckDeviceAuthRequest 

type CheckDeviceAuthRequest struct {
	// The user code associated with the authentication request
	UserCode string `json:"user_code"`
	// An encrypted key to check the status of authentication
	Key string `json:"key"`
}

CheckDeviceAuthRequest struct for CheckDeviceAuthRequest

type CheckDeviceAuthResponse 

type CheckDeviceAuthResponse struct {
	// The user code associated with the authentication request
	UserCode string `json:"user_code,omitempty"`
	// Indicates whether the authentication is complete or error happened
	Complete bool `json:"complete,omitempty"`
	// The error message, if some error happened
	Error string `json:"error,omitempty"`
	// The status of the authentication process
	Status string `json:"status,omitempty"`
	// A description of the error or status
	Description string `json:"description,omitempty"`
	// The authentication token, if available
	AuthToken string `json:"auth_token,omitempty"`
	// The encrypted refresh token, if available
	RefreshToken string `json:"refresh_token,omitempty"`
	// The duration (in seconds) for which the token is valid
	ExpiresIn int32 `json:"expires_in,omitempty"`
}

CheckDeviceAuthResponse struct for CheckDeviceAuthResponse

type ClusterAccessInfo 

type ClusterAccessInfo struct {
	Cluster   []string                       `json:"cluster,omitempty"`
	Resources map[string]map[string][]string `json:"resources,omitempty"`
}

ClusterAccessInfo struct for ClusterAccessInfo

type ClusterInfo 

type ClusterInfo struct {
	ClusterName string     `json:"clusterName,omitempty"`
	Scope       Scope      `json:"scope,omitempty"`
	Hosts       []HostInfo `json:"hosts,omitempty"`
	Protocol    Protocol   `json:"protocol,omitempty"`
}

ClusterInfo struct for ClusterInfo

type ClusterRegistryApi 

type ClusterRegistryApi interface {

	/*
	 * ClusterRegistryList Returns a list of all clusters in the registry, optionally filtered by cluster type.
	 *
	 * If the calling principal doesn't have permissions to see the full cluster info, some information (\"hosts\", \"protocol\", etc) is redacted.  Callable by Admins+User.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param optional nil or *ClusterRegistryListOpts - Optional Parameters:
	 * @param "ClusterType" (optional.String) -  Optionally filter down by cluster type.
	 * @return []ClusterInfo
	 */
	ClusterRegistryList(ctx _context.Context, localVarOptionals *ClusterRegistryListOpts) ([]ClusterInfo, *_nethttp.Response, error)

	/*
	 * DeleteNamedCluster Remove a named cluster from the registry.
	 *
	 * Callable by Admins.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterName The name of cluster (ASCII printable characters without spaces).
	 */
	DeleteNamedCluster(ctx _context.Context, clusterName string) (*_nethttp.Response, error)

	/*
	 * GetNamedCluster Returns the information for a single named cluster, assuming the cluster exists and is visible to the calling principal.
	 *
	 * Callable by Admins+User.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterName The name of cluster (ASCII printable characters without spaces).
	 * @return ClusterInfo
	 */
	GetNamedCluster(ctx _context.Context, clusterName string) (ClusterInfo, *_nethttp.Response, error)

	/*
	 * UpdateClusters Define/overwrite named clusters.
	 *
	 * May result in a 409 Conflict if the name and scope combination of any cluster conflicts with existing clusters in the registry.  Callable by Admins.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterInfo
	 */
	UpdateClusters(ctx _context.Context, clusterInfo []ClusterInfo) (*_nethttp.Response, error)
}

type ClusterRegistryApiService 

type ClusterRegistryApiService service

ClusterRegistryApiService ClusterRegistryApi service

func (*ClusterRegistryApiService) ClusterRegistryList 

func (a *ClusterRegistryApiService) ClusterRegistryList(ctx _context.Context, localVarOptionals *ClusterRegistryListOpts) ([]ClusterInfo, *_nethttp.Response, error)

* ClusterRegistryList Returns a list of all clusters in the registry, optionally filtered by cluster type. * * If the calling principal doesn't have permissions to see the full cluster info, some information (\"hosts\", \"protocol\", etc) is redacted. Callable by Admins+User. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param optional nil or *ClusterRegistryListOpts - Optional Parameters: * @param "ClusterType" (optional.String) - Optionally filter down by cluster type. * @return []ClusterInfo

func (*ClusterRegistryApiService) DeleteNamedCluster 

func (a *ClusterRegistryApiService) DeleteNamedCluster(ctx _context.Context, clusterName string) (*_nethttp.Response, error)

* DeleteNamedCluster Remove a named cluster from the registry. * * Callable by Admins. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterName The name of cluster (ASCII printable characters without spaces).

func (*ClusterRegistryApiService) GetNamedCluster 

func (a *ClusterRegistryApiService) GetNamedCluster(ctx _context.Context, clusterName string) (ClusterInfo, *_nethttp.Response, error)

* GetNamedCluster Returns the information for a single named cluster, assuming the cluster exists and is visible to the calling principal. * * Callable by Admins+User. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterName The name of cluster (ASCII printable characters without spaces). * @return ClusterInfo

func (*ClusterRegistryApiService) UpdateClusters 

func (a *ClusterRegistryApiService) UpdateClusters(ctx _context.Context, clusterInfo []ClusterInfo) (*_nethttp.Response, error)

* UpdateClusters Define/overwrite named clusters. * * May result in a 409 Conflict if the name and scope combination of any cluster conflicts with existing clusters in the registry. Callable by Admins. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterInfo

type ClusterRegistryListOpts 

type ClusterRegistryListOpts struct {
	ClusterType optional.String
}

ClusterRegistryListOpts Optional parameters for the method 'ClusterRegistryList'

type ClusterVisibility 

type ClusterVisibility struct {
	Id          string  `json:"id,omitempty"`
	Visible     bool    `json:"visible,omitempty"`
	ClusterName *string `json:"clusterName,omitempty"`
}

ClusterVisibility struct for ClusterVisibility

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type CreateAclRequest 

type CreateAclRequest struct {
	Scope      KafkaScope `json:"scope"`
	AclBinding AclBinding `json:"aclBinding"`
}

CreateAclRequest struct for CreateAclRequest

type ErrorDetail 

type ErrorDetail struct {
	ErrorType string `json:"error_type"`
	Message   string `json:"message,omitempty"`
}

ErrorDetail struct for ErrorDetail

type ErrorResponse 

type ErrorResponse struct {
	// Optional - http status code
	StatusCode int32 `json:"status_code,omitempty"`
	// Optional - Kafka error code (typically 5 digits)
	ErrorCode int32 `json:"error_code,omitempty"`
	// Optional - Type of error
	Type string `json:"type,omitempty"`
	// Required - Top level error message
	Message string `json:"message"`
	// Optional - List of errors
	Errors []ErrorDetail `json:"errors,omitempty"`
}

ErrorResponse struct for ErrorResponse

type ExtendAuthRequest 

type ExtendAuthRequest struct {
	// The auth token received from the device authentication
	AccessToken string `json:"access_token,omitempty"`
	// The encrypted refresh token
	RefreshToken string `json:"refresh_token,omitempty"`
}

ExtendAuthRequest struct for ExtendAuthRequest

type ExtendAuthResponse 

type ExtendAuthResponse struct {
	// The authentication token
	AuthToken string `json:"auth_token,omitempty"`
	// The duration (in seconds) for which the token is valid
	ExpiresIn int64 `json:"expires_in,omitempty"`
}

ExtendAuthResponse struct for ExtendAuthResponse

type FeaturesInfo 

type FeaturesInfo struct {
	Features map[string]bool   `json:"features,omitempty"`
	Legend   map[string]string `json:"legend,omitempty"`
}

FeaturesInfo struct for FeaturesInfo

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type HostInfo 

type HostInfo struct {
	Host string `json:"host,omitempty"`
	Port int32  `json:"port,omitempty"`
}

HostInfo struct for HostInfo

type InitDeviceAuthResponse 

type InitDeviceAuthResponse struct {
	// The user code for device authentication
	UserCode string `json:"user_code,omitempty"`
	// The verification URI for the user to visit
	VerificationUri string `json:"verification_uri,omitempty"`
	// The key to be used for checking authentication
	Key string `json:"key,omitempty"`
	// The interval for polling to check authentication
	Interval int32 `json:"interval,omitempty"`
	// The validity of verification URI in seconds. User must authorize within this time
	ExpiresIn float32 `json:"expires_in,omitempty"`
}

InitDeviceAuthResponse struct for InitDeviceAuthResponse

type KafkaACLManagementApi 

type KafkaACLManagementApi interface {

	/*
	 * AddAclBinding Creates Kafka ACLs for given AclBinding.
	 *
	 * Callable by Admins+AclUsers.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param createAclRequest
	 */
	AddAclBinding(ctx _context.Context, createAclRequest CreateAclRequest) (*_nethttp.Response, error)

	/*
	 * RemoveAclBindings Deletes Kafka ACLs according to the supplied filter.
	 *
	 * Callable by Admins+AclUsers.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param aclFilterRequest
	 * @return []AclBinding
	 */
	RemoveAclBindings(ctx _context.Context, aclFilterRequest AclFilterRequest) ([]AclBinding, *_nethttp.Response, error)

	/*
	 * SearchAclBinding Lists Kafka ACLs according to the supplied filter.
	 *
	 * Callable by Admins+AclUsers.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param aclFilterRequest
	 * @return []AclBinding
	 */
	SearchAclBinding(ctx _context.Context, aclFilterRequest AclFilterRequest) ([]AclBinding, *_nethttp.Response, error)
}

type KafkaACLManagementApiService 

type KafkaACLManagementApiService service

KafkaACLManagementApiService KafkaACLManagementApi service

func (*KafkaACLManagementApiService) AddAclBinding 

func (a *KafkaACLManagementApiService) AddAclBinding(ctx _context.Context, createAclRequest CreateAclRequest) (*_nethttp.Response, error)

* AddAclBinding Creates Kafka ACLs for given AclBinding. * * Callable by Admins+AclUsers. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param createAclRequest

func (*KafkaACLManagementApiService) RemoveAclBindings 

func (a *KafkaACLManagementApiService) RemoveAclBindings(ctx _context.Context, aclFilterRequest AclFilterRequest) ([]AclBinding, *_nethttp.Response, error)

* RemoveAclBindings Deletes Kafka ACLs according to the supplied filter. * * Callable by Admins+AclUsers. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param aclFilterRequest * @return []AclBinding

func (*KafkaACLManagementApiService) SearchAclBinding 

func (a *KafkaACLManagementApiService) SearchAclBinding(ctx _context.Context, aclFilterRequest AclFilterRequest) ([]AclBinding, *_nethttp.Response, error)

* SearchAclBinding Lists Kafka ACLs according to the supplied filter. * * Callable by Admins+AclUsers. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param aclFilterRequest * @return []AclBinding

type KafkaResourcePattern 

type KafkaResourcePattern struct {
	ResourceType AclResourceType `json:"resourceType"`
	Name         string          `json:"name"`
	PatternType  PatternType     `json:"patternType"`
}

KafkaResourcePattern struct for KafkaResourcePattern

type KafkaResourcePatternFilter 

type KafkaResourcePatternFilter struct {
	ResourceType AclResourceType `json:"resourceType"`
	Name         string          `json:"name,omitempty"`
	PatternType  PatternType     `json:"patternType"`
}

KafkaResourcePatternFilter struct for KafkaResourcePatternFilter

type KafkaScope 

type KafkaScope struct {
	Clusters KafkaScopeClusters `json:"clusters"`
}

KafkaScope struct for KafkaScope

type KafkaScopeClusters 

type KafkaScopeClusters struct {
	KafkaCluster string `json:"kafka-cluster"`
}

KafkaScopeClusters struct for KafkaScopeClusters

type ListManagedClustersOpts 

type ListManagedClustersOpts struct {
	ClusterType optional.String
}

ListManagedClustersOpts Optional parameters for the method 'ListManagedClusters'

type ListRoutesOpts 

type ListRoutesOpts struct {
	Q optional.String
}

ListRoutesOpts Optional parameters for the method 'ListRoutes'

type ManagedResourceBinding 

type ManagedResourceBinding struct {
	Role            string `json:"role,omitempty"`
	ResourceType    string `json:"resourceType,omitempty"`
	ResourceName    string `json:"resourceName,omitempty"`
	ResourcePattern string `json:"resourcePattern,omitempty"`
	AlterAccess     bool   `json:"alterAccess,omitempty"`
}

ManagedResourceBinding struct for ManagedResourceBinding

type ManagedRoleBindings 

type ManagedRoleBindings struct {
	Scope                Scope                                          `json:"scope,omitempty"`
	ClusterRoleBindings  map[string]map[string][]string                 `json:"cluster_role_bindings,omitempty"`
	ResourceRoleBindings map[string]map[string][]ManagedResourceBinding `json:"resource_role_bindings,omitempty"`
}

ManagedRoleBindings struct for ManagedRoleBindings

type ManagedRoleBindingsOpts 

type ManagedRoleBindingsOpts struct {
	ResourceType optional.String
}

ManagedRoleBindingsOpts Optional parameters for the method 'ManagedRoleBindings'

type MdsScope 

type MdsScope struct {
	ClusterName string        `json:"clusterName,omitempty"`
	Clusters    ScopeClusters `json:"clusters,omitempty"`
}

MdsScope struct for MdsScope

type MetadataServiceOperationsApi 

type MetadataServiceOperationsApi interface {

	/*
	 * Activenodes Returns all the nodes running the Metadata Service REST API.
	 *
	 * Clients are expected to round robin call to these endpoints if they don't set up a load balancer in front of the Metadata Service nodes.  Callable by LDAP users.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param protocol Should be \"http\" or \"https\".
	 * @return []string
	 */
	Activenodes(ctx _context.Context, protocol string) ([]string, *_nethttp.Response, error)

	/*
	 * Features What features the running version of MDS supports.
	 *
	 * This endpoint does not require authentication.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return FeaturesInfo
	 */
	Features(ctx _context.Context) (FeaturesInfo, *_nethttp.Response, error)

	/*
	 * MetadataClusterId Returns the ID of the Kafka cluster that MDS is running on.
	 *
	 * Callable by LDAP users.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return string
	 */
	MetadataClusterId(ctx _context.Context) (string, *_nethttp.Response, error)
}

type MetadataServiceOperationsApiService 

type MetadataServiceOperationsApiService service

MetadataServiceOperationsApiService MetadataServiceOperationsApi service

func (*MetadataServiceOperationsApiService) Activenodes 

func (a *MetadataServiceOperationsApiService) Activenodes(ctx _context.Context, protocol string) ([]string, *_nethttp.Response, error)

* Activenodes Returns all the nodes running the Metadata Service REST API. * * Clients are expected to round robin call to these endpoints if they don't set up a load balancer in front of the Metadata Service nodes. Callable by LDAP users. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param protocol Should be \"http\" or \"https\". * @return []string

func (*MetadataServiceOperationsApiService) Features 

func (a *MetadataServiceOperationsApiService) Features(ctx _context.Context) (FeaturesInfo, *_nethttp.Response, error)

* Features What features the running version of MDS supports. * * This endpoint does not require authentication. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return FeaturesInfo

func (*MetadataServiceOperationsApiService) MetadataClusterId 

func (a *MetadataServiceOperationsApiService) MetadataClusterId(ctx _context.Context) (string, *_nethttp.Response, error)

* MetadataClusterId Returns the ID of the Kafka cluster that MDS is running on. * * Callable by LDAP users. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return string

type MyRoleBindingsAllOpts 

type MyRoleBindingsAllOpts struct {
	ClusterType optional.String
}

MyRoleBindingsAllOpts Optional parameters for the method 'MyRoleBindingsAll'

type Operation 

type Operation struct {
	ResourceType string   `json:"resourceType,omitempty"`
	Operations   []string `json:"operations,omitempty"`
}

Operation struct for Operation

type PatternType 

type PatternType string

PatternType the model 'PatternType' 

const (
	PATTERNTYPE_UNKNOWN  PatternType = "UNKNOWN"
	PATTERNTYPE_ANY      PatternType = "ANY"
	PATTERNTYPE_MATCH    PatternType = "MATCH"
	PATTERNTYPE_LITERAL  PatternType = "LITERAL"
	PATTERNTYPE_PREFIXED PatternType = "PREFIXED"
)

List of PatternType

type PrivateRBACUICachedUserStoreInformationApi 

type PrivateRBACUICachedUserStoreInformationApi interface {

	/*
	 * UsersGroupsList List of MDS cached users and groups.
	 *
	 * For use by a rolebinding admin on the provided scope.  Callable by Admins+ResourceOwners, but not broker super.users.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param scope
	 * @param optional nil or *UsersGroupsListOpts - Optional Parameters:
	 * @param "Type_" (optional.String) -  The type of principals requested.
	 * @return []string
	 */
	UsersGroupsList(ctx _context.Context, scope Scope, localVarOptionals *UsersGroupsListOpts) ([]string, *_nethttp.Response, error)
}

type PrivateRBACUICachedUserStoreInformationApiService 

type PrivateRBACUICachedUserStoreInformationApiService service

PrivateRBACUICachedUserStoreInformationApiService PrivateRBACUICachedUserStoreInformationApi service

func (*PrivateRBACUICachedUserStoreInformationApiService) UsersGroupsList 

func (a *PrivateRBACUICachedUserStoreInformationApiService) UsersGroupsList(ctx _context.Context, scope Scope, localVarOptionals *UsersGroupsListOpts) ([]string, *_nethttp.Response, error)

* UsersGroupsList List of MDS cached users and groups. * * For use by a rolebinding admin on the provided scope. Callable by Admins+ResourceOwners, but not broker super.users. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param scope * @param optional nil or *UsersGroupsListOpts - Optional Parameters: * @param "Type_" (optional.String) - The type of principals requested. * @return []string

type PrivateRBACUIClusterVisibilityApi 

type PrivateRBACUIClusterVisibilityApi interface {

	/*
	 * ListManagedClusters Identifies the scopes for the rolebindings that a user can see.
	 *
	 * May include rolebindings from scopes and clusters that never existed or previously existed (in other words, rolebindings that have been decommissioned, but are still defined in the system).  Callable by Admins+User.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param optional nil or *ListManagedClustersOpts - Optional Parameters:
	 * @param "ClusterType" (optional.String) -  Filter down by cluster type.
	 * @return []Scope
	 */
	ListManagedClusters(ctx _context.Context, principal string, localVarOptionals *ListManagedClustersOpts) ([]Scope, *_nethttp.Response, error)

	/*
	 * Visibility Endpoint for Confluent Control Center to determine visibilty of Kafka and its sub-clusters for the specifed principal.
	 *
	 * The intent is that this endpoint is called with cluster IDs that actually exist.  Callable by Admins+User.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param visibilityRequest
	 * @return VisibilityResponse
	 */
	Visibility(ctx _context.Context, principal string, visibilityRequest []VisibilityRequest) (VisibilityResponse, *_nethttp.Response, error)
}

type PrivateRBACUIClusterVisibilityApiService 

type PrivateRBACUIClusterVisibilityApiService service

PrivateRBACUIClusterVisibilityApiService PrivateRBACUIClusterVisibilityApi service

func (*PrivateRBACUIClusterVisibilityApiService) ListManagedClusters 

func (a *PrivateRBACUIClusterVisibilityApiService) ListManagedClusters(ctx _context.Context, principal string, localVarOptionals *ListManagedClustersOpts) ([]Scope, *_nethttp.Response, error)

* ListManagedClusters Identifies the scopes for the rolebindings that a user can see. * * May include rolebindings from scopes and clusters that never existed or previously existed (in other words, rolebindings that have been decommissioned, but are still defined in the system). Callable by Admins+User. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param optional nil or *ListManagedClustersOpts - Optional Parameters: * @param "ClusterType" (optional.String) - Filter down by cluster type. * @return []Scope

func (*PrivateRBACUIClusterVisibilityApiService) Visibility 

func (a *PrivateRBACUIClusterVisibilityApiService) Visibility(ctx _context.Context, principal string, visibilityRequest []VisibilityRequest) (VisibilityResponse, *_nethttp.Response, error)

* Visibility Endpoint for Confluent Control Center to determine visibilty of Kafka and its sub-clusters for the specifed principal. * * The intent is that this endpoint is called with cluster IDs that actually exist. Callable by Admins+User. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param visibilityRequest * @return VisibilityResponse

type PrivateRBACUICreationGuidelinesApi 

type PrivateRBACUICreationGuidelinesApi interface {

	/*
	 * LookupCreateGuidelines Summarizes what resources and rolebindings this principal is allowed to create.
	 *
	 * Callable by Admins+User.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param resourceType The type of resource to create or the type of resource to specify when creating a new rolebinding.
	 * @param operation \"Create\" for creating an actual resource, \"AlterAccess\" for creating a rolebinding for a user.
	 * @param scope
	 * @return map[string]interface{}
	 */
	LookupCreateGuidelines(ctx _context.Context, principal string, resourceType string, operation string, scope Scope) (map[string]interface{}, *_nethttp.Response, error)
}

type PrivateRBACUICreationGuidelinesApiService 

type PrivateRBACUICreationGuidelinesApiService service

PrivateRBACUICreationGuidelinesApiService PrivateRBACUICreationGuidelinesApi service

func (*PrivateRBACUICreationGuidelinesApiService) LookupCreateGuidelines 

func (a *PrivateRBACUICreationGuidelinesApiService) LookupCreateGuidelines(ctx _context.Context, principal string, resourceType string, operation string, scope Scope) (map[string]interface{}, *_nethttp.Response, error)

* LookupCreateGuidelines Summarizes what resources and rolebindings this principal is allowed to create. * * Callable by Admins+User. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param resourceType The type of resource to create or the type of resource to specify when creating a new rolebinding. * @param operation \"Create\" for creating an actual resource, \"AlterAccess\" for creating a rolebinding for a user. * @param scope * @return map[string]interface{}

type PrivateRBACUIManageRoleBindingsApi 

type PrivateRBACUIManageRoleBindingsApi interface {

	/*
	 * ClusterAccessInfo Identify the rolebinding abilities (view vs manage) the user has on the specified scope.
	 *
	 * Used by the Confluent Control Center UI to control access to rolebinding add/remove buttons.  Callable by Admins+ResourceOwners.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param scope
	 * @return ClusterAccessInfo
	 */
	ClusterAccessInfo(ctx _context.Context, principal string, scope Scope) (ClusterAccessInfo, *_nethttp.Response, error)

	/*
	 * ManagedRoleBindings Identify the rolebindings this user can see and manage.
	 *
	 * Callable by Admins+ResourceOwners.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param scope
	 * @param optional nil or *ManagedRoleBindingsOpts - Optional Parameters:
	 * @param "ResourceType" (optional.String) -  Filter down by resource type.
	 * @return ManagedRoleBindings
	 */
	ManagedRoleBindings(ctx _context.Context, principal string, scope Scope, localVarOptionals *ManagedRoleBindingsOpts) (ManagedRoleBindings, *_nethttp.Response, error)
}

type PrivateRBACUIManageRoleBindingsApiService 

type PrivateRBACUIManageRoleBindingsApiService service

PrivateRBACUIManageRoleBindingsApiService PrivateRBACUIManageRoleBindingsApi service

func (*PrivateRBACUIManageRoleBindingsApiService) ClusterAccessInfo 

func (a *PrivateRBACUIManageRoleBindingsApiService) ClusterAccessInfo(ctx _context.Context, principal string, scope Scope) (ClusterAccessInfo, *_nethttp.Response, error)

* ClusterAccessInfo Identify the rolebinding abilities (view vs manage) the user has on the specified scope. * * Used by the Confluent Control Center UI to control access to rolebinding add/remove buttons. Callable by Admins+ResourceOwners. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param scope * @return ClusterAccessInfo

func (*PrivateRBACUIManageRoleBindingsApiService) ManagedRoleBindings 

func (a *PrivateRBACUIManageRoleBindingsApiService) ManagedRoleBindings(ctx _context.Context, principal string, scope Scope, localVarOptionals *ManagedRoleBindingsOpts) (ManagedRoleBindings, *_nethttp.Response, error)

* ManagedRoleBindings Identify the rolebindings this user can see and manage. * * Callable by Admins+ResourceOwners. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param scope * @param optional nil or *ManagedRoleBindingsOpts - Optional Parameters: * @param "ResourceType" (optional.String) - Filter down by resource type. * @return ManagedRoleBindings

type PrivateRBACUIMyRoleBindingsApi 

type PrivateRBACUIMyRoleBindingsApi interface {

	/*
	 * MyRoleBindingsAll List all rolebindings for the specifed principal for all scopes and clusters that have any rolebindings.
	 *
	 * Be aware that this simply looks at the rolebinding data, and does not mean that the clusters actually exist.  Callable by Admins+User.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param optional nil or *MyRoleBindingsAllOpts - Optional Parameters:
	 * @param "ClusterType" (optional.String) -  Filter down by a cluster type.
	 * @return []ScopeRoleBindingMapping
	 */
	MyRoleBindingsAll(ctx _context.Context, principal string, localVarOptionals *MyRoleBindingsAllOpts) ([]ScopeRoleBindingMapping, *_nethttp.Response, error)

	/*
	 * MyRoleBindingsSingleScope List all rolebindings for the specifed principal and scope.
	 *
	 * Callable by Admins+User.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param scope
	 * @return ScopeRoleBindingMapping
	 */
	MyRoleBindingsSingleScope(ctx _context.Context, principal string, scope Scope) (ScopeRoleBindingMapping, *_nethttp.Response, error)
}

type PrivateRBACUIMyRoleBindingsApiService 

type PrivateRBACUIMyRoleBindingsApiService service

PrivateRBACUIMyRoleBindingsApiService PrivateRBACUIMyRoleBindingsApi service

func (*PrivateRBACUIMyRoleBindingsApiService) MyRoleBindingsAll 

func (a *PrivateRBACUIMyRoleBindingsApiService) MyRoleBindingsAll(ctx _context.Context, principal string, localVarOptionals *MyRoleBindingsAllOpts) ([]ScopeRoleBindingMapping, *_nethttp.Response, error)

* MyRoleBindingsAll List all rolebindings for the specifed principal for all scopes and clusters that have any rolebindings. * * Be aware that this simply looks at the rolebinding data, and does not mean that the clusters actually exist. Callable by Admins+User. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param optional nil or *MyRoleBindingsAllOpts - Optional Parameters: * @param "ClusterType" (optional.String) - Filter down by a cluster type. * @return []ScopeRoleBindingMapping

func (*PrivateRBACUIMyRoleBindingsApiService) MyRoleBindingsSingleScope 

func (a *PrivateRBACUIMyRoleBindingsApiService) MyRoleBindingsSingleScope(ctx _context.Context, principal string, scope Scope) (ScopeRoleBindingMapping, *_nethttp.Response, error)

* MyRoleBindingsSingleScope List all rolebindings for the specifed principal and scope. * * Callable by Admins+User. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param scope * @return ScopeRoleBindingMapping

type Protocol 

type Protocol string

Protocol the model 'Protocol' 

const (
	PROTOCOL_SASL_PLAINTEXT Protocol = "SASL_PLAINTEXT"
	PROTOCOL_SASL_SSL       Protocol = "SASL_SSL"
	PROTOCOL_HTTP           Protocol = "HTTP"
	PROTOCOL_HTTPS          Protocol = "HTTPS"
)

List of Protocol

type RBACRoleBindingCRUDApi 

type RBACRoleBindingCRUDApi interface {

	/*
	 * AddRoleForPrincipal Binds the principal to a cluster-scoped role for a specific cluster or in the given scope.
	 *
	 * Callable by Admins.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param roleName The name of the cluster-scoped role to bind the user to.
	 * @param mdsScope
	 */
	AddRoleForPrincipal(ctx _context.Context, principal string, roleName string, mdsScope MdsScope) (*_nethttp.Response, error)

	/*
	 * AddRoleResourcesForPrincipal Incrementally grant the resources to the principal at the given scope/cluster using the given role.
	 *
	 * Callable by Admins+ResourceOwners.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param roleName The name of the role.
	 * @param resourcesRequest
	 */
	AddRoleResourcesForPrincipal(ctx _context.Context, principal string, roleName string, resourcesRequest ResourcesRequest) (*_nethttp.Response, error)

	/*
	 * DeleteRoleForPrincipal Remove the role (cluster or resource scoped) from the principal at the given scope/cluster.
	 *
	 * No-op if the user doesn't have the role.  Callable by Admins.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param roleName The name of the role.
	 * @param mdsScope
	 */
	DeleteRoleForPrincipal(ctx _context.Context, principal string, roleName string, mdsScope MdsScope) (*_nethttp.Response, error)

	/*
	 * GetRoleResourcesForPrincipal Look up the rolebindings for the principal at the given scope/cluster using the given role.
	 *
	 * Callable by Admins.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param roleName The name of the role.
	 * @param mdsScope
	 * @return []ResourcePattern
	 */
	GetRoleResourcesForPrincipal(ctx _context.Context, principal string, roleName string, mdsScope MdsScope) ([]ResourcePattern, *_nethttp.Response, error)

	/*
	 * RemoveRoleResourcesForPrincipal Incrementally remove the resources from the principal at the given scope/cluster using the given role.
	 *
	 * Callable by Admins+ResourceOwners.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param roleName The name of the role.
	 * @param resourcesRequest
	 */
	RemoveRoleResourcesForPrincipal(ctx _context.Context, principal string, roleName string, resourcesRequest ResourcesRequest) (*_nethttp.Response, error)

	/*
	 * SetRoleResourcesForPrincipal Overwrite existing resource grants.
	 *
	 * Callable by Admins+ResourceOwners.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param roleName The name of the role.
	 * @param resourcesRequest
	 */
	SetRoleResourcesForPrincipal(ctx _context.Context, principal string, roleName string, resourcesRequest ResourcesRequest) (*_nethttp.Response, error)
}

type RBACRoleBindingCRUDApiService 

type RBACRoleBindingCRUDApiService service

RBACRoleBindingCRUDApiService RBACRoleBindingCRUDApi service

func (*RBACRoleBindingCRUDApiService) AddRoleForPrincipal 

func (a *RBACRoleBindingCRUDApiService) AddRoleForPrincipal(ctx _context.Context, principal string, roleName string, mdsScope MdsScope) (*_nethttp.Response, error)

* AddRoleForPrincipal Binds the principal to a cluster-scoped role for a specific cluster or in the given scope. * * Callable by Admins. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param roleName The name of the cluster-scoped role to bind the user to. * @param mdsScope

func (*RBACRoleBindingCRUDApiService) AddRoleResourcesForPrincipal 

func (a *RBACRoleBindingCRUDApiService) AddRoleResourcesForPrincipal(ctx _context.Context, principal string, roleName string, resourcesRequest ResourcesRequest) (*_nethttp.Response, error)

* AddRoleResourcesForPrincipal Incrementally grant the resources to the principal at the given scope/cluster using the given role. * * Callable by Admins+ResourceOwners. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param roleName The name of the role. * @param resourcesRequest

func (*RBACRoleBindingCRUDApiService) DeleteRoleForPrincipal 

func (a *RBACRoleBindingCRUDApiService) DeleteRoleForPrincipal(ctx _context.Context, principal string, roleName string, mdsScope MdsScope) (*_nethttp.Response, error)

* DeleteRoleForPrincipal Remove the role (cluster or resource scoped) from the principal at the given scope/cluster. * * No-op if the user doesn't have the role. Callable by Admins. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param roleName The name of the role. * @param mdsScope

func (*RBACRoleBindingCRUDApiService) GetRoleResourcesForPrincipal 

func (a *RBACRoleBindingCRUDApiService) GetRoleResourcesForPrincipal(ctx _context.Context, principal string, roleName string, mdsScope MdsScope) ([]ResourcePattern, *_nethttp.Response, error)

* GetRoleResourcesForPrincipal Look up the rolebindings for the principal at the given scope/cluster using the given role. * * Callable by Admins. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param roleName The name of the role. * @param mdsScope * @return []ResourcePattern

func (*RBACRoleBindingCRUDApiService) RemoveRoleResourcesForPrincipal 

func (a *RBACRoleBindingCRUDApiService) RemoveRoleResourcesForPrincipal(ctx _context.Context, principal string, roleName string, resourcesRequest ResourcesRequest) (*_nethttp.Response, error)

* RemoveRoleResourcesForPrincipal Incrementally remove the resources from the principal at the given scope/cluster using the given role. * * Callable by Admins+ResourceOwners. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param roleName The name of the role. * @param resourcesRequest

func (*RBACRoleBindingCRUDApiService) SetRoleResourcesForPrincipal 

func (a *RBACRoleBindingCRUDApiService) SetRoleResourcesForPrincipal(ctx _context.Context, principal string, roleName string, resourcesRequest ResourcesRequest) (*_nethttp.Response, error)

* SetRoleResourcesForPrincipal Overwrite existing resource grants. * * Callable by Admins+ResourceOwners. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param roleName The name of the role. * @param resourcesRequest

type RBACRoleBindingSummariesApi 

type RBACRoleBindingSummariesApi interface {

	/*
	 * LookupPrincipalsWithRole Look up the KafkaPrincipals who have the given role for the given scope.
	 *
	 * Callable by Admins.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param roleName Role name to look up.
	 * @param mdsScope
	 * @return []string
	 */
	LookupPrincipalsWithRole(ctx _context.Context, roleName string, mdsScope MdsScope) ([]string, *_nethttp.Response, error)

	/*
	 * LookupPrincipalsWithRoleOnResource Look up the KafkaPrincipals who have the given role on the specified resource for the given scope.
	 *
	 * Callable by Admins.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param roleName Role name to look up.
	 * @param resourceType Type of resource to look up.
	 * @param resourceName Name of resource to look up.
	 * @param mdsScope
	 * @return []string
	 */
	LookupPrincipalsWithRoleOnResource(ctx _context.Context, roleName string, resourceType string, resourceName string, mdsScope MdsScope) ([]string, *_nethttp.Response, error)

	/*
	 * LookupResourcesForPrincipal Look up the resource bindings for the principal at the given scope/cluster.
	 *
	 * Includes bindings from groups that the user belongs to.  Callable by Admins+User.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param mdsScope
	 * @return map[string]map[string][]ResourcePattern
	 */
	LookupResourcesForPrincipal(ctx _context.Context, principal string, mdsScope MdsScope) (map[string]map[string][]ResourcePattern, *_nethttp.Response, error)

	/*
	 * ScopedPrincipalRolenames Returns the effective list of role names for a principal.
	 *
	 * For groups, these are the roles that are bound.  For users, this is the combination of roles granted to the specific user and roles granted to the user's groups.  Callable by Admins+User.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param principal Fully-qualified KafkaPrincipal string for a user or group.
	 * @param mdsScope
	 * @return []string
	 */
	ScopedPrincipalRolenames(ctx _context.Context, principal string, mdsScope MdsScope) ([]string, *_nethttp.Response, error)
}

type RBACRoleBindingSummariesApiService 

type RBACRoleBindingSummariesApiService service

RBACRoleBindingSummariesApiService RBACRoleBindingSummariesApi service

func (*RBACRoleBindingSummariesApiService) LookupPrincipalsWithRole 

func (a *RBACRoleBindingSummariesApiService) LookupPrincipalsWithRole(ctx _context.Context, roleName string, mdsScope MdsScope) ([]string, *_nethttp.Response, error)

* LookupPrincipalsWithRole Look up the KafkaPrincipals who have the given role for the given scope. * * Callable by Admins. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param roleName Role name to look up. * @param mdsScope * @return []string

func (*RBACRoleBindingSummariesApiService) LookupPrincipalsWithRoleOnResource 

func (a *RBACRoleBindingSummariesApiService) LookupPrincipalsWithRoleOnResource(ctx _context.Context, roleName string, resourceType string, resourceName string, mdsScope MdsScope) ([]string, *_nethttp.Response, error)

* LookupPrincipalsWithRoleOnResource Look up the KafkaPrincipals who have the given role on the specified resource for the given scope. * * Callable by Admins. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param roleName Role name to look up. * @param resourceType Type of resource to look up. * @param resourceName Name of resource to look up. * @param mdsScope * @return []string

func (*RBACRoleBindingSummariesApiService) LookupResourcesForPrincipal 

func (a *RBACRoleBindingSummariesApiService) LookupResourcesForPrincipal(ctx _context.Context, principal string, mdsScope MdsScope) (map[string]map[string][]ResourcePattern, *_nethttp.Response, error)

* LookupResourcesForPrincipal Look up the resource bindings for the principal at the given scope/cluster. * * Includes bindings from groups that the user belongs to. Callable by Admins+User. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param mdsScope * @return map[string]map[string][]ResourcePattern

func (*RBACRoleBindingSummariesApiService) ScopedPrincipalRolenames 

func (a *RBACRoleBindingSummariesApiService) ScopedPrincipalRolenames(ctx _context.Context, principal string, mdsScope MdsScope) ([]string, *_nethttp.Response, error)

* ScopedPrincipalRolenames Returns the effective list of role names for a principal. * * For groups, these are the roles that are bound. For users, this is the combination of roles granted to the specific user and roles granted to the user's groups. Callable by Admins+User. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param principal Fully-qualified KafkaPrincipal string for a user or group. * @param mdsScope * @return []string

type RBACRoleDefinitionsApi 

type RBACRoleDefinitionsApi interface {

	/*
	 * RoleDetail List the resourceType and operations allowed for a given role.
	 *
	 * Callable by LDAP users.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param roleName Role name to look up.
	 * @return Role
	 */
	RoleDetail(ctx _context.Context, roleName string) (Role, *_nethttp.Response, error)

	/*
	 * Rolenames Returns the names of all the roles defined in the system.
	 *
	 * For information and developer purposes.  Callable by LDAP users.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return []string
	 */
	Rolenames(ctx _context.Context) ([]string, *_nethttp.Response, error)

	/*
	 * Roles Returns all the roles defined in the system.
	 *
	 * For information and developer purposes.  Callable by LDAP users.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return []Role
	 */
	Roles(ctx _context.Context) ([]Role, *_nethttp.Response, error)
}

type RBACRoleDefinitionsApiService 

type RBACRoleDefinitionsApiService service

RBACRoleDefinitionsApiService RBACRoleDefinitionsApi service

func (*RBACRoleDefinitionsApiService) RoleDetail 

func (a *RBACRoleDefinitionsApiService) RoleDetail(ctx _context.Context, roleName string) (Role, *_nethttp.Response, error)

* RoleDetail List the resourceType and operations allowed for a given role. * * Callable by LDAP users. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param roleName Role name to look up. * @return Role

func (*RBACRoleDefinitionsApiService) Rolenames 

func (a *RBACRoleDefinitionsApiService) Rolenames(ctx _context.Context) ([]string, *_nethttp.Response, error)

* Rolenames Returns the names of all the roles defined in the system. * * For information and developer purposes. Callable by LDAP users. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return []string

func (*RBACRoleDefinitionsApiService) Roles 

func (a *RBACRoleDefinitionsApiService) Roles(ctx _context.Context) ([]Role, *_nethttp.Response, error)

* Roles Returns all the roles defined in the system. * * For information and developer purposes. Callable by LDAP users. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return []Role

type ResolveResourceRouteOpts 

type ResolveResourceRouteOpts struct {
	Crn optional.String
}

ResolveResourceRouteOpts Optional parameters for the method 'ResolveResourceRoute'

type ResourcePattern 

type ResourcePattern struct {
	ResourceType string `json:"resourceType"`
	Name         string `json:"name"`
	PatternType  string `json:"patternType"`
}

ResourcePattern struct for ResourcePattern

type ResourcesRequest 

type ResourcesRequest struct {
	Scope            MdsScope          `json:"scope"`
	ResourcePatterns []ResourcePattern `json:"resourcePatterns"`
}

ResourcesRequest struct for ResourcesRequest

type Role 

type Role struct {
	Name         string       `json:"name,omitempty"`
	AccessPolicy AccessPolicy `json:"accessPolicy,omitempty"`
}

Role struct for Role

type SSODeviceAuthorizationApi 

type SSODeviceAuthorizationApi interface {

	/*
	 * CheckDeviceAuth Provides information about current status of user authentication
	 *
	 * Checks if the user has authorized and logged in. If the user has authorized, then the response contains the auth token, and the complete flag is set to true.   If the user has not authorized in right time or some other error occurred, then the response contains the error details, and again complete flag is set to true.   Otherwise, in case of pending auth, the response contains the status, description and the complete flag is set to false.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param checkDeviceAuthRequest
	 * @return CheckDeviceAuthResponse
	 */
	CheckDeviceAuth(ctx _context.Context, checkDeviceAuthRequest CheckDeviceAuthRequest) (CheckDeviceAuthResponse, *_nethttp.Response, error)

	/*
	 * ExtendDeviceAuth Extend auth by generating a new token
	 *
	 * Attempts to refresh the Confluent token if applicable, based on the provided JwtPrincipal.   If refresh token is configured to be used, the session is extended until expiry time of new ID token requested using the refresh token.  Else session is extended until min(`mex`, `currentTime`+ `sessionTokenExpiryConfig`) where `mex` is the claim already present in auth token.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param extendAuthRequest
	 * @return ExtendAuthResponse
	 */
	ExtendDeviceAuth(ctx _context.Context, extendAuthRequest ExtendAuthRequest) (ExtendAuthResponse, *_nethttp.Response, error)

	/*
	 * Security10OidcDeviceAuthenticatePost Provides user authentication details and device polling for authentication status
	 *
	 * This initiates user authentication in CLI.  Response contains  1. `user_code` and `verification_uri` which are used by user to authenticate from the identity provider (IdP).  2. `key` is used to poll the IdP to check if the user has authorized and logged in. 3. `interval` to hint client about polling frequency.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return InitDeviceAuthResponse
	 */
	Security10OidcDeviceAuthenticatePost(ctx _context.Context) (InitDeviceAuthResponse, *_nethttp.Response, error)
}

type SSODeviceAuthorizationApiService 

type SSODeviceAuthorizationApiService service

SSODeviceAuthorizationApiService SSODeviceAuthorizationApi service

func (*SSODeviceAuthorizationApiService) CheckDeviceAuth 

func (a *SSODeviceAuthorizationApiService) CheckDeviceAuth(ctx _context.Context, checkDeviceAuthRequest CheckDeviceAuthRequest) (CheckDeviceAuthResponse, *_nethttp.Response, error)

* CheckDeviceAuth Provides information about current status of user authentication * * Checks if the user has authorized and logged in. If the user has authorized, then the response contains the auth token, and the complete flag is set to true. If the user has not authorized in right time or some other error occurred, then the response contains the error details, and again complete flag is set to true. Otherwise, in case of pending auth, the response contains the status, description and the complete flag is set to false. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param checkDeviceAuthRequest * @return CheckDeviceAuthResponse

func (*SSODeviceAuthorizationApiService) ExtendDeviceAuth 

func (a *SSODeviceAuthorizationApiService) ExtendDeviceAuth(ctx _context.Context, extendAuthRequest ExtendAuthRequest) (ExtendAuthResponse, *_nethttp.Response, error)

* ExtendDeviceAuth Extend auth by generating a new token * * Attempts to refresh the Confluent token if applicable, based on the provided JwtPrincipal. If refresh token is configured to be used, the session is extended until expiry time of new ID token requested using the refresh token. Else session is extended until min(`mex`, `currentTime`+ `sessionTokenExpiryConfig`) where `mex` is the claim already present in auth token. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param extendAuthRequest * @return ExtendAuthResponse

func (*SSODeviceAuthorizationApiService) Security10OidcDeviceAuthenticatePost 

func (a *SSODeviceAuthorizationApiService) Security10OidcDeviceAuthenticatePost(ctx _context.Context) (InitDeviceAuthResponse, *_nethttp.Response, error)

* Security10OidcDeviceAuthenticatePost Provides user authentication details and device polling for authentication status * * This initiates user authentication in CLI. Response contains 1. `user_code` and `verification_uri` which are used by user to authenticate from the identity provider (IdP). 2. `key` is used to poll the IdP to check if the user has authorized and logged in. 3. `interval` to hint client about polling frequency. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return InitDeviceAuthResponse

type Scope 

type Scope struct {
	Clusters ScopeClusters `json:"clusters"`
}

Scope struct for Scope

type ScopeClusters 

type ScopeClusters struct {
	KafkaCluster          string `json:"kafka-cluster,omitempty"`
	ConnectCluster        string `json:"connect-cluster,omitempty"`
	KsqlCluster           string `json:"ksql-cluster,omitempty"`
	SchemaRegistryCluster string `json:"schema-registry-cluster,omitempty"`
	Cmf                   string `json:"cmf,omitempty"`
	FlinkEnvironment      string `json:"flink-environment,omitempty"`
}

ScopeClusters struct for ScopeClusters

type ScopeRoleBindingMapping 

type ScopeRoleBindingMapping struct {
	Scope        MdsScope                                `json:"scope,omitempty"`
	Rolebindings map[string]map[string][]ResourcePattern `json:"rolebindings,omitempty"`
}

ScopeRoleBindingMapping struct for ScopeRoleBindingMapping

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type TokensAndAuthenticationApi 

type TokensAndAuthenticationApi interface {

	/*
	 * GetToken Get a bearer token.
	 *
	 * Callable by LDAP users.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return AuthenticationResponse
	 */
	GetToken(ctx _context.Context) (AuthenticationResponse, *_nethttp.Response, error)
}

type TokensAndAuthenticationApiService 

type TokensAndAuthenticationApiService service

TokensAndAuthenticationApiService TokensAndAuthenticationApi service

func (*TokensAndAuthenticationApiService) GetToken 

func (a *TokensAndAuthenticationApiService) GetToken(ctx _context.Context) (AuthenticationResponse, *_nethttp.Response, error)

* GetToken Get a bearer token. * * Callable by LDAP users. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return AuthenticationResponse

type UsersGroupsListOpts 

type UsersGroupsListOpts struct {
	Type_ optional.String
}

UsersGroupsListOpts Optional parameters for the method 'UsersGroupsList'

type VisibilityRequest 

type VisibilityRequest struct {
	KafkaCluster           string   `json:"kafka-cluster"`
	ConnectClusters        []string `json:"connect-clusters,omitempty"`
	SchemaRegistryClusters []string `json:"schema-registry-clusters,omitempty"`
	KsqlClusters           []string `json:"ksql-clusters,omitempty"`
}

VisibilityRequest struct for VisibilityRequest

type VisibilityResponse 

type VisibilityResponse struct {
	KafkaCluster           ClusterVisibility   `json:"kafka-cluster,omitempty"`
	ConnectClusters        []ClusterVisibility `json:"connect-clusters,omitempty"`
	SchemaRegistryClusters []ClusterVisibility `json:"schema-registry-clusters,omitempty"`
	KsqlClusters           []ClusterVisibility `json:"ksql-clusters,omitempty"`
}

VisibilityResponse struct for VisibilityResponse

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.