# README
Go API client for registry
REST API definition for Apache NiFi Registry web services
Overview
This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.
- API version: 2.0.0-M4
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://nifi.apache.org
Installation
Put the package under your project folder and add the following in import:
import "./registry"
Documentation for API Endpoints
All URIs are relative to /
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AboutApi | GetVersion | Get /about | Get version |
| AccessApi | CreateAccessTokenByTryingAllProviders | Post /access/token | Create token trying all providers |
| AccessApi | CreateAccessTokenUsingBasicAuthCredentials | Post /access/token/login | Create token using basic auth |
| AccessApi | CreateAccessTokenUsingIdentityProviderCredentials | Post /access/token/identity-provider | Create token using identity provider |
| AccessApi | CreateAccessTokenUsingKerberosTicket | Post /access/token/kerberos | Create token using kerberos |
| AccessApi | GetAccessStatus | Get /access | Get access status |
| AccessApi | GetIdentityProviderUsageInstructions | Get /access/token/identity-provider/usage | Get identity provider usage |
| AccessApi | Logout | Delete /access/logout | Performs a logout for other providers that have been issued a JWT. |
| AccessApi | LogoutComplete | Get /access/logout/complete | Completes the logout sequence. |
| AccessApi | OidcCallback | Get /access/oidc/callback | Redirect/callback URI for processing the result of the OpenId Connect login sequence. |
| AccessApi | OidcExchange | Post /access/oidc/exchange | Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider. |
| AccessApi | OidcLogout | Get /access/oidc/logout | Performs a logout in the OpenId Provider. |
| AccessApi | OidcLogoutCallback | Get /access/oidc/logout/callback | Redirect/callback URI for processing the result of the OpenId Connect logout sequence. |
| AccessApi | OidcRequest | Get /access/oidc/request | Initiates a request to authenticate through the configured OpenId Connect provider. |
| AccessApi | TestIdentityProviderRecognizesCredentialsFormat | Post /access/token/identity-provider/test | Test identity provider |
| BucketBundlesApi | CreateExtensionBundleVersion | Post /buckets/{bucketId}/bundles/{bundleType} | Create extension bundle version |
| BucketBundlesApi | GetExtensionBundles | Get /buckets/{bucketId}/bundles | Get extension bundles by bucket |
| BucketFlowsApi | CreateFlow | Post /buckets/{bucketId}/flows | Create flow |
| BucketFlowsApi | CreateFlowVersion | Post /buckets/{bucketId}/flows/{flowId}/versions | Create flow version |
| BucketFlowsApi | DeleteFlow | Delete /buckets/{bucketId}/flows/{flowId} | Delete bucket flow |
| BucketFlowsApi | ExportVersionedFlow | Get /buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export | Exports specified bucket flow version content |
| BucketFlowsApi | GetFlow | Get /buckets/{bucketId}/flows/{flowId} | Get bucket flow |
| BucketFlowsApi | GetFlowDiff | Get /buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB} | Get bucket flow diff |
| BucketFlowsApi | GetFlowVersion | Get /buckets/{bucketId}/flows/{flowId}/versions/{versionNumber} | Get bucket flow version |
| BucketFlowsApi | GetFlowVersions | Get /buckets/{bucketId}/flows/{flowId}/versions | Get bucket flow versions |
| BucketFlowsApi | GetFlows | Get /buckets/{bucketId}/flows | Get bucket flows |
| BucketFlowsApi | GetLatestFlowVersion | Get /buckets/{bucketId}/flows/{flowId}/versions/latest | Get latest bucket flow version content |
| BucketFlowsApi | GetLatestFlowVersionMetadata | Get /buckets/{bucketId}/flows/{flowId}/versions/latest/metadata | Get latest bucket flow version metadata |
| BucketFlowsApi | ImportVersionedFlow | Post /buckets/{bucketId}/flows/{flowId}/versions/import | Import flow version |
| BucketFlowsApi | UpdateFlow | Put /buckets/{bucketId}/flows/{flowId} | Update bucket flow |
| BucketsApi | CreateBucket | Post /buckets | Create bucket |
| BucketsApi | DeleteBucket | Delete /buckets/{bucketId} | Delete bucket |
| BucketsApi | GetAvailableBucketFields | Get /buckets/fields | Get bucket fields |
| BucketsApi | GetBucket | Get /buckets/{bucketId} | Get bucket |
| BucketsApi | GetBuckets | Get /buckets | Get all buckets |
| BucketsApi | UpdateBucket | Put /buckets/{bucketId} | Update bucket |
| BundlesApi | DeleteBundle | Delete /bundles/{bundleId} | Delete bundle |
| BundlesApi | DeleteBundleVersion | Delete /bundles/{bundleId}/versions/{version} | Delete bundle version |
| BundlesApi | GetBundle | Get /bundles/{bundleId} | Get bundle |
| BundlesApi | GetBundleVersion | Get /bundles/{bundleId}/versions/{version} | Get bundle version |
| BundlesApi | GetBundleVersionContent | Get /bundles/{bundleId}/versions/{version}/content | Get bundle version content |
| BundlesApi | GetBundleVersionExtension | Get /bundles/{bundleId}/versions/{version}/extensions/{name} | Get bundle version extension |
| BundlesApi | GetBundleVersionExtensionAdditionalDetailsDocs | Get /bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details | Get bundle version extension docs details |
| BundlesApi | GetBundleVersionExtensionDocs | Get /bundles/{bundleId}/versions/{version}/extensions/{name}/docs | Get bundle version extension docs |
| BundlesApi | GetBundleVersionExtensions | Get /bundles/{bundleId}/versions/{version}/extensions | Get bundle version extensions |
| BundlesApi | GetBundleVersions | Get /bundles/{bundleId}/versions | Get bundle versions |
| BundlesApi | GetBundleVersions1 | Get /bundles/versions | Get all bundle versions |
| BundlesApi | GetBundles | Get /bundles | Get all bundles |
| ConfigApi | GetConfiguration | Get /config | Get configration |
| ExtensionRepositoryApi | GetExtensionRepoArtifacts | Get /extension-repository/{bucketName}/{groupId} | Get extension repo artifacts |
| ExtensionRepositoryApi | GetExtensionRepoBuckets | Get /extension-repository | Get extension repo buckets |
| ExtensionRepositoryApi | GetExtensionRepoGroups | Get /extension-repository/{bucketName} | Get extension repo groups |
| ExtensionRepositoryApi | GetExtensionRepoVersion | Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version} | Get extension repo version |
| ExtensionRepositoryApi | GetExtensionRepoVersionContent | Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content | Get extension repo version content |
| ExtensionRepositoryApi | GetExtensionRepoVersionExtension | Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name} | Get extension repo extension |
| ExtensionRepositoryApi | GetExtensionRepoVersionExtensionAdditionalDetailsDocs | Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details | Get extension repo extension details |
| ExtensionRepositoryApi | GetExtensionRepoVersionExtensionDocs | Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs | Get extension repo extension docs |
| ExtensionRepositoryApi | GetExtensionRepoVersionExtensions | Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions | Get extension repo extensions |
| ExtensionRepositoryApi | GetExtensionRepoVersionSha256 | Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256 | Get extension repo version checksum |
| ExtensionRepositoryApi | GetExtensionRepoVersions | Get /extension-repository/{bucketName}/{groupId}/{artifactId} | Get extension repo versions |
| ExtensionRepositoryApi | GetGlobalExtensionRepoVersionSha256 | Get /extension-repository/{groupId}/{artifactId}/{version}/sha256 | Get global extension repo version checksum |
| ExtensionsApi | GetExtensions | Get /extensions | Get all extensions |
| ExtensionsApi | GetExtensionsProvidingServiceAPI | Get /extensions/provided-service-api | Get extensions providing service API |
| ExtensionsApi | GetTags | Get /extensions/tags | Get extension tags |
| FlowsApi | GetAvailableFlowFields | Get /flows/fields | Get flow fields |
| FlowsApi | GetFlow1 | Get /flows/{flowId} | Get flow |
| FlowsApi | GetFlowVersion1 | Get /flows/{flowId}/versions/{versionNumber} | Get flow version |
| FlowsApi | GetFlowVersions1 | Get /flows/{flowId}/versions | Get flow versions |
| FlowsApi | GetLatestFlowVersion1 | Get /flows/{flowId}/versions/latest | Get latest flow version |
| FlowsApi | GetLatestFlowVersionMetadata1 | Get /flows/{flowId}/versions/latest/metadata | Get latest flow version metadata |
| ItemsApi | GetAvailableBucketItemFields | Get /items/fields | Get item fields |
| ItemsApi | GetItems | Get /items | Get all items |
| ItemsApi | GetItems1 | Get /items/{bucketId} | Get bucket items |
| PoliciesApi | CreateAccessPolicy | Post /policies | Create access policy |
| PoliciesApi | GetAccessPolicies | Get /policies | Get all access policies |
| PoliciesApi | GetAccessPolicy | Get /policies/{id} | Get access policy |
| PoliciesApi | GetAccessPolicyForResource | Get /policies/{action}/{resource} | Get access policy for resource |
| PoliciesApi | GetResources | Get /policies/resources | Get available resources |
| PoliciesApi | RemoveAccessPolicy | Delete /policies/{id} | Delete access policy |
| PoliciesApi | UpdateAccessPolicy | Put /policies/{id} | Update access policy |
| TenantsApi | CreateUser | Post /tenants/users | Create user |
| TenantsApi | CreateUserGroup | Post /tenants/user-groups | Create user group |
| TenantsApi | GetUser | Get /tenants/users/{id} | Get user |
| TenantsApi | GetUserGroup | Get /tenants/user-groups/{id} | Get user group |
| TenantsApi | GetUserGroups | Get /tenants/user-groups | Get user groups |
| TenantsApi | GetUsers | Get /tenants/users | Get all users |
| TenantsApi | RemoveUser | Delete /tenants/users/{id} | Delete user |
| TenantsApi | RemoveUserGroup | Delete /tenants/user-groups/{id} | Delete user group |
| TenantsApi | UpdateUser | Put /tenants/users/{id} | Update user |
| TenantsApi | UpdateUserGroup | Put /tenants/user-groups/{id} | Update user group |
Documentation For Models
- AccessPolicy
- AccessPolicySummary
- AllowableValue
- Attribute
- BatchSize
- Bucket
- BucketItem
- BuildInfo
- Bundle
- BundleInfo
- BundleVersion
- BundleVersionDependency
- BundleVersionMetadata
- BundlesBundleTypeBody
- ClientIdParameter
- ComponentDifference
- ComponentDifferenceGroup
- ConnectableComponent
- ControllerServiceApi
- ControllerServiceDefinition
- CurrentUser
- DefaultSchedule
- DefaultSettings
- Dependency
- DependentValues
- DeprecationNotice
- DynamicProperty
- DynamicRelationship
- Extension
- ExtensionFilterParams
- ExtensionMetadata
- ExtensionMetadataContainer
- ExtensionRepoArtifact
- ExtensionRepoBucket
- ExtensionRepoGroup
- ExtensionRepoVersion
- ExtensionRepoVersionSummary
- ExternalControllerServiceReference
- Fields
- FormDataContentDisposition
- Link
- LongParameter
- MultiProcessorUseCase
- ParameterProviderReference
- Permissions
- Position
- ProcessorConfiguration
- Property
- ProvidedServiceApi
- RegistryAbout
- RegistryConfiguration
- Relationship
- Resource
- ResourceDefinition
- ResourcePermissions
- Restricted
- Restriction
- RevisionInfo
- Stateful
- SystemResourceConsideration
- TagCount
- Tenant
- UriBuilder
- UseCase
- User
- UserGroup
- VersionedConnection
- VersionedControllerService
- VersionedFlow
- VersionedFlowCoordinates
- VersionedFlowDifference
- VersionedFlowSnapshot
- VersionedFlowSnapshotMetadata
- VersionedFunnel
- VersionedLabel
- VersionedParameter
- VersionedParameterContext
- VersionedPort
- VersionedProcessGroup
- VersionedProcessor
- VersionedPropertyDescriptor
- VersionedRemoteGroupPort
- VersionedRemoteProcessGroup
- VersionedResourceDefinition
Documentation For Authorization
Endpoints do not require authorization.