Overview

API changelog

All notable changes to this project are listed below. === 10.1.0 - 2025-06-25

Added

  • Clean up Kafka Streams internal topics when app.id changes

  • Clean up Consumer Groups ACLs when delete app principals

  • Added a new endpoint /instances/search/findByAttributes for Instance

  • The validateCredentials logic is included as part of the Update Cluster (PATCH)

  • Audit the Cluster Create/Update/Delete actions

  • Audit the Environment Create/Update/Delete actions

  • Audit the Grant Request/Approve/Deny/Cancel/Revoke actions

  • Audit the Topic Create/Update/Delete actions

  • Audit the Application Principal Create/Delete actions

  • Audit the Application Credential Create/Delete actions

  • Added a custom controller endpoint for DELETE /environments

  • Group Overview sort Users

  • Audit the Application Deployment Configured

  • Audit the Application Unconfigured action

  • Audit the Application STARTED/STOPPED/RESTARTED actions

  • Audit the Application Reset action for Consumer Offset

  • Audit the Application Reset action of Kafka Streams Application

  • Refactored the TopicBrowse audit event

  • Audit the Application RESET action for Connector Application

  • Persist ApplicationDeployment config restart_policy

  • Add searching logic of audit history for second and third level resources

  • Pass DeploymentType to KSML Provisioner

  • Audit the Topic Configured action

  • Audit the Topic Unconfigured action

  • Add event summary to the auditHistory response

  • Audit the Group Browse Permission Granted action

  • Audit the Group Browse Permission Revoked action

  • Audit the User Browse Permission Revoked action

  • Audit the User Browse Permission Granted action

  • Add audit fields to response of the GET /stream_configs/{id}/permissions?type=browse API

  • Rely on application_deployments._links to show action buttons

BugFixes

  • Fix the Pod Name leakage in the notification email’s header

  • Prevent other instances from using cert of tenant-protected instance

  • Connector 404 handled as unauthorized

  • Edit Cluster requires broker credentials (privateKey/password)

  • Fix Audit history filtering issue when searching for deleted resources

  • Axual config topic.pattern collides with KSML app config topic.

  • Remove Axual Client code

  • refreshDeploymentState for connectors only

  • Can’t import schemas without namespaces

  • Deleting Topic without Schemas results in a call to Schema Registry

  • Fix Hibernate Lazy Loading Exception while creating SASL Credentials

  • Fix missing authorization check for create link generation for listing groups

  • Fix test_restart_task and appDeploymentCount failing tests on the pipeline

  • Prefixed ACL collision bugfix

10.0.0 - 2025-03-24

This version of the Platform Manager removes support for:

  • Deployment with the Instance API

  • Browsing a Kafka Topic with the Stream Browse

  • OAuth2 authentication and relies on the API Gateway OAuth2 authentication

  • Uploading of a Schema Jar

  • Create Schema with POST /schemas

  • Update Schema with PATCH /schemas/{id}

  • Check Schema Version with POST /schemas/check

  • Create Schema Version with POST /schema_versions

  • Update Schema Version with POST /schema_versions/{id}

Added

  • Resource Manager role and rules added to permissions

  • Removed selection of SR for create/update Instance operations

  • Improved Grants Overview

  • Hide sensitive fields when retrieving Instance information

  • Introduce Delete Constraint Endpoint for Schema

  • KafkaStreams based reset

  • Allow changing just the SchemaRegistry Listeners/Properties without changing Credentials

  • Add Auth0 support in Organization Management module

  • Introduce Delete Constraint Endpoint for Schema Version

  • Audit the Application Resource

  • Audit the Instance Resource

  • Allow SR password regeneration for Self Managed KSML and Kafka Streams application

  • Add a new type of Retention Type for compact,delete

  • Delete internal topics when deleting a "Kafka Streams"-based application

  • Filter Grant by Access Type

  • Manage SR credentials for Axual Managed KSML application when creating/deleting application_deployment

  • Add authentication support in KSML flows

  • Add only-resource-manager-can-update toggle on the Tenant settings

  • Self approving for application grand should not be possible

  • Allows selecting Resource Manager in a Group

  • View the audit history

  • Starting an already started connector fails

BugFixes

  • InstanceCluster couldn’t be saved without SR details

  • SR Keycloak Details weren’t saving during Instance Edit

  • Allow sending null properties for the topic apply

  • Removed the circular dependency between kms and clusterImporter modules

  • Renamed SchemaDeleteConstraints fields

  • Deleting user from UI also deletes from Keycloak

  • Permissions for Owning Group by default browsing group not toggleable per tenant

  • Fix Truststore Apicurio Configuration

  • Fix for notification not sent while connector fails

  • Simplify SchemaRegistry truststore configuration

  • Add timeUnit translation to milliseconds for essential topic configs when using K-Lib

  • Not Topic Owner can see view masking fields button

  • Fix the generic error message when proving invalid retentionPolicy

  • Fixed issue while updating a topicConfig having unsupported property

  • Importing an existing Kafka Cluster with SchemaRegistry doesn’t work

  • Fixed issue while importing an existing SSL ACL from Kafka cluster

  • Regular user can’t see instances

  • Disabled URLs in the Notifications emails

  • Creating a Tenant with /tenants should result in a WizardCompleted tenant

  • Marked the unused endpoint GET/POST/PATCH/DELETE /groups/{uid}/members as deprecated

  • Fixed issue when creating instance with invalid connectUrl

  • Updating an Instance removes the srType, srVersion, distributionConfig and KSML overrides

9.1.1 - 2024-12-24

BugFixes

  • NPE when getting masking-fields for a AVRO/non-AVRO Topic

9.1.0 - 2024-12-23

Added

  • Consumer app offset reset

  • Tenant properties are made JSON column

  • Allow to Stop Distribution

  • Masking_fields support for schema

  • Add Kafka Streams custom application type

  • Make the schema-roles-enforce a Tenant setting

  • Store Apicurio’s Keycloak details per Instance Cluster

  • Audit the Application Create action

  • Masking_fields support for Topic Config

  • Allow to configure strict masking toggle for an Environment

  • Allow app owners to create Schema Registry credentials in Apicurio’s Keycloak

  • Allow app owners to delete Schema Registry credentials in Apicurio’s Keycloak

  • Unmask the masking_fields for a Topic Config Browse

  • Create KafkaStreams prefixed ACLs on credential and principal creation

  • Enhance Keycloak client registration error handling with a fallback scenario

  • Delete KafkaStreams prefixed ACLs on credential and principal deletion

  • KafkaStreams based application.id modification should trigger collision-detection/delete/create Prefixed ACLs

  • Trigger KafkaStreams based prefixed ACL collision detection on credential/principal/topic creation

BugFixes

  • Don’t delete permission groups when Granular Browse gets disabled for an Instance

  • Schema registry secrets location fix

  • Uploading a new schema-version with a different type is allowed

  • Block creation of an Instance with existing short-name in the same Tenant

  • Don’t allow dropping Schema Registry from InstanceClusters when topics are deployed

  • Update SchemaRegistryUrls for old architecture Instances

  • EnvOwner & EnvAdmin cannot delete private environment if app-auth defined by others

  • Connector configs and grouping disappears

  • Fixing an issue when creating a topic for the first time

  • Simplify logic to retrieve StreamConfig allowed Kafka Properties

  • Make KSML only working with Schema Registry in confluent mode

  • Not a resource owner can take ownership of resources

  • Added the missing owners field to the response of the /schema_versions/search/findAllBySchema API

  • Fixed issue for topic owners can browse their own topic

  • Resolved an issue where users without ownership of any resources could view all appAccessGrants

9.0.0 - 2024-10-01

Added

  • KSML Applications support

  • JSON SCHEMA support

  • Removed "notificationsEnabled" field from /me, /tenant and /user endpoints. [BREAKING CHANGE]

  • a POST endpoint to create distribution config for an instance cluster

  • Allow Tagging streams

  • a PATCH endpoint to create distribution config for an instance cluster

  • A GET endpoint to retrieve the distribution config for an instance cluster

  • Hide Sensitive fields when retrieving Cluster information & validate credentials when updating Cluster

  • a GET endpoint to retrieve distribution overview of an instance

  • Add tag to the search attributes of the Stream entity

  • Distribution API improvements

  • Allow to Start a Distribution

  • Get distribution status

  • Added a validation to disallow SSL auth creation if any auth exists (principal or credential) for the app and environment

  • Updated shortName in Tenant/Instance/Environment resource to have min length 1

  • Allow user to update provider info fields while updating Kafka cluster

  • Create/Update a topic using JSON Schema

  • Create Schema ownership

  • Create/Delete JSON Schema topic config

  • Delete environment|topic|application should identify active child-resources

  • Support connector logging

Bugfixes

  • Protobuf schemas without package (namespace) were saved with a starting dot "."

  • Topic delete idempotency

  • Cluster SASL mechanism update getting invalid protocol type error

  • Forbid removing Instance from Environment

  • Added validation for BYOK clusters to provide a user-friendly message in case the SR is not configured for AVRO/PROTOBUF topic

  • Fixed /application_access_grants/search/findByAttributes API sorting issue

  • Added Transactional annotation to fix hibernate lazy loading exception

  • Fix NPE issues encountered during deployment status retrieval

  • Fix update Instance issue regarding storing the Instance credentials as Cluster credentials

  • VaultTemplates bean is not part of the Spring Lifecycle

  • Fix to resolve the distribution config path in vault service using correct delimiters

  • Fix the get all and one Group to not load the Tenant

  • Cannot delete private environment with KSML deployment

  • When setting the default enabledAuthenticationMethods for an instance, the collection is immutable

  • Return privateKey uploaded for KSML and Connector Applications

  • Fetch the stream.tags when searching stream by name containing /streams/search/findByNameContaining

  • Fix validateCredentials behaviour which requires everything to be sent

  • Update the logic of validating credentials in PATCH distributionConfig

  • When using SASL as super-user, Topic-Browse fails

  • When updating an Instance, the secrets are not replaced/removed

  • Fixed fetch all streams when the tag is empty string

  • Updating application ID is case-insensitive which should not be

  • Instance Edit page is not handling 403 errors

  • Hibernate LazyLoadingException when refreshing PluginsInfo

  • Can save sslAuthMode in Cluster table as a JSON column

  • Add a self-link to the application.owner resource

  • Migrating an instance removes the schema-registry-slave urls

  • The key/value type is not visible for PROTOBUF/JSON_SCHEMA topic

  • Fixed duplicated self-link of the group resource by introducing custom APIs for POST and PATCH /groups/{uid}

  • Allow Cluster Name to contain _-. symbols

  • Fix double _links.self in /api/application_deployments/xxx/status endpoint

  • Added HAL_JSON_VALUE Accept header to the post and patch /groups APIS and fixed duplicated self-link of the SDR API

8.6.0 - 2024-06-27

Added

  • Delete Kafka Topic with Protobuf Schemas

  • Create Kafka Topic with Protobuf Schemas

  • View, Delete Protobuf Schema in the Self-Service

  • Trigger emails based on events for Connector Owners

  • Trigger emails based on events for application Owners

  • Enable Tenant Notification

  • Disable User Notification

  • Add Owners field to Environment findByAttributes API

  • Provide the SchemaRegistry Type in the Instance-Cluster

  • Support multi-cluster for ApplicationAuthentication creation

  • Enable/Disable KSML support for an Instance

  • Application Principal for KSML Application

  • Create KSML application

  • Add KSML Application Deployment

  • Add Application Lifecycle interface

  • Define Viewer Group for Environment

  • Define Viewer Group for Streams

  • Define Viewer Group for Application

  • Allow stream-owner to add group to the PermissionGroup

  • Create Group Managers to manage group’s members

  • Made the tenant in Group entity LAZY to resolve hibernate memory overload issue

Bugfixes

  • Fix Cascade delete for a stream not removing Kafka Topics

  • Fix Cascade delete for an application not removing Kafka Topics ACLs

  • Fix Cascade delete for an environment not removing Kafka Topics

  • Fix Private Environment cascade delete issue regarding removing ApplicationAccess

  • Add audit logs for application access grant status changes

  • When a cluster has billingCloudEnabled=true, that value should not change if it’s not present in a

  • Add 'Axl-Sr-Type-ApacheKafka' in Provider Config

  • Updated the AuditLogger’s log method to remove debug handling for ApplicationDeployment instances

  • Remove HubSpot related code

  • Fix force apply for AVRO and Protobuf

  • Missing namespace when uploading a Protobuf with defined package

  • Changed Boolean parsing for handling old migration values (1,0) as (true, false)

  • Partial match on searching for ApplicationID

  • NPE when instance setting does not include CERTIFICATE_REUSE_PREVENTION

  • Unhandled data layer exception when creating an application with a duplicate name/shortName

  • Fix for private environments are visible to normal users and TENANT_ADMIN

  • Application Access Grants are not visible to Admin when myteams=true

  • Allow multiple principals with the same DN and different fingerprint irrespective of the certificateReusePrevention value

8.5.0 - 2024-04-12

Added

  • Implement the Notification Service with SMTP

  • View Protobuf schema in the Self-Service

  • Add SchemaRegistry Type to the TopicBrowse Config

  • Validate and upload Protobuf

Bugfixes

  • Fix returning inconsistent dataType for application access grant members

8.4.0 - 2024-03-25

Added

  • Added search by owner to Applications, Streams, and Environments

  • Handle the refresh certificate scenario with no downtime in Kafka ACL

Bugfixes

  • Save Apache-Kafka secrets when importing an existing Apache-Kafka cluster

  • Fixed update cluster issue when the topic/group/transactional pattern is provided in patch request but not modified

  • Fixed the /me endpoint issue when VaultService is not available

  • Fixed issue when updating an instance with property.value=NULL

8.3.0 - 2024-03-13

Added

  • Filter the system-topics from the /wizard/topics

  • Added DB scheduler configuration for distributed scheduling of connector cron jobs

Bugfixes

  • Fixed issue while updating onboarded default instance

  • Removed usage of`updateTopic` to fix issue adding a cluster makes existing things fail

  • Added SSL configuration to HashicorpVault

  • Fixed fetching the secrets when the cluster or instance Name have Capital letters

  • Fixed to restrict updating patterns on external cluster when mapped to a topic

8.2.0 - 2024-02-29

Added

  • Add properties field to Application and Group APIs

  • Off-boarding of a ConfluentCloud cluster

  • Allow downloading CSV file for Topics, Applications, and Environments

  • Add extraInitContainers, extraVolumes, extraVolumeMounts, and extraContainers to Helm Charts

  • Cascade delete Application, Environment, Topic

  • Prevent reuse of SSL principal

  • Added a new field settings to Instance entity

  • Add monitoring_information for API Gateway

  • Add validation to block changing cluster ownership

Bugfixes

  • Fixed PATCH /clusters/{id} API to allow migrating old arch cluster to a shared apache-kafka cluster

  • Changes to add namespace property to governance.vault

  • Fix creating first environment on single-environment cluster

  • Changing environment to PRIVATE is blocked by REVOKED access grants.

  • A deleted instance is still present in the list of managed instance

  • Fixed PATCH /instances/{id} API to allow instance migration

  • Added default instanceSettings while onboarding new tenant

  • Refactored the logic of setting value for isSchemaRegistryEnabled field of /me API

  • Fixed issue when deleting an instance with connect enabled

  • Fixed issue with search on topic with findByAttributes

  • Cannot create the first environment in a Tenant

  • Fixed issue when selecting AVRO and then switching back during topic creation

  • Fixed HATEOAS links pointing to the wrong resources

8.1.0 - 2024-01-30

Added

  • Add provider info to the Instance entity

  • Handled Duplicated CAs internally instead of returning validation error when creating or updating an instance

  • Add Cluster validation when creating/updating the entity

  • Set server.forward-headers-strategy: framework as default

  • Add new API to get the Kafka connectivity Information per application

  • Add the properties to the StreamProjections

  • Allow Stream owner and Stream admin to create applicationAccessGrant

  • Add delete /schemas endpoint to delete the Schema with related SchemaVersions

Bugfixes

  • Add validation fields for Instance PATCH endpoint

  • Fixed cluster.name update issue of ignoring case sensitivity when interacting with vault

  • remove phone number validation for the user entity

  • Fix overwriting issue of SR and Kafka listeners when performing a patch

  • Fix bypassing the APPLICATION_ACCESS_GRANT_CREATE rule for createApplicationAccessGrant API

8.0.1 - 2023-12-13

Bugfixes

  • Create an Admin group when bootstrapping the Tenant/User

8.0.0 - 2023-12-13

Added

  • Upgrade Spring Boot to 3.1.0

  • Replace Spring Sleuth with Micrometer to fix distributed tracing

  • Get rid of all deprecated endpoints as 6.x & 7.x version

  • Add Broker mTLS cert/privateKey validation in the Wizard

  • Add Broker SASL username/password validation in the Wizard

  • Add SR BasicAuth username/password validation in the Wizard

  • Add SR mTLS cert/privateKey to Wizard

  • Add provider info in the cluster page

  • Allow skipping onboarding after user signup

  • Added validation while creating an environment to check if Instance has any multi-environment cluster

  • Unify logging pattern

Bugfixes

  • Improve performance of getAllWithLatestSchemaVersion endpoint

  • Hide sensitive fields in the audit logging

  • Make Error Human Readable

  • Remove phoneNumber pattern validation on group entity

7.4.0 - 2023-10-09

Added

  • Don’t validate connector-logging certificate against the instance CAs

  • Added TRIALING status to reflect "active" state of the subscription

  • Add stream-config-browse config endpoint

  • Add Hashicorp Vault support

  • Upgraded Spring Kafka version to 3.0.10

  • Upgraded Kafka Clients version to 3.5.1

  • Upgraded Spring Hateoas version to 2.0.6

  • Upgraded Spring Security version to 6.1.4

  • Upgraded Keycloak Admin Client version to 22.0.3

  • Changed the /clusters endpoint to return Public and Owned clusters

  • Removed the endpoint /instances/{id}/clusters

  • Change to restrict creating Byok-Instance using the non-byok cluster and vice versa while creating instance

  • Introduce a multiInstance feature to control instance-creation

  • Ingest AOM features into Platform Manager

  • Show Private Key Uploaded in Principal

  • Add HashiCorp Vault support for storing connect secrets

  • Added links to the /clusters endpoint. Updated RBAC rule for cluster create,edit and delete

  • Add apache-kafka allowed topic-properties

  • Add tenantUid, topicBrowseEnabled, and schemaRegistryEnabled fields to /api/me

  • Added a new endpoint /tenants/{tenantUID}/onboard to onboard a tenant with shared cluster

  • Re-introduced segment.ms pickup from Instance’s properties

  • Use principalChain when creating Topic ACL for multi-tenant cluster and support multi-cluster for topic apply/delete

  • Delete public environment

  • Add tls support to PlatformManager helm-charts with external k8s secret only

  • Support multiple instanceConnect configuration at Deployment time

Bugfixes

  • Fix check on identifying external cluster in InstanceEventHandler

  • Changes to Allow Generating/Deleting SASL credentials for Plain/Strimzi provider

  • Fix change key/value of an unconfigured topic to AVRO

  • Allow deleting an applicationCredentials with the ResourceId as metadata in case clusterApiKey is empty

  • Return a tenant optional field when getting all Instances

  • Fix Schema Browser issue with null schemas in mgmt-api

  • Fix create/delete multiple schema versions

7.3.0 - 2023-08-02

Added

  • Added configuration to enable/disable duplicate schema validation

  • Update importApplication to store ResourceID

  • Allow applying a topic on a Plain/Strimzi Cluster

  • Allow deleting a topic on a Plain/Strimzi Cluster

  • Upgraded Spring version to 6.0.11

  • Upgraded Spring Security version to 6.1.2

  • Changes to remove duplicated ACL when applying a topic

  • Updated the rule for APPLICATION_ACCESS_GRANT_VIEW similar to APPLICATION_ACCESS_VIEW

  • Add connector logging status to environments/search/findByApplication endpoint response

  • Add delete /schema_versions/{uid} endpoint

  • RollBack all the changes to resolve username on findByAttribute endpoint

Bugfixes

  • Uploading a schema-version for an existing schema gives error

  • Auto-create/delete topic configs when toggling connector logging state.

7.2.0 - 2023-07-17

Added

  • Changes to create authentication on Confluent Cloud

  • Create/delete Connect log prefix ACLs when environment is saved/deleted

  • Create/delete ACLs when a Connect logging certificate is uploaded/deleted

  • Automatically create topic configurations as part of the connector logging support feature

  • Handle concurrency in creation of application_access

  • Support Headers based authentication

  • Set user fullName as createdBy/modifiedBy for myApplications and myTopics APIs

  • Allow onboarding a ConfluentCloud cluster as a CloudAdmin

  • Get /group endpoint returns sorted by name, add myTeams param to get /application_access_grants/search/findByAttributes endpoint

  • Allow to delete API Keys on Confluent Cloud

Bugfixes

  • Change topicConfig properties endpoint to use envID

  • If resource does not exist return 404 instead of 403 for all getById APIs

  • Expect a clusterName param for ConfluentCloud when getting the external topic details

  • fix /applications/search/findByAttributes and /streams/search/findByAttributes APIs returning duplicated items

7.1.0 - 2023-06-15

Added

  • Add POST /application_authentications endpoint to create credentials for any provider

  • Create/delete prefix ACLs when instance is saved with connect logging enabled

Bugfixes

  • Improve error message of an unauthorized user attempting to browse a stream

  • Fix Hibernate Lazy Initialization on ConnectPluginInfo

7.0.6 - 2023-06-09

Added

  • Added a toggle to enable/disable support for connector-logging.

Bugfixes

  • Fixed streamConfig update policy

  • Allow user to provide single character for firstname and lastname

7.0.5 - 2023-06-05

Bugfixes

  • Fixes issue with topic apply on any newly created topic

7.0.4 - 2023-05-30

Added

  • Eliminate the need for ApplicationAccess

  • Allow creating/updating kafka topic without optional kafka properties

  • Update HorizontalPodAutoscaler to autoscaling/v2 apiVersion in helm-chart

  • Delete /application_authentications endpoint to delete user on any provider

  • Fixed hibernate lazy initialization issue with asyncApi endpoint

  • Added a check to validate if an environment’s Authorization issue is Auto before browsing a stream

  • Updated findStreamConfigById in stream config repository to a custom query

  • Updated findById in stream config repository to a custom query

Bugfixes

  • Fix for Browsing a stream on a Public Environment with AUTO approval is denied

7.0.3 - 2023-05-25

Bugfixes

  • User in permission-group but not owner of stream-config cannot browse

  • Fix issue on application_access_grants/search/findByAttributes returning other tenant resources

  • Remove api/streams/{uid}/browse-access endpoint

  • Remove unused Validator components

  • Fix for Requesting application-access for the first time results in no-ACL for AUTO Approval Environment

Hotfixes

  • Added custom queries for few methods in ApplicationAccess, Stream and Environment repositories to avoid hibernate lazy loading

7.0.2 - 2023-05-11

Added

  • Add AsyncAPI specification for any StreamConfig in JSON or YAML format

7.0.1 - 2023-04-18

Bugfixes

  • Fixed restriction of non-admin users and non-members from updating the group

  • Set TopicSchemas as null in case the topic key/value type is not Avro for External Providers

7.0.0 - 2023-04-12

Added

  • Upgrade to Spring Boot 3.0.x

  • Added Stripe events integration

  • Added customer creation and subscription logic

  • Added subscription management database schema

  • Added subscription management module + pricing table endpoint

  • Added limitation of having just one active subscription

  • Added customer portal and checkout redirect

  • Added fallback value for products

  • Added Off-board customer from Stripe

  • Added Slack notification for Sales/Marketing when the user request a quote

  • Added organization Created event which is sent after Tenant creation

  • Added blocking clusters/groups creation upon reaching limit by client

  • Added subscription management module + pricing table endpoint

  • Added subscription management database schema

  • Exposed an endpoint to retrieve current customer’s usage and features

  • Added supporting multiple OIDC Provider

  • Exposed /me endpoint to return User and Tenant information

  • Added Aiven credentials validation and return Aiven services

  • Added Confluent Cloud credentials validation and return Confluent Cloud services

  • Exposed /wizard/topics endpoint to create base entities

  • Include topics, ACLs and Schemas as discovered resources for an external provider

  • Added fetching TopicDetails for available topics on a Kafka Provider

  • Added deleting stream browse permission groups when disabling granular browse permissions on the Instance

  • Added Streams/StreamConfigs, ACLs and Schemas import for an external provider

  • Added persisting secrets in Azure KeyVault for Aiven and ConfluentCloud providers

  • Added supporting Multiple owners to Search Application Grants by Attributes

  • Allow creating clusters with same name on different tenants

  • Delete topic via Provider Library added

  • Allowing imported topics to have any Kafka properties

  • Added apply topic and update existing topic via Provider Library

  • Exposed GET /schemas/findAllWithLatestVersion endpoint to list all schemas with the latest schema versions

  • Updated authMethods to match the external Kafka Providers

  • Added uid and comment to ApplicationAccessGrant Response

  • Added Cluster and Schema-Registry API/Secret to connect to ConfluentCloud provider

  • Converted custom initial_group claim into existing Group to add new user when converting an Auth0 JWT

  • Added Off-board an Axual Governance Organization and its resources

  • Added Filter out topic properties which are topic fields

  • Allow ConfluentCloud applications to manage their AccountID

Bugfixes

  • Fixed creation of browse permission group for Auto environment

  • Fixed NPE when getting subscription info on Auth0 authentication

  • Added Instance.apiUrl as part of the response when getting an Environment

  • Added delete link to GET /clusters/{uid} endpoint

  • Fixed issues with the endpoint /users/search/searchUser

  • Updated the application.adoc mentioning _ are allowed for applicationId

  • Make all error responses consistent

  • Added /instance/{uid}/clusters to return only owned cluster in case the Instance is using an external Kafka cluster

  • Add SASL_PLAIN to GET /authentication_methods to support tenant update with SASL_PLAIN

  • Fixed /deletion-constraints endpoint to return 404 instead of 403

  • Change application_id type to store long applicationId coming from Confluent-Cloud

  • Set default value of create-stream.disable-time to 0 minutes

  • Changed imported stream description

  • Fixed issue on application_access_grants/search/findByAttributes returning other tenant resources

  • Fix issue of not passing partitionCount and set proper SchemaType when no schema is present

  • Remove username prefix from imported applications name for Aiven provider

  • Allow updating Stream and Application owners by TENANT_ADMIN

  • Allow AxualAuditorAware to work with anonymous user and anonymous authentication token

  • Subscriptions shouldn’t be deleted

Deprecated

  • MySQL 5.7 support has been removed and connecting to a MySQL 5.7 DB won’t work with Platform Manager 7.x

6.20.4 - 2022-01-19

Bugfixes

  • Fix for instance setting being ignored when there is no stream browse permission group

6.20.3 - 2022-01-18

Bugfixes

  • Setting max size limit of pagination to 9999

6.20.2 - 2023-01-16

Bugfixes

  • Change default value for Instance.environmentMapping to true

6.20.1 - 2022-01-10

Bugfixes

  • Fix for Environment filter issue on application-access-grant search

6.20.0 - 2022-12-15

Added

  • Check schema compatibility only when schema versions have changed

  • Remove schema compatibility check when schema key/value versions are not changed

  • Introduce a new endpoint to simplify the creation of an ApplicationAccessGrant

  • Mark search endpoints in Application Access as deprecated

  • New search endpoints for Application Access Grant

6.19.0 - 2022-11-17

Added

Bugfixes

  • Delete certificate/privateKey when deleting a connector application

  • Deactivate connector plugin when they are removed from Axual Connect

  • Fix /connect_plugins to return only active connector plugins

6.18.1 - 2022-11-07

Bugfixes

  • Fix NPE thrown when validating certificate without correct extension

6.18.0 - 2022-11-02

Added

BugFixes

  • Fix /tenant endpoint to expose updated tenant’s value

6.17.0 - 2022-10-21

Added

Bugfixes

  • Fix connector’s cert-uri when Vault.Namespace is provided

6.16.1 - 2022-10-13

Bugfixes

  • Fix Environments without a color to have a default color

6.16.0 - 2022-09-30

Bugfixes

  • Fix fetching pluginConfigs when updating ConnectorPluginInfo ConnectPlugins

6.15.1 - 2022-09-13

Bugfixes

6.15.0 - 2022-08-24

Added

6.14.0 - 2022-08-16

Added

Bugfixes

6.13.0 - 2022-07-25

Added

Bugfixes

6.12.1 - 2022-07-12

Added

  • Made Stream Value Type, Key Type, Retention Time, Schema(if AVRO) editable Update a stream

6.12.0 - 2022-06-15

Added

Bugfixes

  • Fix API to provide proper HTTP error response when Vault is unavailable

  • Fix User profile to display group membership /groups/search/findByMembersContains

  • When creating a stream-config and instance without segment.ms property, load it from Management API defaults Create stream config endpoints

  • Fix issue while uploading LF certificate and private-key to Vault

6.11.0 - 2022-05-19

Added

6.10.0 - 2022-04-14

Added

6.9.2 - 2022-03-29

Bugfixes

  • Fix generation of connector certUri when storing security on Vault

6.9.1 - 2022-03-09 (NOT VALID FOR DEPLOYMENT)

Added

Bugfixes

  • Fix NPE when the connector returns a null ConfigValue

6.9.0 - 2022-02-23 (NOT VALID FOR DEPLOYMENT)

Added

Bugfixes

6.8.0 - 2021-12-16

Added

Bugfixes

6.7.1 - 2021-11-11

Added

6.7.0 - 2021-10-21

Added

  • Use environment connector plugin version

6.6.0 - 2021-10-07

Added

6.5.0 - 2021-09-14

Added

Bugfixes

  • Fix inconsistency between Axual Connect state and self-service state

  • Management API cannot create new cluster Create a cluster

6.4.0 - 2021-08-12

Added

  • Include cluster names to InstanceUsage returned to Billing View Usage

Bugfixes

6.3.0 - 2021-07-15

Added

Bugfixes

6.2.0 - 2021-06-17

Added

  • Disable changing an environment’s instance or shortName when stream configs exist Update an environment

6.1.0 - 2021-06-10

Added

Bugfixes

  • Uploading the PEM file with the cert + intermediate CA + root CA gives error when saving principal Create Application Principal

  • Support windows line ending for PK/certificate/schema upload

6.0.1 - 2021-04-22

Added

6.0.0 - 2021-03-22

Added

  • Add support for exactly once semantics in Producers.

Breaking Changes

This document lists all the breaking changes introduced in each major version. Please review the changes for each version to ensure compatibility with your existing systems.

1. Version 9.0.0

1.1. Cleanup of notificationsEnabled field

Response structure for /user and /tenant has changed:

...
"settings" : {
  "notificationEnabled" : "true"
},
"notificationEnabled" : "true" // removed
...

Also, notificationEnabled field was removed from the response of /me endpoint.

API references: Retrieve user and Retrieve tenant

2. Deprecated APIs

All the deprecated APIs and their alternatives are listed below. These deprecated endpoints will be removed as part of next major release

Deprecated API Alternative API Deprecated since version Removed since version

GET /instances/search/findByName

/instances/search/findByAttributes

10.1.0

Not removed yet

GET /instances/search/findByNameContaining

/instances/search/findByAttributes

10.1.0

Not removed yet

POST /groups/{uid}/members

Update a Group

10.0.0

Not removed yet

GET /groups/{uid}/members

Retrieve a group

10.0.0

Not removed yet

PUT /groups/{uid}/members

Update a Group

10.0.0

Not removed yet

DELETE /groups/{uid}/members/{uid}

Update a Group

10.0.0

Not removed yet

POST /application_credentials

Create Credential on Apache Kafka

9.1.2

10.0.0

DELETE /application_credentials

Delete User on any Providers

9.1.2

10.0.0

GET /streams/{uid}/browse-config

Topic browse config

9.1.2

Not removed yet

GET /schemas/getAllWithLatestSchemaVersion

List all schemas with the latest schema versions and links

8.7.0

Not removed yet

POST /schemas

Upload schemas

8.6.2

10.0.0

PATCH /application_principals/{uid}

Create Application Principal Delete application principal

8.4.0

Not removed yet

DELETE /application_access/{uid}/grants

Revoke/Deny an authorization request for an ApplicationAccessGrant

7.0.4

Not removed yet

GET /application_access_grants/search/findActionable

Searching grants by Attributes

7.0.4

Not removed yet

GET /application_access_grants/search/findInformative

Searching grants by Attributes

7.0.4

Not removed yet

GET /application_access_grants/search/findAllInformative

Searching grants by Attributes

7.0.4

Not removed yet

GET streams/{uid}/browse-access

Use StreamBrowse

7.0.3

Not removed yet

GET /application_access/{uid}

6.20.0

Not removed yet

GET /application_access/search/findByApplication

6.20.0

Not removed yet

GET /application_access/search/findByStream

6.20.0

Not removed yet

GET /application_access/search/findByApplicationAndStream

6.20.0

Not removed yet

GET /application_access/search/findByEnvironment

6.20.0

Not removed yet

POST /application_access

Create an ApplicationAccessGrant

6.20.0

Not removed yet

POST /application_access/{uid}/grants

Create an ApplicationAccessGrant

6.20.0

Not removed yet

GET /application_access_grants/search/findByStream

Searching grants by Attributes

6.20.0

Not removed yet

POST /schema_versions

Upload schemas

6.14.0

10.0.0

GET /applications/search/findByName

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findByShortName

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findByNameIgnoreCase

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findByApplicationType

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findByApplicationIds

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findAll

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findByNameContaining

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /auth/billing

Auth

6.9.0

10.0.0

GET /auth/subscription

Auth

6.9.0

10.0.0

POST /schemas/check

Check and Parse a schema

6.3.0

10.0.0

GET streams/{uid}/browse

Use StreamBrowse

4.5.0

10.0.0

2.1. Supported Databases

Management API uses Flyway to perform database migration.

We currently support:

Provider Version

MariaDB

10.3

MySQL

8.0

3. HTTP verbs

Management API tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.

Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

PATCH

Used to update an existing resource, including partial updates

DELETE

Used to delete an existing resource

4. HTTP status codes

Management API tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.

Status code Usage

200 OK

The request completed successfully

201 Created

A new resource has been created successfully. The resource’s URI is available from the response’s Location header

204 No Content

An update to an existing resource has been applied successfully

400 Bad Request

The request was malformed. The response body will include an error providing further information

404 Not Found

The requested resource did not exist

5. Errors

Whenever an error response (status code >= 400) is returned, the body will contain a JSON object that describes the problem. The error object has the following structure:

Path Type Description

message

String

A description of the cause of the error

status

String

The HTTP error that occurred, e.g. BAD_REQUEST

errors

Array

A list of errors containing the description of the cause of the errors

For example, a request that attempts to create a Tenant without a body will produce a 400 Bad Request response:

HTTP/1.1 400 Bad Request
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 234

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Invalid request body: `JSON parse error: No content to map due to end-of-input`. Please check API docs for building correct request." ],
  "subErrors" : null
}

5.1. Inconsistent Errors

With API version 7.0.0 the all error responses have been replaced with the consistent format as described in Inconsistent Errors section.

6. Application Information

Management API is a Spring Boot application. In order to access general information regarding name, version, etc. please use the bellow request to do so:

GET /info HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

The response will have the following format:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 136

{
  "name" : "axual-flux",
  "description" : "Platform Manager API - provides APIs to operate Axual resources",
  "version" : "10.1.0"
}

7. Hypermedia

Management API uses hypermedia and resources include links to other resources in their responses. Responses are in Hypertext Application from resource to resource. Language (HAL) format. Links can be found beneath the _links key. Users of the API should not create URIs themselves, instead they should use the above-described links to navigate

Paging

All collection resources return results with pagination. Pagination is also supported for search endpoints.

To access the first page of the results, call the endpoint with ?page=0 or nothing at all. This will return by default a maximum of 20 results per page. To change this value, specify size=10 to return 10 results per page.

The response includes various helper links to easily navigate between pages via prev and next link and jump to first and last page.

A JSON object page at the end of the response summarizes the current page, total number of elements and other relevant details.

See below example for more details.

.1. Query parameters

Parameter Description

page

The page to retrieve

size

Number of entries per page, default value is 20

.2. HTTP request

GET /tenants?page=0&size=5 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 6646

{
  "_embedded" : {
    "tenants" : [ {
      "properties" : null,
      "name" : "Super Test Tenant",
      "shortName" : "supertenant",
      "uniqueConsumerGroup" : true,
      "logo" : "supertenant.png",
      "issuerUrl" : "http://api.example.com/auth/realms/supertenant",
      "dataClassificationEnabled" : true,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      } ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1149c97f04c24cad8d9c97faa5a375ac",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : { },
      "name" : "Clean Tenant cc",
      "shortName" : "clntntcc",
      "uniqueConsumerGroup" : true,
      "logo" : "clean.png",
      "issuerUrl" : "http://api.example.com/auth/realms/clntntcc",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "false",
        "schemaRolesEnforced" : "false"
      },
      "uid" : "1149c97f04c42ha69d9c97f420a375ac",
      "created_at" : "2023-03-10T03:16:23",
      "modified_at" : "2023-03-10T03:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : null,
      "name" : "BYOK Tenant",
      "shortName" : "BYOKtenant",
      "uniqueConsumerGroup" : true,
      "logo" : "BYOKtenant.png",
      "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
      "dataClassificationEnabled" : true,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1149c97f04c42had8d9c97faa5a375ac",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : null,
      "name" : "Limited BYOK Tenant",
      "shortName" : "LmtBYOKtnt",
      "uniqueConsumerGroup" : false,
      "logo" : "BYOKtenant.png",
      "issuerUrl" : "http://api.example.com/auth/realms/limitedBYOKtenant",
      "dataClassificationEnabled" : true,
      "supportedAuthenticationMethods" : [ ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1248c97f04c42had8d9c97faa5a375bd",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : { },
      "name" : "Clean Tenant aiven",
      "shortName" : "clntnt",
      "uniqueConsumerGroup" : true,
      "logo" : "clean.png",
      "issuerUrl" : "http://api.example.com/auth/realms/clntnt",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1259c97f04c42ha69d9c97f420a375ac",
      "created_at" : "2023-03-10T03:16:23",
      "modified_at" : "2023-03-10T03:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    }
  },
  "page" : {
    "size" : 5,
    "totalElements" : 10,
    "totalPages" : 2,
    "number" : 0
  }
}
Relation Description

first

The first page of results

last

The last page of results

next

The next page of results

prev

The previous page of results

.5. Response fields

Path Type Description

_embedded

Object

List of results

_links

Object

Links to other resources and pages

page

Object

Summary of current page results

page.size

Number

Number of results in current page

page.totalElements

Number

Total number of results available

page.totalPages

Number

Total pages available

page.number

Number

Current page number (starting with zero)

Sorting

The keyword sort can be used on collection resources and search endpoints to sort on given field name. Using the keyword asc or desc, the direction of sorting can be changed.

Multiple fields can be used for sorting by using the request parameter ?sort=PROPERTY1&sort=PROPERTY2 and so on.

.1. Query parameters

Parameter Description

sort

The field to sort on. Multiple fields can be specified by adding &sort=PROPERTY. To change the direction append a , to the property name plus either asc or desc

.2. HTTP request

GET /tenants?sort=shortName&size=5 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 6646

{
  "_embedded" : {
    "tenants" : [ {
      "properties" : null,
      "name" : "BYOK Tenant",
      "shortName" : "BYOKtenant",
      "uniqueConsumerGroup" : true,
      "logo" : "BYOKtenant.png",
      "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
      "dataClassificationEnabled" : true,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1149c97f04c42had8d9c97faa5a375ac",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : { },
      "name" : "Clean Tenant aiven",
      "shortName" : "clntnt",
      "uniqueConsumerGroup" : true,
      "logo" : "clean.png",
      "issuerUrl" : "http://api.example.com/auth/realms/clntnt",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1259c97f04c42ha69d9c97f420a375ac",
      "created_at" : "2023-03-10T03:16:23",
      "modified_at" : "2023-03-10T03:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : { },
      "name" : "Clean Tenant cc",
      "shortName" : "clntntcc",
      "uniqueConsumerGroup" : true,
      "logo" : "clean.png",
      "issuerUrl" : "http://api.example.com/auth/realms/clntntcc",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "false",
        "schemaRolesEnforced" : "false"
      },
      "uid" : "1149c97f04c42ha69d9c97f420a375ac",
      "created_at" : "2023-03-10T03:16:23",
      "modified_at" : "2023-03-10T03:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : null,
      "name" : "Limited BYOK Tenant",
      "shortName" : "LmtBYOKtnt",
      "uniqueConsumerGroup" : false,
      "logo" : "BYOKtenant.png",
      "issuerUrl" : "http://api.example.com/auth/realms/limitedBYOKtenant",
      "dataClassificationEnabled" : true,
      "supportedAuthenticationMethods" : [ ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1248c97f04c42had8d9c97faa5a375bd",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : null,
      "name" : "Super Test Tenant",
      "shortName" : "supertenant",
      "uniqueConsumerGroup" : true,
      "logo" : "supertenant.png",
      "issuerUrl" : "http://api.example.com/auth/realms/supertenant",
      "dataClassificationEnabled" : true,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      } ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1149c97f04c24cad8d9c97faa5a375ac",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    }
  },
  "page" : {
    "size" : 5,
    "totalElements" : 10,
    "totalPages" : 2,
    "number" : 0
  }
}

8. Security

8.1. Authentication

Axual is using Bearer Authentication. Every request must be authenticated.

Get the Bearer token:

curl --request POST \
 --url https://<your-installation-host>/auth/realms/<your-realm>/protocol/openid-connect/token \
 --header 'Content-Type: application/x-www-form-urlencoded' \
 --data client_id=self-service \
 --data username=<username> \
 --data password=<password> \
 --data realm=<your-realm> \
 --data grant_type=password

After any Bearer token request, the response will contain an access_token which can be used as Bearer token in subsequent calls.

In the previous example request the API expects a POST body with username, password and realm fields.

Pass the Bearer token in the Authorization header:

curl -H 'Accept: application/json' -H "Authorization: {Bearer token}" https://{hostname}/api/myresource

Example GET request:

8.1.1. Curl request

$ curl 'http://api.example.com/applications' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

Example POST request:

8.1.2. Curl request

$ curl 'http://api.example.com/applications' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "applicationId" : "com.axual.turbulence.connector.application1",
  "name" : "Test Connector Application",
  "shortName" : "test_cnnt_app",
  "description" : "This is a connector test application",
  "applicationType" : "CONNECTOR",
  "type" : "sink",
  "applicationClass" : "io.axual.distributor.logger.MessageLogger",
  "applicationClassVersion" : "1.0.0",
  "visibility" : "PRIVATE",
  "owners" : "http://api.example.com/groups/514d4oit834841869644c2ad8b439997"
}'

8.2. Get the authenticated user

8.2.1. GET /user

Returns all available information about the currently authenticated user.

GET /user HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1216

{
  "firstName" : "powerUser",
  "lastName" : "powerUser",
  "middleName" : null,
  "emailAddress" : {
    "email" : "poweruser@tenanta.nl"
  },
  "phoneNumber" : null,
  "roles" : [ {
    "name" : "SCHEMA_ADMIN"
  }, {
    "name" : "STREAM_ADMIN"
  }, {
    "name" : "TENANT_ADMIN"
  }, {
    "name" : "APPLICATION_ADMIN"
  }, {
    "name" : "ENVIRONMENT_ADMIN"
  }, {
    "name" : "SUPER_ADMIN"
  } ],
  "settings" : { },
  "fullName" : "powerUser powerUser",
  "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "user" : {
      "href" : "...",
      "templated" : true,
      "title" : "A user"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "assign_roles" : {
      "href" : "...",
      "title" : "Indication that authenticated user can assign roles to this user"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    }
  }
}

8.2.2. Get my groups

Returns all groups that currently authenticated user belongs to.

GET /group HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1858

{
  "_embedded" : {
    "groups" : [ {
      "_links" : {
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ],
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "Application-tenAApplication1",
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ],
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "Stream-tenAApplication2",
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "88eb98e0eff34fde923c15687e6d75d5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}
Get my groups by name

Returns all groups that currently authenticated user belongs to by passing the name.

Query parameters
Parameter Description

name

Property is to search by group name
HTTP request
GET /group?name=Stream-tenAApplication2 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1054

{
  "_embedded" : {
    "groups" : [ {
      "_links" : {
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ],
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "Stream-tenAApplication2",
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "88eb98e0eff34fde923c15687e6d75d5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

8.3. Get the authenticated tenant

8.3.1. GET /tenant

Returns the tenant of the logged-in user.

GET /tenant HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1173

{
  "properties" : {
    "replication.factor" : "1",
    "min.insync.replicas" : "1",
    "cleanup.policy" : "delete"
  },
  "name" : "TenantA",
  "shortName" : "tenanta",
  "uniqueConsumerGroup" : true,
  "logo" : "tenanta.png",
  "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
  "dataClassificationEnabled" : false,
  "supportedAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "wizardCompleted" : true,
  "customerId" : null,
  "settings" : {
    "notificationsEnabled" : "true",
    "schemaRolesEnforced" : "true",
    "onlyResourceManagerCanUpdateAndDeploy" : "false"
  },
  "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    }
  }
}

Resources

9. Index

The index provides the entry point into the service.

9.1. Accessing the index

A GET request is used to access the index

9.1.1. Response fields

Path Type Description

_links

Object

Links to other resources

9.1.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 2616

{
  "_links" : {
    "auditEntries" : {
      "href" : "...",
      "templated" : true
    },
    "applications" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create applications"
    },
    "stream_configs" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create streams"
    },
    "schemas" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create schemas"
    },
    "application_principals" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create ApplicationPrincipals"
    },
    "instances" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create instances"
    },
    "tenants" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create tenants"
    },
    "environments" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create environments"
    },
    "application_deployments" : {
      "href" : "...",
      "templated" : true
    },
    "schema_versions" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create schema versions"
    },
    "application_access" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create ApplicationAccess"
    },
    "streams" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create streams"
    },
    "support_tiers" : {
      "href" : "...",
      "templated" : true
    },
    "connect_plugins" : {
      "href" : "...",
      "templated" : true
    },
    "clusters" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create clusters"
    },
    "application_access_grants" : {
      "href" : "...",
      "templated" : true
    },
    "application_credentials" : {
      "href" : "...",
      "templated" : true
    },
    "groups" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create groups"
    },
    "integrities" : {
      "href" : "...",
      "templated" : true
    },
    "confidentialities" : {
      "href" : "...",
      "templated" : true
    },
    "users" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access or create users"
    },
    "group" : {
      "href" : "...",
      "title" : "A group"
    },
    "user" : {
      "href" : "...",
      "title" : "A user"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    }
  }
}
Relation Description

users

The Users resource

groups

The Groups resource

instances

The Instances resource

clusters

The Clusters resource

environments

The Environments resource

tenants

The Tenants resource

streams

The Streams resource

stream_configs

The StreamConfigs resource

schemas

The Schemas resource

schema_versions

The SchemaVersions resource

applications

The Applications resource

application_principals

The ApplicationPrincipals resource

application_access

The ApplicationAccess resource

application_access_grants

The ApplicationAccessGrant resource

user

Returns the authenticated user

group

Returns the groups that authenticated user belongs to

tenant

Returns the authenticated tenant

profile

The ALPS profile for the service

confidentialities

Returns the confidentiality levels

integrities

Returns the integrity

support_tiers

Returns the support tiers

application_deployments

The ApplicationDeployment resource

connect_plugins

The ConnectPluginsInfo resource

application_credentials

The ApplicationCredentials resource

auditEntries

The <<resources-auditEvents,AuditEvents resource

10. AsyncAPI Specification

Generate and view AsyncAPI specification for any topic in Self-Service. Any authenticated user can view the AsyncAPI specification for a deployed topic.

10.1. View the AsyncAPI Specification as JSON

When proving a Request Header Accept: application/json the response will be in JSON format.

The AsyncAPI spec is included in the asyncApiSpec field.

10.1.1. Curl request

$ curl 'http://api.example.com/stream_configs/c082e097545948dcbd0cf993128d3fc2/asyncapi' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/json'

10.1.2. HTTP request

GET /stream_configs/c082e097545948dcbd0cf993128d3fc2/asyncapi HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/json
Host: api.example.com

10.1.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2396

{
  "asyncApiSpec" : "---\nasyncapi: \"2.6.0\"\ninfo:\n  title: \"AsyncAPI for Topic tenanta-stream1\"\n  version: \"1.0.0\"\n  description: \"description_tenanta-stream1\"\nservers:\n  Zone1ClusterOTA:\n    url: \"bootstrapserver1:9093\"\n    protocol: \"kafka-secure\"\n    description: \"Zone1ClusterOTA brokers\"\n    security:\n    - SSL_MUTUAL_TLS: []\n    - SASL_SCRAM_SHA_256: []\n    bindings:\n      kafka:\n      - schemaRegistryUrl: \"https://schema.local1,https://schema.local2\"\n      - schemaRegistryVendor: \"confluent\"\ndefaultContentType: \"application/json\"\nchannels:\n  tenanta-stream1:\n    description: \"description_tenanta-stream1\"\n    subscribe:\n      description: \"Consume message from tenanta-stream1\"\n      message:\n        $ref: \"#/components/messages/tenanta-stream1\"\n    publish:\n      description: \"Produce message into tenanta-stream1\"\n      message:\n        $ref: \"#/components/messages/tenanta-stream1\"\n    bindings:\n      kafka:\n      - topic: \"tenanta-ota-tenantaenv1-tenanta-stream1\"\n      - partitions: 12\n      - topicConfiguration:\n        - cleanup.policy: \"delete\"\n        - retention.ms: 10000\ncomponents:\n  messages:\n    tenanta-stream1:\n      name: \"tenanta-stream1\"\n      bindings:\n        payload:\n          type: \"record\"\n          name: \"Value\"\n          namespace: \"io.axual.qa.general\"\n          doc: \"Object type that is supposed to be filled with a Value.\"\n          fields:\n          - name: \"value\"\n            type: \"string\"\n            doc: \"The Value.\"\n        kafka:\n          key:\n            type: \"record\"\n            name: \"Key\"\n            namespace: \"io.axual.qa.general\"\n            doc: \"Object type that is supposed to be filled with a Key.\"\n            fields:\n            - name: \"key\"\n              type: \"string\"\n              doc: \"The Key.\"\n        schemaFormat: \"application/vnd.apache.avro;version=1.9.0\"\n  securitySchemes:\n    SASL_SCRAM_SHA_256:\n      type: \"scramSha256\"\n      description: \"Provide your username and password for SASL/SCRAM authentication\"\n    SSL_MUTUAL_TLS:\n      type: \"X509\"\n      description: \"Provide your certificate for Mutual TLS authentication\"\ntags:\n- name: \"Self-Service Link\"\n  description: \"Link to Axual Self-Service\"\n  externalDocs:\n    url: \"https://axual.cloud\"\n"
}

10.2. View the AsyncAPI Specification as YAML

When proving a Request Header Accep: application/yaml the response will be in YAML format.

10.2.1. Curl request

$ curl 'http://api.example.com/stream_configs/c082e097545948dcbd0cf993128d3fc2/asyncapi' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/yaml'

10.2.2. HTTP request

GET /stream_configs/c082e097545948dcbd0cf993128d3fc2/asyncapi HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/yaml
Host: api.example.com

10.2.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/yaml
Content-Length: 2217

---
asyncapi: "2.6.0"
info:
  title: "AsyncAPI for Topic tenanta-stream1"
  version: "1.0.0"
  description: "description_tenanta-stream1"
servers:
  Zone1ClusterOTA:
    url: "bootstrapserver1:9093"
    protocol: "kafka-secure"
    description: "Zone1ClusterOTA brokers"
    security:
    - SSL_MUTUAL_TLS: []
    - SASL_SCRAM_SHA_256: []
    bindings:
      kafka:
      - schemaRegistryUrl: "https://schema.local1,https://schema.local2"
      - schemaRegistryVendor: "confluent"
defaultContentType: "application/json"
channels:
  tenanta-stream1:
    description: "description_tenanta-stream1"
    subscribe:
      description: "Consume message from tenanta-stream1"
      message:
        $ref: "#/components/messages/tenanta-stream1"
    publish:
      description: "Produce message into tenanta-stream1"
      message:
        $ref: "#/components/messages/tenanta-stream1"
    bindings:
      kafka:
      - topic: "tenanta-ota-tenantaenv1-tenanta-stream1"
      - partitions: 12
      - topicConfiguration:
        - cleanup.policy: "delete"
        - retention.ms: 10000
components:
  messages:
    tenanta-stream1:
      name: "tenanta-stream1"
      bindings:
        payload:
          type: "record"
          name: "Value"
          namespace: "io.axual.qa.general"
          doc: "Object type that is supposed to be filled with a Value."
          fields:
          - name: "value"
            type: "string"
            doc: "The Value."
        kafka:
          key:
            type: "record"
            name: "Key"
            namespace: "io.axual.qa.general"
            doc: "Object type that is supposed to be filled with a Key."
            fields:
            - name: "key"
              type: "string"
              doc: "The Key."
        schemaFormat: "application/vnd.apache.avro;version=1.9.0"
  securitySchemes:
    SASL_SCRAM_SHA_256:
      type: "scramSha256"
      description: "Provide your username and password for SASL/SCRAM authentication"
    SSL_MUTUAL_TLS:
      type: "X509"
      description: "Provide your certificate for Mutual TLS authentication"
tags:
- name: "Self-Service Link"
  description: "Link to Axual Self-Service"
  externalDocs:
    url: "https://axual.cloud"

11. Audit

Audit logging chronologically records resource activities in the audit_entry table, capturing details like user, tenant, timestamps, user actions like CREATED, DELETED, UPDATED, BROWSED, APPLICATION_ACCESS_REQUESTED, APPLICATION_ACCESS_CANCELLED, APPLICATION_ACCESS_APPROVED, APPLICATION_ACCESS_DENIED, APPLICATION_ACCESS_REVOKED, AUTHENTICATION_CONFIGURED, AUTHENTICATION_UNCONFIGURED, APPLICATION_CONFIGURED, APPLICATION_UNCONFIGURED, APPLICATION_STARTED, APPLICATION_STOPPED, APPLICATION_RESTARTED, APPLICATION_RESET, TOPIC_BROWSED, TOPIC_CONFIGURED, TOPIC_UNCONFIGURED, BROWSE_PERMISSION_GRANTED and BROWSE_PERMISSION_REVOKED.

11.1. Get Audit History

A GET request allows you to retrieve audit history using multiple optional parameters.

If no parameters are provided, the request will return the complete audit history.

If you want to see the audit histories for an existing resource, search by the resourceId, if the desired resource is deleted, search by resourceName.

11.1.1. Query parameters

Parameter Description

action

Type of the performed action. Available Actions: CREATED, UPDATED, DELETED, TOPIC_BROWSED, APPLICATION_ACCESS_REQUESTED, APPLICATION_ACCESS_CANCELLED, APPLICATION_ACCESS_APPROVED, APPLICATION_ACCESS_DENIED, APPLICATION_ACCESS_REVOKED, AUTHENTICATION_CONFIGURED, AUTHENTICATION_UNCONFIGURED, APPLICATION_CONFIGURED, APPLICATION_UNCONFIGURED, APPLICATION_STARTED, APPLICATION_STOPPED, APPLICATION_RESTARTED, APPLICATION_RESET, TOPIC_CONFIGURED, TOPIC_UNCONFIGURED, BROWSE_PERMISSION_GRANTED, BROWSE_PERMISSION_REVOKED

resourceType

Type of the resource that an action was performed on. Available Resources: Instance, Application

actor

The email address of the actor of the the action

resourceName

The name of the resource to search for, applicable for the main resources like Tenant, User, Group, Cluster, Instance, Schema, Environment, Topic and Application

resourceId

The UUID of the resource to search for

fromTimestamp

The absolute or Relative time range

toTimestamp

The absolute or Relative time range

page

Navigate through different pages

size

Property to define the page size

11.1.2. HTTP request

GET /audit-history?action=CREATED&resourceType=APPLICATION&actor=appadmin%40tenanta.nl&resourceName=app&resourceId=&fromTimestamp=1692368520065&toTimestamp=1741194555000&page=0&size=10 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

11.1.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 255

{
  "_embedded" : {
    "events" : [ ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 0,
    "totalElements" : 0,
    "totalPages" : 1,
    "number" : 0
  }
}

12. Auth

Management API acts as the Authorization service. All the requests passing through MGMT API are also authenticated against Keycloak or an OIDC provider.

The /auth base path for authentication / authorization endpoints.

13. Generic auth

The auth endpoint can be used by all services to check if a user has authority to perform a certain action.

13.1. Curl request

$ curl 'http://api.example.com/auth?action=STREAM_CONFIG_VIEW&resourceType=STREAM_CONFIG&resourceUid=c082e097545948dcbd0cf993128d3fc2' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

13.2. HTTP request

GET /auth?action=STREAM_CONFIG_VIEW&resourceType=STREAM_CONFIG&resourceUid=c082e097545948dcbd0cf993128d3fc2 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

13.3. HTTP response

HTTP/1.1 200 OK

14. External Kafka Providers

Starting with Platform Manager version 7.0.0 we are supporting external kafka providers.

14.1. Supported Kafka Providers

  • Aiven

  • Apache Kafka

  • Confluent Cloud

14.2. Validate Provider Credentials

A POST request will validate provided credentials and return available services.

Based on the Kafka Provider the request will be different.

14.2.1. Aiven

When interacting with Aiven, the Axl-Provider-Type field has to be aiven.

Additionally, provide Axl-Project-Id-Aiven and Axl-Auth-Token-Aiven in your request body.

Request fields
Path Type Description Constraints

Axl-Provider-Type

String

The Axual Provider Type

Axl-Project-Id-Aiven

String

The Aiven Project the token is valid for

Axl-Auth-Token-Aiven

String

The authorization token for Aiven API
Curl request
$ curl 'http://api.example.com/providers/validateCredentials' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "Axl-Provider-Type" : "aiven",
  "Axl-Project-Id-Aiven" : "aiven-project",
  "Axl-Auth-Token-Aiven" : "aiven-auth-token"
}'
HTTP request
POST /providers/validateCredentials HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 126
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "Axl-Provider-Type" : "aiven",
  "Axl-Project-Id-Aiven" : "aiven-project",
  "Axl-Auth-Token-Aiven" : "aiven-auth-token"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 351

{
  "credentialsValid" : true,
  "error" : null,
  "environments" : [ {
    "services" : [ {
      "kafkaCluster" : {
        "id" : "kafka-1",
        "url" : "kafka-1:8084"
      },
      "schemaRegistryClusters" : [ {
        "id" : "schema-registry-1",
        "url" : "schema-registry-1:8084"
      } ]
    } ],
    "environmentId" : null
  } ]
}

14.2.2. Apache Kafka

When integrating with Apache Kafka, the Axl-Provider-Type field has to be apache-kafka.

Verify mTLS credentials

Additionally, to check mTLS certificate/private-key certification provide Axl-Bootstrap-Server-ApacheKafka, Axl-Broker-Protocol-Type-ApacheKafka, Axl-Broker-Cert-ApacheKafka and Axl-Broker-Private-Key-ApacheKafka in your request body. If Axl-Broker-CA-Validation-ApacheKafka is true, provide also the Axl-Broker-Truststore-ApacheKafka in your request body.

Request fields
Path Type Description Constraints

Axl-Provider-Type

String

The Authentication Protocol Type of broker.

Axl-Bootstrap-Server-ApacheKafka

String

The URL of the Kafka broker(s) to connect to Apache Kafka.

Axl-Broker-Protocol-Type-ApacheKafka

String

The Authentication Protocol Type of broker. Options are mTLS, SASL/PLAIN, SASL/SCRAM-SHA-256, SASL/SCRAM-SHA-512.

Axl-Broker-Private-Key-ApacheKafka

String

The Base64 encrypted client private key that is used to interact with an Apache Kafka with mTLS authentication.

Axl-Broker-Cert-ApacheKafka

String

The Base64 encrypted client certificate chain that is used to interact with an Apache Kafka with mTLS authentication.

Axl-Broker-CA-Validation-ApacheKafka

String

The Flag to define CA validation when interacting with an Apache Kafka.

Axl-Broker-Truststore-ApacheKafka

String

The (optional) Base64 encrypted broker truststore cert of the Admin User to connect to an Apache Kafka.
Curl request
$ curl 'http://api.example.com/providers/validateCredentials' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "Axl-Provider-Type" : "apache-kafka",
  "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
  "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
  "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
  "Axl-Broker-Cert-ApacheKafka" : "cert",
  "Axl-Broker-CA-Validation-ApacheKafka" : "true",
  "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate"
}'
HTTP request
POST /providers/validateCredentials HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 360
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "Axl-Provider-Type" : "apache-kafka",
  "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
  "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
  "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
  "Axl-Broker-Cert-ApacheKafka" : "cert",
  "Axl-Broker-CA-Validation-ApacheKafka" : "true",
  "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 74

{
  "credentialsValid" : true,
  "error" : null,
  "environments" : null
}
Verify SASL credentials

Additionally, to check SASL credentials provide Axl-Bootstrap-Server-ApacheKafka, Axl-Broker-Protocol-Type-ApacheKafka, Axl-Broker-Security-Protocol-Type-ApacheKafka, Axl-Broker-Username-ApacheKafka, and Axl-Broker-Password-ApacheKafka in your request body. If Axl-Broker-CA-Validation-ApacheKafka is true, provide also the Axl-Broker-Truststore-ApacheKafka in your request body.

Request fields
Path Type Description Constraints

Axl-Provider-Type

String

The Authentication Protocol Type of broker.

Axl-Bootstrap-Server-ApacheKafka

String

The URL of the Kafka broker(s) to connect to Apache Kafka.

Axl-Broker-Protocol-Type-ApacheKafka

String

The Authentication Protocol Type of broker. Options are mTLS, SASL/PLAIN, SASL/SCRAM-SHA-256, SASL/SCRAM-SHA-512.

Axl-Broker-Security-Protocol-Type-ApacheKafka

String

The security protocol used to communicate with the Kafka broker(s) (Only meaningful for SASL authentication). Options are SASL_PLAINTEXT, SASL_SSL.

Axl-Broker-Username-ApacheKafka

String

The broker Username used to connect to Apache Kafka with SASL authentication.

Axl-Broker-Password-ApacheKafka

String

The broker Password used to connect to Apache Kafka with SASL authentication.

Axl-Broker-CA-Validation-ApacheKafka

String

The Flag to define CA validation when interacting with an Apache Kafka.

Axl-Broker-Truststore-ApacheKafka

String

The (optional) Base64 encrypted broker truststore cert of the Admin User to connect to an Apache Kafka.
Curl request
$ curl 'http://api.example.com/providers/validateCredentials' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "Axl-Provider-Type" : "apache-kafka",
  "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
  "Axl-Broker-Protocol-Type-ApacheKafka" : "SASL/PLAIN",
  "Axl-Broker-Security-Protocol-Type-ApacheKafka" : "SASL_SSL",
  "Axl-Broker-Username-ApacheKafka" : "kafka-user",
  "Axl-Broker-Password-ApacheKafka" : "kafka-password",
  "Axl-Broker-CA-Validation-ApacheKafka" : "true",
  "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate"
}'
HTTP request
POST /providers/validateCredentials HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 440
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "Axl-Provider-Type" : "apache-kafka",
  "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
  "Axl-Broker-Protocol-Type-ApacheKafka" : "SASL/PLAIN",
  "Axl-Broker-Security-Protocol-Type-ApacheKafka" : "SASL_SSL",
  "Axl-Broker-Username-ApacheKafka" : "kafka-user",
  "Axl-Broker-Password-ApacheKafka" : "kafka-password",
  "Axl-Broker-CA-Validation-ApacheKafka" : "true",
  "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 74

{
  "credentialsValid" : true,
  "error" : null,
  "environments" : null
}
Verify SASL Credential Basic Authentication of Schema Registry

Additionally, if you want to connect to a Schema Registry, to check SASL credentials with basic authentication provide Axl-Sr-Url-ApacheKafka, Axl-Sr-Protocol-Type-ApacheKafka, Axl-Sr-Username-ApacheKafka and Axl-Sr-Password-ApacheKafka in your request body.

Request fields
Path Type Description Constraints

Axl-Provider-Type

String

The Authentication Protocol Type of broker.

Axl-Bootstrap-Server-ApacheKafka

String

The URL of the Kafka broker(s) to connect to Apache Kafka.

Axl-Broker-Protocol-Type-ApacheKafka

String

The Authentication Protocol Type of broker. Options are mTLS, SASL/PLAIN, SASL/SCRAM-SHA-256, SASL/SCRAM-SHA-512.

Axl-Broker-Security-Protocol-Type-ApacheKafka

String

The security protocol used to communicate with the Kafka broker(s) (Only meaningful for SASL authentication). Options are SASL_PLAINTEXT, SASL_SSL.

Axl-Broker-Username-ApacheKafka

String

The broker Username used to connect to Apache Kafka with SASL authentication.

Axl-Broker-Password-ApacheKafka

String

The broker Password used to connect to Apache Kafka with SASL authentication.

Axl-Broker-CA-Validation-ApacheKafka

String

The Flag to define CA validation when interacting with an Apache Kafka.

Axl-Broker-Truststore-ApacheKafka

String

The (optional) Base64 encrypted broker truststore cert of the Admin User to connect to an Apache Kafka.

Axl-Sr-Url-ApacheKafka

String

The (optional) URL of the Schema Registry to interact with an Apache Kafka

Axl-Sr-Truststore-ApacheKafka

String

The (optional) Schema Registry truststore Cert of the Admin User to connect to a Schema Registry.

Axl-Sr-Protocol-Type-ApacheKafka

String

The (optional) Authentication Protocol Type to connect to a Schema Registry. It must be set to Basic-Auth

Axl-Sr-Username-ApacheKafka

String

The (optional) Username used to connect to a Schema Registry with Basic authentication.

Axl-Sr-Password-ApacheKafka

String

The (optional) Password used to connect to a Schema Registry with Basic authentication.
Curl request
$ curl 'http://api.example.com/providers/validateCredentials' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "Axl-Provider-Type" : "apache-kafka",
  "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
  "Axl-Broker-Protocol-Type-ApacheKafka" : "SASL/PLAIN",
  "Axl-Broker-Security-Protocol-Type-ApacheKafka" : "SASL_SSL",
  "Axl-Broker-Username-ApacheKafka" : "kafka-user",
  "Axl-Broker-Password-ApacheKafka" : "kafka-password",
  "Axl-Broker-CA-Validation-ApacheKafka" : "true",
  "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
  "Axl-Sr-Url-ApacheKafka" : "schema-registry-url",
  "Axl-Sr-Truststore-ApacheKafka" : "sr-ca-certificate",
  "Axl-Sr-Username-ApacheKafka" : "schema-registry-username",
  "Axl-Sr-Password-ApacheKafka" : "schema-registry-password",
  "Axl-Sr-Protocol-Type-ApacheKafka" : "Basic-Auth"
}'
HTTP request
POST /providers/validateCredentials HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 726
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "Axl-Provider-Type" : "apache-kafka",
  "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
  "Axl-Broker-Protocol-Type-ApacheKafka" : "SASL/PLAIN",
  "Axl-Broker-Security-Protocol-Type-ApacheKafka" : "SASL_SSL",
  "Axl-Broker-Username-ApacheKafka" : "kafka-user",
  "Axl-Broker-Password-ApacheKafka" : "kafka-password",
  "Axl-Broker-CA-Validation-ApacheKafka" : "true",
  "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
  "Axl-Sr-Url-ApacheKafka" : "schema-registry-url",
  "Axl-Sr-Truststore-ApacheKafka" : "sr-ca-certificate",
  "Axl-Sr-Username-ApacheKafka" : "schema-registry-username",
  "Axl-Sr-Password-ApacheKafka" : "schema-registry-password",
  "Axl-Sr-Protocol-Type-ApacheKafka" : "Basic-Auth"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 74

{
  "credentialsValid" : true,
  "error" : null,
  "environments" : null
}
Verify No Authentication of Schema Registry

Additionally, if you want to connect to a Schema Registry, to check no authentication provide Axl-Sr-Url-ApacheKafka, Axl-Sr-Protocol-Type-ApacheKafka in your request body.

Request fields
Path Type Description Constraints

Axl-Provider-Type

String

The Authentication Protocol Type of broker.

Axl-Bootstrap-Server-ApacheKafka

String

The URL of the Kafka broker(s) to connect to Apache Kafka.

Axl-Broker-Protocol-Type-ApacheKafka

String

The Authentication Protocol Type of broker. Options are mTLS, SASL/PLAIN, SASL/SCRAM-SHA-256, SASL/SCRAM-SHA-512.

Axl-Broker-Private-Key-ApacheKafka

String

The Base64 encrypted client private key that is used to interact with an Apache Kafka with mTLS authentication.

Axl-Broker-Cert-ApacheKafka

String

The Base64 encrypted client certificate chain that is used to interact with an Apache Kafka with mTLS authentication.

Axl-Broker-CA-Validation-ApacheKafka

String

The Flag to define CA validation when interacting with an Apache Kafka.

Axl-Broker-Truststore-ApacheKafka

String

The (optional) Base64 encrypted broker truststore cert of the Admin User to connect to an Apache Kafka.

Axl-Sr-Url-ApacheKafka

String

The (optional) URL of the Schema Registry to interact with an Apache Kafka

Axl-Sr-Truststore-ApacheKafka

String

The (optional) Schema Registry truststore Cert of the Admin User to connect to a Schema Registry.

Axl-Sr-Protocol-Type-ApacheKafka

String

The (optional) Authentication Protocol Type to connect to a Schema Registry. It must be set to No-Auth.
Curl request
$ curl 'http://api.example.com/providers/validateCredentials' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "Axl-Provider-Type" : "apache-kafka",
  "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
  "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
  "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
  "Axl-Broker-Cert-ApacheKafka" : "cert",
  "Axl-Broker-CA-Validation-ApacheKafka" : "true",
  "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
  "Axl-Sr-Url-ApacheKafka" : "schema-registry-url",
  "Axl-Sr-Truststore-ApacheKafka" : "sr-ca-certificate",
  "Axl-Sr-Protocol-Type-ApacheKafka" : "No-Auth"
}'
HTTP request
POST /providers/validateCredentials HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 519
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "Axl-Provider-Type" : "apache-kafka",
  "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
  "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
  "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
  "Axl-Broker-Cert-ApacheKafka" : "cert",
  "Axl-Broker-CA-Validation-ApacheKafka" : "true",
  "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
  "Axl-Sr-Url-ApacheKafka" : "schema-registry-url",
  "Axl-Sr-Truststore-ApacheKafka" : "sr-ca-certificate",
  "Axl-Sr-Protocol-Type-ApacheKafka" : "No-Auth"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 74

{
  "credentialsValid" : true,
  "error" : null,
  "environments" : null
}
Verify mTLS Authentication of Schema Registry

Additionally, if you want to connect to a Schema Registry, to check mTLS certificate/private-key certification provide Axl-Sr-Url-ApacheKafka, Axl-Sr-Cert-ApacheKafka, Axl-Sr-Private-Key-ApacheKafka and Axl-Sr-Truststore-ApacheKafka in your request body.

Request fields
Path Type Description Constraints

Axl-Provider-Type

String

The Authentication Protocol Type of broker.

Axl-Bootstrap-Server-ApacheKafka

String

The URL of the Kafka broker(s) to connect to Apache Kafka.

Axl-Broker-Protocol-Type-ApacheKafka

String

The Authentication Protocol Type of broker. Options are mTLS, SASL/PLAIN, SASL/SCRAM-SHA-256, SASL/SCRAM-SHA-512.

Axl-Broker-Private-Key-ApacheKafka

String

The Base64 encrypted client private key that is used to interact with an Apache Kafka with mTLS authentication.

Axl-Broker-Cert-ApacheKafka

String

The Base64 encrypted client certificate chain that is used to interact with an Apache Kafka with mTLS authentication.

Axl-Broker-CA-Validation-ApacheKafka

String

The Flag to define CA validation when interacting with an Apache Kafka.

Axl-Broker-Truststore-ApacheKafka

String

The (optional) Base64 encrypted broker truststore cert of the Admin User to connect to an Apache Kafka.

Axl-Sr-Protocol-Type-ApacheKafka

String

The Authentication Protocol Type to connect to a Schema Registry. It must be mTLS

Axl-Sr-Url-ApacheKafka

String

The URL of the Schema Registry to interact with an Apache Kafka.

Axl-Sr-Cert-ApacheKafka

String

The Schema Registry Cert of the Admin User to connect to a Schema Registry.

Axl-Sr-Private-Key-ApacheKafka

String

The private key of the Admin User to connect to a Schema Registry.

Axl-Sr-Truststore-ApacheKafka

String

The (optional) Schema Registry truststore Cert of the Admin User to connect to a Schema Registry.
Curl request
$ curl 'http://api.example.com/providers/validateCredentials' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "Axl-Provider-Type" : "apache-kafka",
  "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
  "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
  "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
  "Axl-Broker-Cert-ApacheKafka" : "cert",
  "Axl-Broker-CA-Validation-ApacheKafka" : "true",
  "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
  "Axl-Sr-Protocol-Type-ApacheKafka" : "MTLS",
  "Axl-Sr-Url-ApacheKafka" : "sr-url",
  "Axl-Sr-Truststore-ApacheKafka" : "sr-ca-certificate",
  "Axl-Sr-Cert-ApacheKafka" : "sr-cert",
  "Axl-Sr-Private-Key-ApacheKafka" : "sr-private-key"
}'
HTTP request
POST /providers/validateCredentials HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 599
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "Axl-Provider-Type" : "apache-kafka",
  "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
  "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
  "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
  "Axl-Broker-Cert-ApacheKafka" : "cert",
  "Axl-Broker-CA-Validation-ApacheKafka" : "true",
  "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
  "Axl-Sr-Protocol-Type-ApacheKafka" : "MTLS",
  "Axl-Sr-Url-ApacheKafka" : "sr-url",
  "Axl-Sr-Truststore-ApacheKafka" : "sr-ca-certificate",
  "Axl-Sr-Cert-ApacheKafka" : "sr-cert",
  "Axl-Sr-Private-Key-ApacheKafka" : "sr-private-key"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 74

{
  "credentialsValid" : true,
  "error" : null,
  "environments" : null
}

14.2.3. Confluent Cloud (Cloud API Key)

When interacting with Confluent Cloud, the Axl-Provider-Type field has to be confluent-cloud.

Additionally, provide Axl-Api-Key-Confluent and Axl-Secret-Confluent in your request body.

Provide a Cloud API Key to retrieve available services.
Request fields
Path Type Description Constraints

Axl-Provider-Type

String

The Axual Provider Type

Axl-Api-Key-Confluent

String

The Confluent Cloud API Key to retrieve Environments and Clusters

Axl-Secret-Confluent

String

The Confluent Cloud secret associated with the API Key
Curl request
$ curl 'http://api.example.com/providers/validateCredentials' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "Axl-Provider-Type" : "confluent-cloud",
  "Axl-Api-Key-Confluent" : "cloud-api-key",
  "Axl-Secret-Confluent" : "cloud-secret"
}'
HTTP request
POST /providers/validateCredentials HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 133
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "Axl-Provider-Type" : "confluent-cloud",
  "Axl-Api-Key-Confluent" : "cloud-api-key",
  "Axl-Secret-Confluent" : "cloud-secret"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 354

{
  "credentialsValid" : true,
  "error" : null,
  "environments" : [ {
    "services" : [ {
      "kafkaCluster" : {
        "id" : "kafka-1",
        "url" : "kafka-1:8084"
      },
      "schemaRegistryClusters" : [ {
        "id" : "schema-registry-1",
        "url" : "schema-registry-1:8084"
      } ]
    } ],
    "environmentId" : "env-1"
  } ]
}

14.3. Retrieve Resource Counters

A POST request will discover the resources and return the number of discovered resources.

Based on the Kafka Provider the request will be different.

14.3.1. Aiven

When interacting with Aiven, the Axl-Provider-Type field has to be aiven.

Additionally, provide Axl-Project-Id-Aiven, Axl-Auth-Token-Aiven, and Axl-Service-Name-Aiven in your request body.

Request fields
Path Type Description Constraints

Axl-Provider-Type

String

The Axual Provider Type

Axl-Project-Id-Aiven

String

The Aiven Project the token is valid for

Axl-Auth-Token-Aiven

String

The authorization token for Aiven API

Axl-Service-Name-Aiven

String

The Kafka Service Name used to discover resources
Curl request
$ curl 'http://api.example.com/providers/discoverResources' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "Axl-Provider-Type" : "aiven",
  "Axl-Project-Id-Aiven" : "aiven-project",
  "Axl-Auth-Token-Aiven" : "aiven-auth-token",
  "Axl-Service-Name-Aiven" : "aiven-service-name"
}'
HTTP request
POST /providers/discoverResources HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 177
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "Axl-Provider-Type" : "aiven",
  "Axl-Project-Id-Aiven" : "aiven-project",
  "Axl-Auth-Token-Aiven" : "aiven-auth-token",
  "Axl-Service-Name-Aiven" : "aiven-service-name"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 58

{
  "streams" : 1,
  "applications" : 1,
  "schemas" : 2
}

15. Import Provider Information from wizard into Self-Service

The endpoint /wizard/topics is used to view, and import Kafka topics, ACLs and schemas from a kafka provider into Self-Service.

Any authenticated user with role TENANT_ADMIN is allowed to perform these actions on its own tenant.

15.1. Get External Cluster’s Topic Details

15.2. Aiven

A POST request to wizard/topics/info will retrieve all the Topic Details available for an External Aiven Kafka Cluster.

15.2.1. Request fields

Path Type Description Constraints

providerConfigs.Axl-Provider-Type

String

The Axual Provider Type

providerConfigs.Axl-Project-Id-Aiven

String

The Aiven Project the token is valid for

providerConfigs.Axl-Auth-Token-Aiven

String

The authorization token for Aiven API

providerConfigs.Axl-Service-Name-Aiven

String

The Kafka Service Name used to discover resources

15.2.2. Curl request

$ curl 'http://api.example.com/wizard/topics/info' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "providerConfigs" : {
    "Axl-Provider-Type" : "aiven",
    "Axl-Project-Id-Aiven" : "aiven-project",
    "Axl-Auth-Token-Aiven" : "aiven-auth-token",
    "Axl-Service-Name-Aiven" : "aiven-service-name"
  }
}'

15.2.3. HTTP request

POST /wizard/topics/info HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 213
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "providerConfigs" : {
    "Axl-Provider-Type" : "aiven",
    "Axl-Project-Id-Aiven" : "aiven-project",
    "Axl-Auth-Token-Aiven" : "aiven-auth-token",
    "Axl-Service-Name-Aiven" : "aiven-service-name"
  }
}

15.2.4. HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 23745

[ {
  "topicName" : "a-topic-name",
  "retentionTimeMs" : null,
  "configs" : {
    "cleanup.policy" : "delete"
  },
  "acls" : [ {
    "principal" : "CN=Example Topic Processor,O=Axual B.V.,L=Utrecht,C=NL",
    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
    "privateKey" : "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDBXcezkUjIzQrI\nZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9KhpJdWXUFhijSFzLDHHl3\nGwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk5OGIRyvNOj8EXazh+z6Y\n2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvTWDl3H2NpfZUcHhZ6+6U0\nX1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG6gJcw9Ns8z8GoDdQ+NYN\nP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQar8kSu5PpHFMXLYH8U/Ty\nYs9UjLXTAgMBAAECggEBAJMfj3qI6CAgIjwngrff+N5+E8EbfD9CMkDkNoKipVWB\njFJfE4uO2+i9AjZp/aMZFXiGgziWfgEGAUUmPho1HsmLDFOAanF86FIKzrPY0DPh\nUOqfj1scg0q1eexqWU8fF6ymzJu9ynSGfTJAANLHh7UbgzYsT61U5IiT7136uJOa\nUGK6bK79ZYZaDamNr/+QqtpgEsCxI8db6rfvvyXWXuSdMW090NMhduZc0WDgxxnS\nz3N3ywkSeGZpkzn1wVjkFRK70a9z9eGZN9s50B1pt6geNS8yaY3ieJ5nbCQGHy9t\nYgTDLgvTxdzzYsH7HDxiS2Regd6/frjfXKe3P8D2HwECgYEA3eEPniANpRES+32v\nX3mwGsolkaRwRmLvTEcfDmKeMZEAGsq0fp1ZYvcJxyJ/yD/6GE6HnvD/owpMM04k\nBW8o/F9juiSFK6QOiPKcphrhafbwdCAU7o+u+IuSivMQmtYJrYsN21TtkuhRrUgF\nEBoHRg6m9qfEY9Et0Yj8mRp2H3ECgYEA3xo59w6gcYoX/x6wPIj+M2nvgDLIHewa\nYhtnL9LFHDerTdf2cS6sfPB0zxv/SXR5V9pdRL4nr2nQzI/xbMX73KUR0SL4UAgE\nVUurLsttYZA/KhBS1sH814hQHNHCoPgNOAntdplkhS2Lydw/XsfWJfrFqlI+IPWk\nclCx82bzD4MCgYEAmTMj+HeDVF0ksTdIFvFL0kOPiy9yQndfaViWLfWT6v+Ghfk+\nhUoaBQYz3yaH+nmKMqxOYkVfDXE3yhkDMClfsFog3s8GkGp3isGRvfNDf0n9HwFj\n0pCtLHoalgxcg7yT9BrWV4Idg9kbRD09GbAPI6VMTXTrWkx9iXc/imtF8lECgYEA\ns5pyZZCR2zV3gfsbl3AVbCBxHTxEW8pRpv82f4pnAgNS1bTxAUa4t1AASSbZyjGI\n6g+xnACVBCLkY3nRumZcDtGYWUuUqSD7FAt5gI9lu/Aa2WsQtTCvsndbPwgibeGj\nCqT7VMnB4XC8I0I6hbvMiwCpliblOzVlMF4EE9WiAK8CgYAfbdwcDUA0bC5NbwD1\n9+6KF01Ib7M9DL+Hrfe+ZUGd0V4FRckHCGnnDFU4vMR+LqBWjIuVSUQhmayH5KGT\nqHXkVQ61+HLTV3mEdSwRd66VzVhaEAj2TZjgGohvL9J8ubjV31WDlZUAs1SktwMp\nLe5QuxBs1CmFW6mlX6AvOfypJQ==\n-----END PRIVATE KEY-----\n",
    "username" : "TestUser",
    "password" : "P@ssw0rd",
    "accessType" : "WRITE",
    "applicationId" : null,
    "keyPairs" : { }
  }, {
    "principal" : "CN=Example Topic Processor,O=Axual B.V.,L=Utrecht,C=NL",
    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
    "privateKey" : "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDBXcezkUjIzQrI\nZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9KhpJdWXUFhijSFzLDHHl3\nGwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk5OGIRyvNOj8EXazh+z6Y\n2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvTWDl3H2NpfZUcHhZ6+6U0\nX1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG6gJcw9Ns8z8GoDdQ+NYN\nP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQar8kSu5PpHFMXLYH8U/Ty\nYs9UjLXTAgMBAAECggEBAJMfj3qI6CAgIjwngrff+N5+E8EbfD9CMkDkNoKipVWB\njFJfE4uO2+i9AjZp/aMZFXiGgziWfgEGAUUmPho1HsmLDFOAanF86FIKzrPY0DPh\nUOqfj1scg0q1eexqWU8fF6ymzJu9ynSGfTJAANLHh7UbgzYsT61U5IiT7136uJOa\nUGK6bK79ZYZaDamNr/+QqtpgEsCxI8db6rfvvyXWXuSdMW090NMhduZc0WDgxxnS\nz3N3ywkSeGZpkzn1wVjkFRK70a9z9eGZN9s50B1pt6geNS8yaY3ieJ5nbCQGHy9t\nYgTDLgvTxdzzYsH7HDxiS2Regd6/frjfXKe3P8D2HwECgYEA3eEPniANpRES+32v\nX3mwGsolkaRwRmLvTEcfDmKeMZEAGsq0fp1ZYvcJxyJ/yD/6GE6HnvD/owpMM04k\nBW8o/F9juiSFK6QOiPKcphrhafbwdCAU7o+u+IuSivMQmtYJrYsN21TtkuhRrUgF\nEBoHRg6m9qfEY9Et0Yj8mRp2H3ECgYEA3xo59w6gcYoX/x6wPIj+M2nvgDLIHewa\nYhtnL9LFHDerTdf2cS6sfPB0zxv/SXR5V9pdRL4nr2nQzI/xbMX73KUR0SL4UAgE\nVUurLsttYZA/KhBS1sH814hQHNHCoPgNOAntdplkhS2Lydw/XsfWJfrFqlI+IPWk\nclCx82bzD4MCgYEAmTMj+HeDVF0ksTdIFvFL0kOPiy9yQndfaViWLfWT6v+Ghfk+\nhUoaBQYz3yaH+nmKMqxOYkVfDXE3yhkDMClfsFog3s8GkGp3isGRvfNDf0n9HwFj\n0pCtLHoalgxcg7yT9BrWV4Idg9kbRD09GbAPI6VMTXTrWkx9iXc/imtF8lECgYEA\ns5pyZZCR2zV3gfsbl3AVbCBxHTxEW8pRpv82f4pnAgNS1bTxAUa4t1AASSbZyjGI\n6g+xnACVBCLkY3nRumZcDtGYWUuUqSD7FAt5gI9lu/Aa2WsQtTCvsndbPwgibeGj\nCqT7VMnB4XC8I0I6hbvMiwCpliblOzVlMF4EE9WiAK8CgYAfbdwcDUA0bC5NbwD1\n9+6KF01Ib7M9DL+Hrfe+ZUGd0V4FRckHCGnnDFU4vMR+LqBWjIuVSUQhmayH5KGT\nqHXkVQ61+HLTV3mEdSwRd66VzVhaEAj2TZjgGohvL9J8ubjV31WDlZUAs1SktwMp\nLe5QuxBs1CmFW6mlX6AvOfypJQ==\n-----END PRIVATE KEY-----\n",
    "username" : "TestUser",
    "password" : "P@ssw0rd",
    "accessType" : "READ",
    "applicationId" : "appID",
    "keyPairs" : { }
  }, {
    "principal" : "CN=Example Topic Processor,O=Axual B.V.,L=Utrecht,C=NL",
    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
    "privateKey" : "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDBXcezkUjIzQrI\nZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9KhpJdWXUFhijSFzLDHHl3\nGwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk5OGIRyvNOj8EXazh+z6Y\n2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvTWDl3H2NpfZUcHhZ6+6U0\nX1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG6gJcw9Ns8z8GoDdQ+NYN\nP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQar8kSu5PpHFMXLYH8U/Ty\nYs9UjLXTAgMBAAECggEBAJMfj3qI6CAgIjwngrff+N5+E8EbfD9CMkDkNoKipVWB\njFJfE4uO2+i9AjZp/aMZFXiGgziWfgEGAUUmPho1HsmLDFOAanF86FIKzrPY0DPh\nUOqfj1scg0q1eexqWU8fF6ymzJu9ynSGfTJAANLHh7UbgzYsT61U5IiT7136uJOa\nUGK6bK79ZYZaDamNr/+QqtpgEsCxI8db6rfvvyXWXuSdMW090NMhduZc0WDgxxnS\nz3N3ywkSeGZpkzn1wVjkFRK70a9z9eGZN9s50B1pt6geNS8yaY3ieJ5nbCQGHy9t\nYgTDLgvTxdzzYsH7HDxiS2Regd6/frjfXKe3P8D2HwECgYEA3eEPniANpRES+32v\nX3mwGsolkaRwRmLvTEcfDmKeMZEAGsq0fp1ZYvcJxyJ/yD/6GE6HnvD/owpMM04k\nBW8o/F9juiSFK6QOiPKcphrhafbwdCAU7o+u+IuSivMQmtYJrYsN21TtkuhRrUgF\nEBoHRg6m9qfEY9Et0Yj8mRp2H3ECgYEA3xo59w6gcYoX/x6wPIj+M2nvgDLIHewa\nYhtnL9LFHDerTdf2cS6sfPB0zxv/SXR5V9pdRL4nr2nQzI/xbMX73KUR0SL4UAgE\nVUurLsttYZA/KhBS1sH814hQHNHCoPgNOAntdplkhS2Lydw/XsfWJfrFqlI+IPWk\nclCx82bzD4MCgYEAmTMj+HeDVF0ksTdIFvFL0kOPiy9yQndfaViWLfWT6v+Ghfk+\nhUoaBQYz3yaH+nmKMqxOYkVfDXE3yhkDMClfsFog3s8GkGp3isGRvfNDf0n9HwFj\n0pCtLHoalgxcg7yT9BrWV4Idg9kbRD09GbAPI6VMTXTrWkx9iXc/imtF8lECgYEA\ns5pyZZCR2zV3gfsbl3AVbCBxHTxEW8pRpv82f4pnAgNS1bTxAUa4t1AASSbZyjGI\n6g+xnACVBCLkY3nRumZcDtGYWUuUqSD7FAt5gI9lu/Aa2WsQtTCvsndbPwgibeGj\nCqT7VMnB4XC8I0I6hbvMiwCpliblOzVlMF4EE9WiAK8CgYAfbdwcDUA0bC5NbwD1\n9+6KF01Ib7M9DL+Hrfe+ZUGd0V4FRckHCGnnDFU4vMR+LqBWjIuVSUQhmayH5KGT\nqHXkVQ61+HLTV3mEdSwRd66VzVhaEAj2TZjgGohvL9J8ubjV31WDlZUAs1SktwMp\nLe5QuxBs1CmFW6mlX6AvOfypJQ==\n-----END PRIVATE KEY-----\n",
    "username" : "Test.User-1",
    "password" : "P@ssw0rd",
    "accessType" : "WRITE",
    "applicationId" : null,
    "keyPairs" : { }
  } ],
  "partitionCount" : 3,
  "replication" : null,
  "keySchema" : "{\n  \"type\": \"record\",\n  \"name\": \"Application\",\n  \"namespace\": \"io.axual.client.example.schema\",\n  \"doc\": \"Identification of an application\",\n  \"fields\": [\n    {\n      \"name\": \"name\",\n      \"type\": \"string\",\n      \"doc\": \"The name of the application\"\n    },\n    {\n      \"name\": \"version\",\n      \"type\": [\n        \"null\",\n        \"string\"\n      ],\n      \"doc\": \"(Optional) The application version\",\n      \"default\": null\n    },\n    {\n      \"name\": \"owner\",\n      \"type\": [\n        \"null\",\n        \"string\"\n      ],\n      \"doc\": \"The owner of the application\",\n      \"default\": null\n    }\n  ]\n}",
  "valueSchema" : "{\n  \"type\": \"record\",\n  \"name\": \"Application\",\n  \"namespace\": \"io.axual.client.example.schema\",\n  \"doc\": \"Identification of an application\",\n  \"fields\": [\n    {\n      \"name\": \"name\",\n      \"type\": \"string\",\n      \"doc\": \"The name of the application\"\n    },\n    {\n      \"name\": \"version\",\n      \"type\": [\n        \"null\",\n        \"string\"\n      ],\n      \"doc\": \"(Optional) The application version\",\n      \"default\": null\n    },\n    {\n      \"name\": \"owner\",\n      \"type\": [\n        \"null\",\n        \"string\"\n      ],\n      \"doc\": \"The owner of the application\",\n      \"default\": null\n    },\n    {\n      \"name\": \"description\",\n      \"type\": \"string\",\n      \"doc\": \"The description of the application\"\n    }\n  ]\n}"
} ]

15.3. Confluent Cloud

A POST request to wizard/topics/info request will retrieve all the Topic Details available for an External Confluent Cloud Kafka Cluster.

Provide the clusterName of the cluster you are importing as part of your request body in order to store the Cluster Credentials in Vault.

15.3.1. Request fields

Path Type Description Constraints

clusterName

String

A valid ClusterName to create Cluster Credentials in the Vault

providerConfigs.Axl-Provider-Type

String

The Axual Provider Type

providerConfigs.Axl-Env-Id-Confluent

String

The Confluent Cloud Environment ID

providerConfigs.Axl-Api-Key-Confluent

String

The API Key for Confluent Cloud API

providerConfigs.Axl-Secret-Confluent

String

The Secret for Confluent Cloud API

providerConfigs.Axl-Cluster-Id-Confluent

String

The Confluent Cloud Cluster ID we want to import

providerConfigs.Axl-Cluster-Url-Confluent

String

The Confluent Cloud Cluster URL we want to import

providerConfigs.Axl-Sr-Id-Confluent

String

The Confluent Cloud Schema Registry ID we want to import

providerConfigs.Axl-Sr-Url-Confluent

String

The Confluent Cloud Schema Registry URL we want to import

15.3.2. Curl request

$ curl 'http://api.example.com/wizard/topics/info' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "clusterName" : "DTA Cluster",
  "providerConfigs" : {
    "Axl-Provider-Type" : "confluent-cloud",
    "Axl-Env-Id-Confluent" : "env-id",
    "Axl-Api-Key-Confluent" : "cloud-api-key",
    "Axl-Secret-Confluent" : "cloud-secret",
    "Axl-Cluster-Id-Confluent" : "cluster-id",
    "Axl-Cluster-Url-Confluent" : "cluster-url",
    "Axl-Sr-Id-Confluent" : "schema-registry-id",
    "Axl-Sr-Url-Confluent" : "schema-registry-url"
  }
}'

15.3.3. HTTP request

POST /wizard/topics/info HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 437
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "clusterName" : "DTA Cluster",
  "providerConfigs" : {
    "Axl-Provider-Type" : "confluent-cloud",
    "Axl-Env-Id-Confluent" : "env-id",
    "Axl-Api-Key-Confluent" : "cloud-api-key",
    "Axl-Secret-Confluent" : "cloud-secret",
    "Axl-Cluster-Id-Confluent" : "cluster-id",
    "Axl-Cluster-Url-Confluent" : "cluster-url",
    "Axl-Sr-Id-Confluent" : "schema-registry-id",
    "Axl-Sr-Url-Confluent" : "schema-registry-url"
  }
}

15.3.4. HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 23745

[ {
  "topicName" : "a-topic-name",
  "retentionTimeMs" : null,
  "configs" : {
    "cleanup.policy" : "delete"
  },
  "acls" : [ {
    "principal" : "CN=Example Topic Processor,O=Axual B.V.,L=Utrecht,C=NL",
    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
    "privateKey" : "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDBXcezkUjIzQrI\nZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9KhpJdWXUFhijSFzLDHHl3\nGwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk5OGIRyvNOj8EXazh+z6Y\n2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvTWDl3H2NpfZUcHhZ6+6U0\nX1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG6gJcw9Ns8z8GoDdQ+NYN\nP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQar8kSu5PpHFMXLYH8U/Ty\nYs9UjLXTAgMBAAECggEBAJMfj3qI6CAgIjwngrff+N5+E8EbfD9CMkDkNoKipVWB\njFJfE4uO2+i9AjZp/aMZFXiGgziWfgEGAUUmPho1HsmLDFOAanF86FIKzrPY0DPh\nUOqfj1scg0q1eexqWU8fF6ymzJu9ynSGfTJAANLHh7UbgzYsT61U5IiT7136uJOa\nUGK6bK79ZYZaDamNr/+QqtpgEsCxI8db6rfvvyXWXuSdMW090NMhduZc0WDgxxnS\nz3N3ywkSeGZpkzn1wVjkFRK70a9z9eGZN9s50B1pt6geNS8yaY3ieJ5nbCQGHy9t\nYgTDLgvTxdzzYsH7HDxiS2Regd6/frjfXKe3P8D2HwECgYEA3eEPniANpRES+32v\nX3mwGsolkaRwRmLvTEcfDmKeMZEAGsq0fp1ZYvcJxyJ/yD/6GE6HnvD/owpMM04k\nBW8o/F9juiSFK6QOiPKcphrhafbwdCAU7o+u+IuSivMQmtYJrYsN21TtkuhRrUgF\nEBoHRg6m9qfEY9Et0Yj8mRp2H3ECgYEA3xo59w6gcYoX/x6wPIj+M2nvgDLIHewa\nYhtnL9LFHDerTdf2cS6sfPB0zxv/SXR5V9pdRL4nr2nQzI/xbMX73KUR0SL4UAgE\nVUurLsttYZA/KhBS1sH814hQHNHCoPgNOAntdplkhS2Lydw/XsfWJfrFqlI+IPWk\nclCx82bzD4MCgYEAmTMj+HeDVF0ksTdIFvFL0kOPiy9yQndfaViWLfWT6v+Ghfk+\nhUoaBQYz3yaH+nmKMqxOYkVfDXE3yhkDMClfsFog3s8GkGp3isGRvfNDf0n9HwFj\n0pCtLHoalgxcg7yT9BrWV4Idg9kbRD09GbAPI6VMTXTrWkx9iXc/imtF8lECgYEA\ns5pyZZCR2zV3gfsbl3AVbCBxHTxEW8pRpv82f4pnAgNS1bTxAUa4t1AASSbZyjGI\n6g+xnACVBCLkY3nRumZcDtGYWUuUqSD7FAt5gI9lu/Aa2WsQtTCvsndbPwgibeGj\nCqT7VMnB4XC8I0I6hbvMiwCpliblOzVlMF4EE9WiAK8CgYAfbdwcDUA0bC5NbwD1\n9+6KF01Ib7M9DL+Hrfe+ZUGd0V4FRckHCGnnDFU4vMR+LqBWjIuVSUQhmayH5KGT\nqHXkVQ61+HLTV3mEdSwRd66VzVhaEAj2TZjgGohvL9J8ubjV31WDlZUAs1SktwMp\nLe5QuxBs1CmFW6mlX6AvOfypJQ==\n-----END PRIVATE KEY-----\n",
    "username" : "TestUser",
    "password" : "P@ssw0rd",
    "accessType" : "WRITE",
    "applicationId" : null,
    "keyPairs" : { }
  }, {
    "principal" : "CN=Example Topic Processor,O=Axual B.V.,L=Utrecht,C=NL",
    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
    "privateKey" : "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDBXcezkUjIzQrI\nZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9KhpJdWXUFhijSFzLDHHl3\nGwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk5OGIRyvNOj8EXazh+z6Y\n2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvTWDl3H2NpfZUcHhZ6+6U0\nX1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG6gJcw9Ns8z8GoDdQ+NYN\nP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQar8kSu5PpHFMXLYH8U/Ty\nYs9UjLXTAgMBAAECggEBAJMfj3qI6CAgIjwngrff+N5+E8EbfD9CMkDkNoKipVWB\njFJfE4uO2+i9AjZp/aMZFXiGgziWfgEGAUUmPho1HsmLDFOAanF86FIKzrPY0DPh\nUOqfj1scg0q1eexqWU8fF6ymzJu9ynSGfTJAANLHh7UbgzYsT61U5IiT7136uJOa\nUGK6bK79ZYZaDamNr/+QqtpgEsCxI8db6rfvvyXWXuSdMW090NMhduZc0WDgxxnS\nz3N3ywkSeGZpkzn1wVjkFRK70a9z9eGZN9s50B1pt6geNS8yaY3ieJ5nbCQGHy9t\nYgTDLgvTxdzzYsH7HDxiS2Regd6/frjfXKe3P8D2HwECgYEA3eEPniANpRES+32v\nX3mwGsolkaRwRmLvTEcfDmKeMZEAGsq0fp1ZYvcJxyJ/yD/6GE6HnvD/owpMM04k\nBW8o/F9juiSFK6QOiPKcphrhafbwdCAU7o+u+IuSivMQmtYJrYsN21TtkuhRrUgF\nEBoHRg6m9qfEY9Et0Yj8mRp2H3ECgYEA3xo59w6gcYoX/x6wPIj+M2nvgDLIHewa\nYhtnL9LFHDerTdf2cS6sfPB0zxv/SXR5V9pdRL4nr2nQzI/xbMX73KUR0SL4UAgE\nVUurLsttYZA/KhBS1sH814hQHNHCoPgNOAntdplkhS2Lydw/XsfWJfrFqlI+IPWk\nclCx82bzD4MCgYEAmTMj+HeDVF0ksTdIFvFL0kOPiy9yQndfaViWLfWT6v+Ghfk+\nhUoaBQYz3yaH+nmKMqxOYkVfDXE3yhkDMClfsFog3s8GkGp3isGRvfNDf0n9HwFj\n0pCtLHoalgxcg7yT9BrWV4Idg9kbRD09GbAPI6VMTXTrWkx9iXc/imtF8lECgYEA\ns5pyZZCR2zV3gfsbl3AVbCBxHTxEW8pRpv82f4pnAgNS1bTxAUa4t1AASSbZyjGI\n6g+xnACVBCLkY3nRumZcDtGYWUuUqSD7FAt5gI9lu/Aa2WsQtTCvsndbPwgibeGj\nCqT7VMnB4XC8I0I6hbvMiwCpliblOzVlMF4EE9WiAK8CgYAfbdwcDUA0bC5NbwD1\n9+6KF01Ib7M9DL+Hrfe+ZUGd0V4FRckHCGnnDFU4vMR+LqBWjIuVSUQhmayH5KGT\nqHXkVQ61+HLTV3mEdSwRd66VzVhaEAj2TZjgGohvL9J8ubjV31WDlZUAs1SktwMp\nLe5QuxBs1CmFW6mlX6AvOfypJQ==\n-----END PRIVATE KEY-----\n",
    "username" : "TestUser",
    "password" : "P@ssw0rd",
    "accessType" : "READ",
    "applicationId" : "appID",
    "keyPairs" : { }
  }, {
    "principal" : "CN=Example Topic Processor,O=Axual B.V.,L=Utrecht,C=NL",
    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
    "privateKey" : "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDBXcezkUjIzQrI\nZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9KhpJdWXUFhijSFzLDHHl3\nGwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk5OGIRyvNOj8EXazh+z6Y\n2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvTWDl3H2NpfZUcHhZ6+6U0\nX1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG6gJcw9Ns8z8GoDdQ+NYN\nP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQar8kSu5PpHFMXLYH8U/Ty\nYs9UjLXTAgMBAAECggEBAJMfj3qI6CAgIjwngrff+N5+E8EbfD9CMkDkNoKipVWB\njFJfE4uO2+i9AjZp/aMZFXiGgziWfgEGAUUmPho1HsmLDFOAanF86FIKzrPY0DPh\nUOqfj1scg0q1eexqWU8fF6ymzJu9ynSGfTJAANLHh7UbgzYsT61U5IiT7136uJOa\nUGK6bK79ZYZaDamNr/+QqtpgEsCxI8db6rfvvyXWXuSdMW090NMhduZc0WDgxxnS\nz3N3ywkSeGZpkzn1wVjkFRK70a9z9eGZN9s50B1pt6geNS8yaY3ieJ5nbCQGHy9t\nYgTDLgvTxdzzYsH7HDxiS2Regd6/frjfXKe3P8D2HwECgYEA3eEPniANpRES+32v\nX3mwGsolkaRwRmLvTEcfDmKeMZEAGsq0fp1ZYvcJxyJ/yD/6GE6HnvD/owpMM04k\nBW8o/F9juiSFK6QOiPKcphrhafbwdCAU7o+u+IuSivMQmtYJrYsN21TtkuhRrUgF\nEBoHRg6m9qfEY9Et0Yj8mRp2H3ECgYEA3xo59w6gcYoX/x6wPIj+M2nvgDLIHewa\nYhtnL9LFHDerTdf2cS6sfPB0zxv/SXR5V9pdRL4nr2nQzI/xbMX73KUR0SL4UAgE\nVUurLsttYZA/KhBS1sH814hQHNHCoPgNOAntdplkhS2Lydw/XsfWJfrFqlI+IPWk\nclCx82bzD4MCgYEAmTMj+HeDVF0ksTdIFvFL0kOPiy9yQndfaViWLfWT6v+Ghfk+\nhUoaBQYz3yaH+nmKMqxOYkVfDXE3yhkDMClfsFog3s8GkGp3isGRvfNDf0n9HwFj\n0pCtLHoalgxcg7yT9BrWV4Idg9kbRD09GbAPI6VMTXTrWkx9iXc/imtF8lECgYEA\ns5pyZZCR2zV3gfsbl3AVbCBxHTxEW8pRpv82f4pnAgNS1bTxAUa4t1AASSbZyjGI\n6g+xnACVBCLkY3nRumZcDtGYWUuUqSD7FAt5gI9lu/Aa2WsQtTCvsndbPwgibeGj\nCqT7VMnB4XC8I0I6hbvMiwCpliblOzVlMF4EE9WiAK8CgYAfbdwcDUA0bC5NbwD1\n9+6KF01Ib7M9DL+Hrfe+ZUGd0V4FRckHCGnnDFU4vMR+LqBWjIuVSUQhmayH5KGT\nqHXkVQ61+HLTV3mEdSwRd66VzVhaEAj2TZjgGohvL9J8ubjV31WDlZUAs1SktwMp\nLe5QuxBs1CmFW6mlX6AvOfypJQ==\n-----END PRIVATE KEY-----\n",
    "username" : "Test.User-1",
    "password" : "P@ssw0rd",
    "accessType" : "WRITE",
    "applicationId" : null,
    "keyPairs" : { }
  } ],
  "partitionCount" : 3,
  "replication" : null,
  "keySchema" : "{\n  \"type\": \"record\",\n  \"name\": \"Application\",\n  \"namespace\": \"io.axual.client.example.schema\",\n  \"doc\": \"Identification of an application\",\n  \"fields\": [\n    {\n      \"name\": \"name\",\n      \"type\": \"string\",\n      \"doc\": \"The name of the application\"\n    },\n    {\n      \"name\": \"version\",\n      \"type\": [\n        \"null\",\n        \"string\"\n      ],\n      \"doc\": \"(Optional) The application version\",\n      \"default\": null\n    },\n    {\n      \"name\": \"owner\",\n      \"type\": [\n        \"null\",\n        \"string\"\n      ],\n      \"doc\": \"The owner of the application\",\n      \"default\": null\n    }\n  ]\n}",
  "valueSchema" : "{\n  \"type\": \"record\",\n  \"name\": \"Application\",\n  \"namespace\": \"io.axual.client.example.schema\",\n  \"doc\": \"Identification of an application\",\n  \"fields\": [\n    {\n      \"name\": \"name\",\n      \"type\": \"string\",\n      \"doc\": \"The name of the application\"\n    },\n    {\n      \"name\": \"version\",\n      \"type\": [\n        \"null\",\n        \"string\"\n      ],\n      \"doc\": \"(Optional) The application version\",\n      \"default\": null\n    },\n    {\n      \"name\": \"owner\",\n      \"type\": [\n        \"null\",\n        \"string\"\n      ],\n      \"doc\": \"The owner of the application\",\n      \"default\": null\n    },\n    {\n      \"name\": \"description\",\n      \"type\": \"string\",\n      \"doc\": \"The description of the application\"\n    }\n  ]\n}"
} ]

15.4. Apache Kafka

A POST request to wizard/topics/info request will retrieve all the Topic Details available for an Apache Kafka Cluster.

Provide the clusterName of the cluster you are importing as part of your request body in order to store the Cluster Credentials in Vault.

15.4.1. Request fields

Path Type Description Constraints

clusterName

String

A valid ClusterName to create Cluster Credentials in the Vault

purpose

String

Purpose defining prod or non-prod. (p or np).

providerConfigs.Axl-Provider-Type

String

The Axual Provider Type

providerConfigs.Axl-Bootstrap-Server-ApacheKafka

String

The URL of the Kafka broker(s) to connect to Apache Kafka

providerConfigs.Axl-Broker-Protocol-Type-ApacheKafka

String

The Authentication Protocol Type of broker used to interact with an Apache Kafka (mTLS, SASL/PLAIN, SASL/SCRAM-SHA-256, SASL/SCRAM-SHA-512)

providerConfigs.Axl-Broker-Private-Key-ApacheKafka

String

The Base64 encrypted client private key that is used to interact with an Apache Kafka broker

providerConfigs.Axl-Broker-Cert-ApacheKafka

String

The Base64 encrypted client certificate chain that is used to interact with an Apache Kafka broker

providerConfigs.Axl-Broker-CA-Validation-ApacheKafka

String

The Flag to define CA validation when interacting with an Apache Kafka.

providerConfigs.Axl-Broker-Truststore-ApacheKafka

String

The (optional) Broker truststore Cert of the Admin User to connect to a Kafka broker

15.4.2. Curl request

$ curl 'http://api.example.com/wizard/topics' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
    "Axl-Broker-Cert-ApacheKafka" : "cert",
    "Axl-Broker-CA-Validation-ApacheKafka" : "true",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate"
  }
}'

15.4.3. HTTP request

POST /wizard/topics HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 455
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
    "Axl-Broker-Cert-ApacheKafka" : "cert",
    "Axl-Broker-CA-Validation-ApacheKafka" : "true",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate"
  }
}

15.4.4. HTTP response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 112

{
  "importedStreamCount" : 1,
  "importedACLCount" : 0,
  "importedSchemaCount" : 0,
  "groupName" : "Admins"
}

15.4.5. Provide Schema Registry with No Authentication

Request fields
Path Type Description Constraints

clusterName

String

A valid ClusterName to create Cluster Credentials in the Vault

purpose

String

Purpose defining prod or non-prod. (p or np).

providerConfigs.Axl-Provider-Type

String

The Axual Provider Type

providerConfigs.Axl-Bootstrap-Server-ApacheKafka

String

The URL of the Kafka broker(s) to connect to Apache Kafka

providerConfigs.Axl-Broker-Protocol-Type-ApacheKafka

String

The Authentication Protocol Type of broker used to interact with an Apache Kafka (mTLS, SASL/PLAIN, SASL/SCRAM-SHA-256, SASL/SCRAM-SHA-512)

providerConfigs.Axl-Broker-Private-Key-ApacheKafka

String

The Base64 encrypted client private key that is used to interact with an Apache Kafka broker

providerConfigs.Axl-Broker-Cert-ApacheKafka

String

The Base64 encrypted client certificate chain that is used to interact with an Apache Kafka broker

providerConfigs.Axl-Broker-CA-Validation-ApacheKafka

String

The Flag to define CA validation when interacting with an Apache Kafka.

providerConfigs.Axl-Broker-Truststore-ApacheKafka

String

The (optional) Broker truststore Cert of the Admin User to connect to a Kafka broker

providerConfigs.Axl-Sr-Protocol-Type-ApacheKafka

String

NoAuth Authentication Protocol Type to connect to a Schema Registry

providerConfigs.Axl-Sr-Url-ApacheKafka

String

The URL of the Schema Registry to interact with an Apache Kafka
Curl request
$ curl 'http://api.example.com/wizard/topics' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
    "Axl-Broker-Cert-ApacheKafka" : "cert",
    "Axl-Broker-CA-Validation-ApacheKafka" : "true",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
    "Axl-Sr-Protocol-Type-ApacheKafka" : "No-Auth",
    "Axl-Sr-Url-ApacheKafka" : "url"
  }
}'
HTTP request
POST /wizard/topics HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 545
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
    "Axl-Broker-Cert-ApacheKafka" : "cert",
    "Axl-Broker-CA-Validation-ApacheKafka" : "true",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
    "Axl-Sr-Protocol-Type-ApacheKafka" : "No-Auth",
    "Axl-Sr-Url-ApacheKafka" : "url"
  }
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 112

{
  "importedStreamCount" : 1,
  "importedACLCount" : 0,
  "importedSchemaCount" : 0,
  "groupName" : "Admins"
}

15.4.6. Provide Schema Registry with mTls Authentication

Request fields
Path Type Description Constraints

clusterName

String

A valid ClusterName to create Cluster Credentials in the Vault

purpose

String

Purpose defining prod or non-prod. (p or np).

providerConfigs.Axl-Provider-Type

String

The Axual Provider Type

providerConfigs.Axl-Bootstrap-Server-ApacheKafka

String

The URL of the Kafka broker(s) to connect to Apache Kafka

providerConfigs.Axl-Broker-Protocol-Type-ApacheKafka

String

The Authentication Protocol Type of broker used to interact with an Apache Kafka (mTLS, SASL/PLAIN, SASL/SCRAM-SHA-256, SASL/SCRAM-SHA-512)

providerConfigs.Axl-Broker-Private-Key-ApacheKafka

String

The Base64 encrypted client private key that is used to interact with an Apache Kafka broker

providerConfigs.Axl-Broker-Cert-ApacheKafka

String

The Base64 encrypted client certificate chain that is used to interact with an Apache Kafka broker

providerConfigs.Axl-Broker-CA-Validation-ApacheKafka

String

The Flag to define CA validation when interacting with an Apache Kafka.

providerConfigs.Axl-Broker-Truststore-ApacheKafka

String

The (optional) Broker truststore Cert of the Admin User to connect to a Kafka broker

providerConfigs.Axl-Sr-Protocol-Type-ApacheKafka

String

mTLS Authentication Protocol Type to connect to a Schema Registry

providerConfigs.Axl-Sr-Url-ApacheKafka

String

The URL of the Schema Registry to interact with an Apache Kafka

providerConfigs.Axl-Sr-Cert-ApacheKafka

String

The Schema Registry Cert of the Admin User to connect to a Schema Registry

providerConfigs.Axl-Sr-Private-Key-ApacheKafka

String

The private key of the Admin User to connect to a Schema Registry

providerConfigs.Axl-Sr-Truststore-ApacheKafka

String

The (optional) Schema Registry truststore Cert of the Admin User to connect to a Schema Registry
Curl request
$ curl 'http://api.example.com/wizard/topics' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
    "Axl-Broker-Cert-ApacheKafka" : "cert",
    "Axl-Broker-CA-Validation-ApacheKafka" : "true",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
    "Axl-Sr-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Sr-Url-ApacheKafka" : "sr-url",
    "Axl-Sr-Cert-ApacheKafka" : "sr-cert",
    "Axl-Sr-Private-Key-ApacheKafka" : "sr-private-key",
    "Axl-Sr-Truststore-ApacheKafka" : "sr-ca-certificate"
  }
}'
HTTP request
POST /wizard/topics HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 704
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
    "Axl-Broker-Cert-ApacheKafka" : "cert",
    "Axl-Broker-CA-Validation-ApacheKafka" : "true",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
    "Axl-Sr-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Sr-Url-ApacheKafka" : "sr-url",
    "Axl-Sr-Cert-ApacheKafka" : "sr-cert",
    "Axl-Sr-Private-Key-ApacheKafka" : "sr-private-key",
    "Axl-Sr-Truststore-ApacheKafka" : "sr-ca-certificate"
  }
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 112

{
  "importedStreamCount" : 1,
  "importedACLCount" : 0,
  "importedSchemaCount" : 0,
  "groupName" : "Admins"
}

15.4.7. Provide Schema Registry with Basic Authentication

Request fields
Path Type Description Constraints

clusterName

String

A valid ClusterName to create Cluster Credentials in the Vault

purpose

String

Purpose defining prod or non-prod. (p or np).

providerConfigs.Axl-Provider-Type

String

The Axual Provider Type

providerConfigs.Axl-Bootstrap-Server-ApacheKafka

String

The URL of the Kafka broker(s) to connect to Apache Kafka

providerConfigs.Axl-Broker-Protocol-Type-ApacheKafka

String

The Authentication Protocol Type of broker used to interact with an Apache Kafka (mTLS, SASL/PLAIN, SASL/SCRAM-SHA-256, SASL/SCRAM-SHA-512)

providerConfigs.Axl-Broker-CA-Validation-ApacheKafka

String

The Flag to define CA validation when interacting with an Apache Kafka

providerConfigs.Axl-Broker-Truststore-ApacheKafka

String

The (optional) Broker truststore Cert of the Admin User to connect to a Kafka broker

providerConfigs.Axl-Broker-Cert-ApacheKafka

String

The Base64 encrypted client certificate chain that is used to interact with an Apache Kafka broker

providerConfigs.Axl-Broker-Private-Key-ApacheKafka

String

The Base64 encrypted client private key that is used to interact with an Apache Kafka broker

providerConfigs.Axl-Sr-Protocol-Type-ApacheKafka

String

BasicAuth Authentication Protocol Type to connect to a Schema Registry

providerConfigs.Axl-Sr-Url-ApacheKafka

String

The URL of the Schema Registry to interact with an Apache Kafka

providerConfigs.Axl-Sr-Type-ApacheKafka

String

The Type of the Schema Registry to interact with an Apache Kafka (apicurio, confluent)

providerConfigs.Axl-Sr-Username-ApacheKafka

String

The Username used to connect to a Schema Registry with Basic authentication

providerConfigs.Axl-Sr-Password-ApacheKafka

String

The Password used to connect to a Schema Registry with Basic authentication
Curl request
$ curl 'http://api.example.com/wizard/topics' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
    "Axl-Broker-Cert-ApacheKafka" : "cert",
    "Axl-Broker-CA-Validation-ApacheKafka" : "true",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
    "Axl-Sr-Protocol-Type-ApacheKafka" : "Basic-Auth",
    "Axl-Sr-Url-ApacheKafka" : "sr-url",
    "Axl-Sr-Type-ApacheKafka" : "apicurio",
    "Axl-Sr-Username-ApacheKafka" : "sr-username",
    "Axl-Sr-Password-ApacheKafka" : "sr-password"
  }
}'
HTTP request
POST /wizard/topics HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 697
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Broker-Private-Key-ApacheKafka" : "private-key",
    "Axl-Broker-Cert-ApacheKafka" : "cert",
    "Axl-Broker-CA-Validation-ApacheKafka" : "true",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate",
    "Axl-Sr-Protocol-Type-ApacheKafka" : "Basic-Auth",
    "Axl-Sr-Url-ApacheKafka" : "sr-url",
    "Axl-Sr-Type-ApacheKafka" : "apicurio",
    "Axl-Sr-Username-ApacheKafka" : "sr-username",
    "Axl-Sr-Password-ApacheKafka" : "sr-password"
  }
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 112

{
  "importedStreamCount" : 1,
  "importedACLCount" : 0,
  "importedSchemaCount" : 0,
  "groupName" : "Admins"
}

15.5. Import External Cluster’s Topics into Self Service

15.5.1. Aiven

A POST request to wizard/topics will create base entities, and import all Kafka topics, ACLs, and schemas into the Self-Service.

Provide the clusterName and the purpose of the cluster you are importing as part of your request body.

Request fields
Path Type Description Constraints

clusterName

String

Name of the cluster to be created

purpose

String

Purpose defining prod or non-prod. (p or np).

providerConfigs.Axl-Provider-Type

String

The Axual Provider Type

providerConfigs.Axl-Project-Id-Aiven

String

The Aiven Project the token is valid for

providerConfigs.Axl-Auth-Token-Aiven

String

The authorization token for Aiven API

providerConfigs.Axl-Service-Name-Aiven

String

The Kafka Service Name used to discover resources
Curl request
$ curl 'http://api.example.com/wizard/topics' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "aiven",
    "Axl-Project-Id-Aiven" : "aiven-project",
    "Axl-Auth-Token-Aiven" : "aiven-auth-token",
    "Axl-Service-Name-Aiven" : "aiven-service-name"
  }
}'
HTTP request
POST /wizard/topics HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 266
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "aiven",
    "Axl-Project-Id-Aiven" : "aiven-project",
    "Axl-Auth-Token-Aiven" : "aiven-auth-token",
    "Axl-Service-Name-Aiven" : "aiven-service-name"
  }
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 112

{
  "importedStreamCount" : 1,
  "importedACLCount" : 2,
  "importedSchemaCount" : 2,
  "groupName" : "Admins"
}

15.5.2. Confluent Cloud

A POST request to wizard/topics will create base entities, and import all Kafka topics, ACLs, and schemas into the Self-Service.

Provide the clusterName and the purpose of the cluster you are importing as part of your request body.

Request fields
Path Type Description Constraints

clusterName

String

A valid ClusterName to create Cluster Credentials in the Vault

purpose

String

Purpose defining prod or non-prod. (p or np).

providerConfigs.Axl-Provider-Type

String

The Axual Provider Type

providerConfigs.Axl-Env-Id-Confluent

String

The Confluent Cloud Environment ID

providerConfigs.Axl-Api-Key-Confluent

String

The API Key for Confluent Cloud API

providerConfigs.Axl-Secret-Confluent

String

The Secret for Confluent Cloud API

providerConfigs.Axl-Cluster-Id-Confluent

String

The Confluent Cloud Cluster ID we want to import

providerConfigs.Axl-Cluster-Url-Confluent

String

The Confluent Cloud Cluster URL we want to import

providerConfigs.Axl-Sr-Id-Confluent

String

The Confluent Cloud Schema Registry ID we want to import

providerConfigs.Axl-Sr-Url-Confluent

String

The Confluent Cloud Schema Registry URL we want to import
Curl request
$ curl 'http://api.example.com/wizard/topics' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "confluent-cloud",
    "Axl-Env-Id-Confluent" : "env-id",
    "Axl-Api-Key-Confluent" : "cloud-api-key",
    "Axl-Secret-Confluent" : "cloud-secret",
    "Axl-Cluster-Id-Confluent" : "cluster-id",
    "Axl-Cluster-Url-Confluent" : "cluster-url",
    "Axl-Sr-Id-Confluent" : "schema-registry-id",
    "Axl-Sr-Url-Confluent" : "schema-registry-url"
  }
}'
HTTP request
POST /wizard/topics HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 457
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "clusterName" : "DTA Cluster",
  "purpose" : "np",
  "providerConfigs" : {
    "Axl-Provider-Type" : "confluent-cloud",
    "Axl-Env-Id-Confluent" : "env-id",
    "Axl-Api-Key-Confluent" : "cloud-api-key",
    "Axl-Secret-Confluent" : "cloud-secret",
    "Axl-Cluster-Id-Confluent" : "cluster-id",
    "Axl-Cluster-Url-Confluent" : "cluster-url",
    "Axl-Sr-Id-Confluent" : "schema-registry-id",
    "Axl-Sr-Url-Confluent" : "schema-registry-url"
  }
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 112

{
  "importedStreamCount" : 1,
  "importedACLCount" : 1,
  "importedSchemaCount" : 2,
  "groupName" : "Admins"
}

16. Offboard a cluster

The endpoint /offboard is used to delete all the information related to an onboarded cluster including deleting the user from Stripe.

Any authenticated user with role TENANT_ADMIN is allowed to perform this action on its own tenant.

A DELETE request will perform offboarding action for the tenant.

16.1. Curl request

$ curl 'http://api.example.com/offboard' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'

16.2. HTTP request

DELETE /offboard HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

16.3. HTTP response

HTTP/1.1 200 OK

17. Clusters

A Cluster represents a set of servers working together to form a Kafka cluster. They are usually grouped by location/data center. An AEB Instance will be powered by one or more Clusters.

The clusters resources is used to create and list Clusters.

17.1. Cluster Schema

The clusters resource uses the following json-schema:

17.1.1. HTTP request

GET /profile/clusters HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com

17.1.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 2516

{
  "title" : "Cluster",
  "definitions" : {
    "bootstrapServer" : {
      "type" : "object",
      "properties" : {
        "bootstrapServer" : {
          "title" : "Bootstrap server",
          "readOnly" : true,
          "type" : "string"
        }
      }
    }
  },
  "properties" : {
    "topicPattern" : {
      "title" : "Topic pattern",
      "readOnly" : false,
      "type" : "string"
    },
    "kafkaListeners" : {
      "title" : "Kafka listeners",
      "readOnly" : true,
      "type" : "object"
    },
    "multiEnvironment" : {
      "title" : "Multi environment",
      "readOnly" : true,
      "type" : "boolean"
    },
    "settings" : {
      "title" : "Settings",
      "readOnly" : false,
      "type" : "object"
    },
    "multiTenant" : {
      "title" : "Multi tenant",
      "readOnly" : true,
      "type" : "boolean"
    },
    "description" : {
      "title" : "Description",
      "readOnly" : false,
      "type" : "string"
    },
    "providerType" : {
      "title" : "Provider type",
      "readOnly" : false,
      "type" : "string"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "groupPattern" : {
      "title" : "Group pattern",
      "readOnly" : false,
      "type" : "string"
    },
    "bootstrapServers" : {
      "title" : "Bootstrap servers",
      "readOnly" : false,
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "$ref" : "#/definitions/bootstrapServer"
      }
    },
    "kafkaVersion" : {
      "title" : "Kafka version",
      "readOnly" : false,
      "type" : "string"
    },
    "bootstrapUrls" : {
      "title" : "Bootstrap urls",
      "readOnly" : true,
      "type" : "string"
    },
    "name" : {
      "title" : "Name",
      "readOnly" : false,
      "type" : "string"
    },
    "location" : {
      "title" : "Location",
      "readOnly" : false,
      "type" : "string"
    },
    "billingCloudEnabled" : {
      "title" : "Billing cloud enabled",
      "readOnly" : false,
      "type" : "boolean"
    },
    "transactionalPattern" : {
      "title" : "Transactional pattern",
      "readOnly" : false,
      "type" : "string"
    },
    "tenant" : {
      "title" : "Tenant",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "kafkaCluster" : {
      "title" : "Kafka cluster",
      "readOnly" : true,
      "type" : "boolean"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

17.2. List all clusters

A GET request will list all the service’s Clusters.

All clusters returned by this endpoint are public clusters and the clusters owned by the tenant.

17.2.1. Curl request

$ curl 'http://api.example.com/clusters' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

17.2.2. HTTP request

GET /clusters HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

17.2.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 9506

{
  "_embedded" : {
    "clusters" : [ {
      "name" : "Zone2ClusterOTA",
      "description" : "",
      "location" : "Zone2",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.4.0",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "",
      "uid" : "543c3b7d55634eba83b1472775c131c4",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "cluster" : {
          "href" : "...",
          "title" : "A cluster"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      }
    }, {
      "name" : "Zone1ClusterOTA",
      "description" : "",
      "location" : "Zone1",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ {
        "bootstrapServer" : "bootstrapserver1:9093"
      } ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : {
        "MUTUAL_TLS" : "broker:9090"
      },
      "kafkaVersion" : "3.5.1",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "bootstrapserver1:9093",
      "uid" : "66c12e25ab06458eac988f0d700fbe81",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "cluster" : {
          "href" : "...",
          "title" : "A cluster"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      }
    }, {
      "name" : "ExternalCluster",
      "description" : "First External Cluster for Tenant A",
      "location" : "AMS",
      "billingCloudEnabled" : false,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "confluent-cloud",
      "topicPattern" : null,
      "groupPattern" : null,
      "transactionalPattern" : null,
      "kafkaListeners" : { },
      "kafkaVersion" : null,
      "multiTenant" : false,
      "kafkaCluster" : false,
      "multiEnvironment" : false,
      "bootstrapUrls" : "",
      "uid" : "66c12e42ab06458eac420f0d700fbe81",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "cluster" : {
          "href" : "...",
          "title" : "A cluster"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      }
    }, {
      "name" : "Zone1ClusterPROD",
      "description" : "",
      "location" : "Zone1",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : null,
      "groupPattern" : null,
      "transactionalPattern" : null,
      "kafkaListeners" : { },
      "kafkaVersion" : null,
      "multiTenant" : false,
      "kafkaCluster" : true,
      "multiEnvironment" : false,
      "bootstrapUrls" : "",
      "uid" : "db0766d053ca46d59b0a1af2817c535a",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "cluster" : {
          "href" : "...",
          "title" : "A cluster"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      }
    }, {
      "name" : "multiClusterKsmlCluster00",
      "description" : "",
      "location" : "eu-ams",
      "billingCloudEnabled" : false,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.6.0",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "",
      "uid" : "multi-cluster-ksml-cluster000000",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "cluster" : {
          "href" : "...",
          "title" : "A cluster"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      }
    }, {
      "name" : "multiClusterKsmlCluster01",
      "description" : "",
      "location" : "eu-dub",
      "billingCloudEnabled" : false,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.6.0",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "",
      "uid" : "multi-cluster-ksml-cluster000001",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "cluster" : {
          "href" : "...",
          "title" : "A cluster"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      }
    }, {
      "name" : "singleClusterKsmlCluster",
      "description" : "",
      "location" : "eu-ams",
      "billingCloudEnabled" : false,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.6.0",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "",
      "uid" : "single-cluster-ksml-cluster00000",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "cluster" : {
          "href" : "...",
          "title" : "A cluster"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    },
    "show" : {
      "href" : "...",
      "title" : "Indication that an entity can be shown in menu"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 7,
    "totalPages" : 1,
    "number" : 0
  }
}

17.3. Create a cluster

A POST request is used to create a Cluster.

17.3.1. Request fields

Path Type Description Constraints

name

String

The name of the cluster. Must be unique.

Must match the regular expression (?i)^[a-z0-9\.\-_]+$. Must not be empty. Size must be between 3 and 50 inclusive

description

String

A short text summarizing the purpose of the cluster.

Size must be between 0 and 200 inclusive

location

String

The data center or geographic name where this cluster is located.

Size must be between 0 and 50 inclusive

bootstrapServers

Array

Bootstrap servers URL’s of the cluster.

settings

Object

A map containing custom settings for the cluster.

17.3.2. Curl request

$ curl 'http://api.example.com/clusters' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "TestClusterACC",
  "description" : "Test cluster for ACC in Best DC",
  "location" : "Best",
  "bootstrapServers" : [ {
    "bootstrapServer" : "bootstrapserver1:9092"
  }, {
    "bootstrapServer" : "bootstrapserver2:9092"
  } ],
  "settings" : {
    "sslAuthMode" : "certificate"
  }
}'

17.3.3. HTTP request

POST /clusters HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 300
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "TestClusterACC",
  "description" : "Test cluster for ACC in Best DC",
  "location" : "Best",
  "bootstrapServers" : [ {
    "bootstrapServer" : "bootstrapserver1:9092"
  }, {
    "bootstrapServer" : "bootstrapserver2:9092"
  } ],
  "settings" : {
    "sslAuthMode" : "certificate"
  }
}

17.3.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
location: http://api.example.com/clusters/7a863f5a1d3e488ea22f517449601ae2
Content-Type: application/hal+json
Content-Length: 959

{
  "uid" : "7a863f5a1d3e488ea22f517449601ae2",
  "name" : "TestClusterACC",
  "description" : "Test cluster for ACC in Best DC",
  "location" : "Best",
  "billingCloudEnabled" : false,
  "bootstrapServers" : [ ],
  "providerType" : null,
  "authenticationInfo" : null,
  "topicPattern" : null,
  "groupPattern" : null,
  "transactionalPattern" : null,
  "sharedCluster" : false,
  "kafkaVersion" : null,
  "kafkaListeners" : { },
  "settings" : {
    "sslAuthMode" : "certificate"
  },
  "_links" : {
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "cluster" : {
      "href" : "...",
      "title" : "A cluster"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    }
  }
}

17.4. Create a cluster with provider info

A POST request is used to create a Cluster with provider info.

17.4.1. Request fields

Path Type Description Constraints

name

String

The name of the cluster. Must be unique.

Must match the regular expression (?i)^[a-z0-9\.\-_]+$. Must not be empty. Size must be between 3 and 50 inclusive

description

String

A short text summarizing the purpose of the cluster.

Size must be between 0 and 200 inclusive

location

String

The data center or geographic name where this cluster is located.

Size must be between 0 and 50 inclusive

bootstrapServers

Array

Bootstrap servers URL’s of the cluster.

providerType

String

The name of the provider type

providerInfo

Object

A map containing provider specific configuration

kafkaVersion

String

The Apache Kafka version

kafkaListeners

Object

A map containing the kafka listener configuration in Key,Value format

tenant

String

Tenant that is mapped to a cluster

topicPattern

String

Topic Pattern configured to a cluster

groupPattern

String

Group Pattern configured to a cluster

transactionPattern

Array

Transactional Pattern configured to a cluster

settings

Object

A map containing custom settings for the cluster.

17.4.2. Curl request

$ curl 'http://api.example.com/clusters' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "TestClusterACC",
  "description" : "Test cluster for ACC in Best DC",
  "location" : "Best",
  "bootstrapServers" : [ {
    "bootstrapServer" : "bootstrapserver1:9092"
  }, {
    "bootstrapServer" : "bootstrapserver2:9092"
  } ],
  "providerInfo" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "SSL",
    "Axl-Broker-Cert-ApacheKafka" : "base64-encoded-pem-certificate",
    "Axl-Broker-Private-Key-ApacheKafka" : "base64-encoded-private-key",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate"
  },
  "sharedCluster" : false,
  "topicPattern" : "{topic}",
  "groupPattern" : "{group}",
  "transactionalPattern" : "{transactional.id}",
  "kafkaVersion" : "3.4.0",
  "kafkaListeners" : {
    "MUTUAL_TLS" : "broker:9095",
    "SCRAM_SHA_512" : "broker:9096"
  },
  "settings" : {
    "sslAuthMode" : "certificate"
  }
}'

17.4.3. HTTP request

POST /clusters HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 884
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "TestClusterACC",
  "description" : "Test cluster for ACC in Best DC",
  "location" : "Best",
  "bootstrapServers" : [ {
    "bootstrapServer" : "bootstrapserver1:9092"
  }, {
    "bootstrapServer" : "bootstrapserver2:9092"
  } ],
  "providerInfo" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "SSL",
    "Axl-Broker-Cert-ApacheKafka" : "base64-encoded-pem-certificate",
    "Axl-Broker-Private-Key-ApacheKafka" : "base64-encoded-private-key",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate"
  },
  "sharedCluster" : false,
  "topicPattern" : "{topic}",
  "groupPattern" : "{group}",
  "transactionalPattern" : "{transactional.id}",
  "kafkaVersion" : "3.4.0",
  "kafkaListeners" : {
    "MUTUAL_TLS" : "broker:9095",
    "SCRAM_SHA_512" : "broker:9096"
  },
  "settings" : {
    "sslAuthMode" : "certificate"
  }
}

17.4.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
location: http://api.example.com/clusters/6bdfc0f3a0724ee6aebe5d3c688c10b2
Content-Type: application/hal+json
Content-Length: 1070

{
  "uid" : "6bdfc0f3a0724ee6aebe5d3c688c10b2",
  "name" : "TestClusterACC",
  "description" : "Test cluster for ACC in Best DC",
  "location" : "Best",
  "billingCloudEnabled" : false,
  "bootstrapServers" : [ ],
  "providerType" : "apache-kafka",
  "authenticationInfo" : null,
  "topicPattern" : "{topic}",
  "groupPattern" : "{group}",
  "transactionalPattern" : "{transactional.id}",
  "sharedCluster" : false,
  "kafkaVersion" : "3.4.0",
  "kafkaListeners" : {
    "SCRAM_SHA_512" : "broker:9096",
    "MUTUAL_TLS" : "broker:9095"
  },
  "settings" : {
    "sslAuthMode" : "certificate"
  },
  "_links" : {
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "cluster" : {
      "href" : "...",
      "title" : "A cluster"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    }
  }
}

17.5. Retrieve a cluster

The clusters/{id} resource is used to retrieve, update and delete individual Clusters.

A GET request will retrieve the details of a Cluster.

17.5.1. Curl request

$ curl 'http://api.example.com/clusters/66c12e25ab06458eac988f0d700fbe81' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

17.5.2. HTTP request

GET /clusters/66c12e25ab06458eac988f0d700fbe81 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

17.5.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1068

{
  "uid" : "66c12e25ab06458eac988f0d700fbe81",
  "name" : "Zone1ClusterOTA",
  "description" : "",
  "location" : "Zone1",
  "billingCloudEnabled" : true,
  "bootstrapServers" : [ ],
  "providerType" : "apache-kafka",
  "authenticationInfo" : null,
  "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
  "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
  "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
  "sharedCluster" : true,
  "kafkaVersion" : "3.5.1",
  "kafkaListeners" : {
    "MUTUAL_TLS" : "broker:9090"
  },
  "settings" : { },
  "_links" : {
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "cluster" : {
      "href" : "...",
      "title" : "A cluster"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    }
  }
}

Additionally, if the requested cluster is a shared one or an external onboarded cluster, the TENANT_ADMIN would be able to see the authentication information and cluster URL.

17.5.4. Curl request

$ curl 'http://api.example.com/clusters/sa23rs32ab06458eac420f0d700fbe81' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

17.5.5. HTTP request

GET /clusters/sa23rs32ab06458eac420f0d700fbe81 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

17.5.6. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1583

{
  "uid" : "sa23rs32ab06458eac420f0d700fbe81",
  "name" : "SharedCluster",
  "description" : "Shared Cluster for Onboarding tenant",
  "location" : "AMS",
  "billingCloudEnabled" : false,
  "bootstrapServers" : [ {
    "bootstrapServer" : "bootstrapserver3:9093"
  } ],
  "providerType" : "apache-kafka",
  "authenticationInfo" : {
    "Axl-Broker-Private-Key-ApacheKafka" : "",
    "Axl-Sr-Password-ApacheKafka" : "",
    "Axl-Broker-Password-ApacheKafka" : "",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "MTLS",
    "Axl-Sr-Private-Key-ApacheKafka" : "",
    "Axl-Broker-Username-ApacheKafka" : "",
    "Axl-Sr-Cert-ApacheKafka" : "",
    "Axl-Sr-Protocol-Type-ApacheKafka" : "",
    "Axl-Broker-Cert-ApacheKafka" : "The Base64 encrypted Broker certificate",
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Broker-CA-Validation-ApacheKafka" : "false",
    "Axl-Bootstrap-Server-ApacheKafka" : "apache-kafka-bootstrap-Server",
    "Axl-Sr-Username-ApacheKafka" : "",
    "Axl-Sr-Url-ApacheKafka" : ""
  },
  "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
  "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
  "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
  "sharedCluster" : false,
  "kafkaVersion" : null,
  "kafkaListeners" : { },
  "settings" : { },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "cluster" : {
      "href" : "...",
      "title" : "A cluster"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    }
  }
}

17.6. Update a cluster

A PATCH request is used to update a cluster.

To leave an attribute of a cluster unchanged, any of the above may be omitted from the request.

If the existing providerInfo configuration for a cluster does not need to be changed, the entire list must still be sent, excluding the credentials. Credentials (such as the broker username and password or the broker certificate and private key) may only be included if they require an update.

17.6.1. Request fields

Path Type Description Constraints

name

String

The name of the cluster. Must be unique.

Must match the regular expression (?i)^[a-z0-9\.\-_]+$. Must not be empty. Size must be between 3 and 50 inclusive

description

String

A short text summarizing the purpose of the cluster.

Size must be between 0 and 200 inclusive

location

String

The data center or geographic name where this cluster is located.

Size must be between 0 and 50 inclusive

bootstrapServers

Array

Bootstrap servers URL’s of the cluster.

providerType

String

The name of the provider type

providerInfo

Object

A map containing provider specific configuration

tenant

String

Tenant that is mapped to a cluster

topicPattern

String

Topic Pattern configured to a cluster

groupPattern

String

Group Pattern configured to a cluster

transactionPattern

Array

Transactional Pattern configured to a cluster

settings

Object

A map containing custom settings for the cluster.

17.6.2. Curl request

$ curl 'http://api.example.com/clusters/66c12e25ab06458eac988f0d700fbe81' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "TestClusterACC",
  "description" : "Test cluster for ACC in Best DC",
  "location" : "Best",
  "bootstrapServers" : [ {
    "bootstrapServer" : "bootstrapserver1:9092"
  }, {
    "bootstrapServer" : "bootstrapserver2:9092"
  } ],
  "providerInfo" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "mTLS",
    "Axl-Broker-Cert-ApacheKafka" : "base64-cert",
    "Axl-Broker-Private-Key-ApacheKafka" : "base64-private-key",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate"
  },
  "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
  "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
  "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
  "kafkaVersion" : "3.4.0",
  "kafkaListeners" : {
    "MUTUAL_TLS" : "broker:9095",
    "SCRAM_SHA_512" : "broker:9096"
  },
  "settings" : {
    "sslAuthMode" : "fullChainCertificate"
  }
}'

17.6.3. HTTP request

PATCH /clusters/66c12e25ab06458eac988f0d700fbe81 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 942
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "TestClusterACC",
  "description" : "Test cluster for ACC in Best DC",
  "location" : "Best",
  "bootstrapServers" : [ {
    "bootstrapServer" : "bootstrapserver1:9092"
  }, {
    "bootstrapServer" : "bootstrapserver2:9092"
  } ],
  "providerInfo" : {
    "Axl-Provider-Type" : "apache-kafka",
    "Axl-Broker-Protocol-Type-ApacheKafka" : "mTLS",
    "Axl-Broker-Cert-ApacheKafka" : "base64-cert",
    "Axl-Broker-Private-Key-ApacheKafka" : "base64-private-key",
    "Axl-Broker-Truststore-ApacheKafka" : "ca-certificate"
  },
  "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
  "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
  "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
  "kafkaVersion" : "3.4.0",
  "kafkaListeners" : {
    "MUTUAL_TLS" : "broker:9095",
    "SCRAM_SHA_512" : "broker:9096"
  },
  "settings" : {
    "sslAuthMode" : "fullChainCertificate"
  }
}

17.6.4. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
location: http://api.example.com/clusters/66c12e25ab06458eac988f0d700fbe81
Content-Type: application/hal+json
Content-Length: 1178

{
  "uid" : "66c12e25ab06458eac988f0d700fbe81",
  "name" : "TestClusterACC",
  "description" : "Test cluster for ACC in Best DC",
  "location" : "Best",
  "billingCloudEnabled" : true,
  "bootstrapServers" : [ ],
  "providerType" : "apache-kafka",
  "authenticationInfo" : { },
  "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
  "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
  "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
  "sharedCluster" : true,
  "kafkaVersion" : "3.4.0",
  "kafkaListeners" : {
    "SCRAM_SHA_512" : "broker:9096",
    "MUTUAL_TLS" : "broker:9095"
  },
  "settings" : {
    "sslAuthMode" : "fullChainCertificate"
  },
  "_links" : {
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "cluster" : {
      "href" : "...",
      "title" : "A cluster"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    }
  }
}

17.7. Cluster search endpoints

17.7.1. /clusters/search/findByName

Search for a cluster by exact name.

All clusters returned by this endpoint are public clusters and the clusters owned by the tenant.
Query parameters
Parameter Description

name

Cluster name to search for.
HTTP request
GET /clusters/search/findByName?name=Zone1ClusterLST HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1830

{
  "_embedded" : {
    "clusters" : [ {
      "name" : "Zone1ClusterLST",
      "description" : "",
      "location" : "Zone1",
      "billingCloudEnabled" : false,
      "bootstrapServers" : [ ],
      "settings" : {
        "sslAuthMode" : "fullChainCertificate"
      },
      "providerType" : "apache-kafka",
      "topicPattern" : null,
      "groupPattern" : null,
      "transactionalPattern" : null,
      "kafkaListeners" : { },
      "kafkaVersion" : null,
      "multiTenant" : false,
      "kafkaCluster" : true,
      "multiEnvironment" : false,
      "bootstrapUrls" : "",
      "uid" : "f2e75fe2226745bea34ea9f56621f78f",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "cluster" : {
          "href" : "...",
          "title" : "A cluster"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "show" : {
      "href" : "...",
      "title" : "Indication that an entity can be shown in menu"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

17.7.2. /clusters/search/findByNameContaining

Search for a cluster by name containing search term.

All clusters returned by this endpoint are public clusters and the clusters owned by the tenant.
Query parameters
Parameter Description

name

Term to search within cluster name.
HTTP request
GET /clusters/search/findByNameContaining?name=lst HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 2942

{
  "_embedded" : {
    "clusters" : [ {
      "name" : "Zone2ClusterLST",
      "description" : "",
      "location" : "Zone2",
      "billingCloudEnabled" : false,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : null,
      "groupPattern" : null,
      "transactionalPattern" : null,
      "kafkaListeners" : { },
      "kafkaVersion" : null,
      "multiTenant" : false,
      "kafkaCluster" : true,
      "multiEnvironment" : false,
      "bootstrapUrls" : "",
      "uid" : "5fe719191cd44798ab70322830800dbc",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "cluster" : {
          "href" : "...",
          "title" : "A cluster"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      }
    }, {
      "name" : "Zone1ClusterLST",
      "description" : "",
      "location" : "Zone1",
      "billingCloudEnabled" : false,
      "bootstrapServers" : [ ],
      "settings" : {
        "sslAuthMode" : "fullChainCertificate"
      },
      "providerType" : "apache-kafka",
      "topicPattern" : null,
      "groupPattern" : null,
      "transactionalPattern" : null,
      "kafkaListeners" : { },
      "kafkaVersion" : null,
      "multiTenant" : false,
      "kafkaCluster" : true,
      "multiEnvironment" : false,
      "bootstrapUrls" : "",
      "uid" : "f2e75fe2226745bea34ea9f56621f78f",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "cluster" : {
          "href" : "...",
          "title" : "A cluster"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "show" : {
      "href" : "...",
      "title" : "Indication that an entity can be shown in menu"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

17.8. Delete cluster endpoints

Deleting a cluster is a two-step process, a GET request to check the constraints followed by the DELETE request.

17.8.1. Delete cluster constraints

A GET request is used to get the constraints for deleting a cluster. The constraint indicates that a cluster could be deleted if there are no instances defined for it.

The response shows that the cluster is deletable.

Curl request
$ curl 'http://api.example.com/clusters/f2e75fe2226745bea34ea9f56621f78f/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /clusters/f2e75fe2226745bea34ea9f56621f78f/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 52

{
  "canDelete" : true,
  "relatedInstances" : [ ]
}

The response shows that the cluster is not deletable.

Curl request
$ curl 'http://api.example.com/clusters/543c3b7d55634eba83b1472775c131c4/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /clusters/543c3b7d55634eba83b1472775c131c4/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3977

{
  "canDelete" : false,
  "relatedInstances" : [ {
    "instanceId" : "b9301e9144324928911f7d83ec40c478",
    "tenant" : {
      "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
      "optLock" : 0,
      "properties" : {
        "replication.factor" : "1",
        "min.insync.replicas" : "1",
        "cleanup.policy" : "delete"
      },
      "name" : "TenantA",
      "shortName" : "tenanta",
      "uniqueConsumerGroup" : true,
      "logo" : "tenanta.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : true,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "true",
        "schemaRolesEnforced" : "true",
        "onlyResourceManagerCanUpdateAndDeploy" : "false"
      },
      "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "shortName" : "ota"
  }, {
    "instanceId" : "g7969bd9f3f7435aa6bc6c62cb960304",
    "tenant" : {
      "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
      "optLock" : 0,
      "properties" : {
        "replication.factor" : "1",
        "min.insync.replicas" : "1",
        "cleanup.policy" : "delete"
      },
      "name" : "TenantA",
      "shortName" : "tenanta",
      "uniqueConsumerGroup" : true,
      "logo" : "tenanta.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : true,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "true",
        "schemaRolesEnforced" : "true",
        "onlyResourceManagerCanUpdateAndDeploy" : "false"
      },
      "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "shortName" : "lst"
  }, {
    "instanceId" : "6e37bcf4d4a44334924aa0f961286668",
    "tenant" : {
      "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
      "optLock" : 0,
      "properties" : {
        "replication.factor" : "1",
        "min.insync.replicas" : "1",
        "cleanup.policy" : "delete"
      },
      "name" : "TenantA",
      "shortName" : "tenanta",
      "uniqueConsumerGroup" : true,
      "logo" : "tenanta.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : true,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "true",
        "schemaRolesEnforced" : "true",
        "onlyResourceManagerCanUpdateAndDeploy" : "false"
      },
      "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "shortName" : "ota2"
  } ]
}

17.8.2. Delete a cluster

A DELETE request is used to delete a cluster.

Curl request
$ curl 'http://api.example.com/clusters/f2e75fe2226745bea34ea9f56621f78f' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
HTTP request
DELETE /clusters/f2e75fe2226745bea34ea9f56621f78f HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

18. Authentication Methods

Authentication Method represents an individual authentication method available for the system. Those authentication methods are driven by the clusters used by the system.

Usually a cluster supports SSL protocol as authentication method.

Additionally, clusters can support SASL protocol with SCRAM_SHA_256, SCRAM_SHA_512 or OAUTH_BEARER mechanism.

18.1. List all authentication methods

A GET request lists all authentication methods in the system. This operation can be done by an Axual admin or a Tenant admin only.

18.1.1. Curl request

$ curl 'http://api.example.com/authentication_methods' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

18.1.2. HTTP request

GET /authentication_methods HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

18.1.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 289

[ {
  "protocol" : "SASL",
  "mechanism" : "SCRAM_SHA_256"
}, {
  "protocol" : "SASL",
  "mechanism" : "OAUTH_BEARER"
}, {
  "protocol" : "SSL",
  "mechanism" : "MUTUAL_TLS"
}, {
  "protocol" : "SASL",
  "mechanism" : "SCRAM_SHA_512"
}, {
  "protocol" : "SASL",
  "mechanism" : "PLAIN"
} ]

19. Roles

Users can be assigned one or more roles.Each Role grants certain access to the Flux resources.

19.1. Valid Roles

Below are the list of roles that can be applied to any User of Flux.

Role Description

SUPER_ADMIN

Can manage Tenants, Instances and Clusters.

TENANT_ADMIN

Can do User and Group management.

APPLICATION_ADMIN

Can CREATE, READ, UPDATE applications within their own tenant.

APPLICATION_AUTHOR

Can CREATE new applications within their own tenant.

STREAM_ADMIN

Can CREATE, READ, UPDATE streams within their own tenant.

STREAM_AUTHOR

Can CREATE new streams within their own tenant.

ENVIRONMENT_ADMIN

Can CREATE, READ, UPDATE environments within their own tenant.

ENVIRONMENT_AUTHOR

Can CREATE new environments within their own tenant.

SCHEMA_ADMIN

Can CREATE, DELETE schemas/schemaVersions within their own tenant.

SCHEMA_AUTHOR

Can CREATE, DELETE schemas/schemaVersions within their own tenant.

BILLING_VIEWER

Can VIEW billing info for their own tenant.

BILLING_INTERNAL

Can VIEW usage stats for all tenants.
GROUP_ADMIN role is deprecated now and all the group management has moved to TENANT_ADMIN role.

19.2. Assigning Roles to Users

To assign a role to any user, send a PATCH request to the endpoint /users/uid/roles. The request body should be an array of 1 or more roles as shown below:

19.2.1. HTTP request

PATCH /users/dc67596abe224691a363a230ca1e291e/roles HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 70
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

[ {
  "name" : "STREAM_ADMIN"
}, {
  "name" : "APPLICATION_AUTHOR"
} ]

19.2.2. HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

19.2.3. Request fields

Path Type Description Constraints

[].name

String

The name of the role to assign.

This operation will replace all existing roles with the new set of roles provided in the request.

If an invalid role is passed (not present in above table), a 400 Bad Request is returned.

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Invalid request body: `Required request body is missing: org.springframework.http.ResponseEntity<?> io.axual.flux.tenantmanagement.web.RoleController.updateRoles(io.axual.flux.tenantmanagement.User,java.util.Collection<io.axual.flux.tenantmanagement.Role>)`. Please check API docs for building correct request." ],
  "subErrors" : null
}

19.2.4. Business rules when assigning roles

  1. Only TENANT_ADMIN users are allowed to assign roles for other users of same tenant.

  2. TENANT_ADMIN users can assign any roles except SUPER_ADMIN role.

  3. SUPER_ADMIN users can assign only SUPER_ADMIN role to users of super tenant.

20. Tenants

Tenant represents an individual customer of Axual Event Bus (AEB). A tenant can have multiple environments that map to a particular instance of AEB. Tenant can also have multiple Streams on multiple Environments on a particular instance of AEB.

Tenants are never visible to a tenant user. Logged-in user can see basic information like name and logo of his own tenant

The tenants collection resource is used to create and list tenants.

20.1. Tenant schema

The tenants resource uses the following json-schema:

20.1.1. HTTP request

GET /profile/tenants HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com

20.1.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 2805

{
  "title" : "Tenant",
  "definitions" : {
    "tenantAuthenticationMethods" : {
      "type" : "object",
      "properties" : {
        "protocol" : {
          "title" : "Protocol",
          "readOnly" : false,
          "type" : "string"
        },
        "rank" : {
          "title" : "Rank",
          "readOnly" : false,
          "type" : "integer"
        },
        "mechanism" : {
          "title" : "Mechanism",
          "readOnly" : false,
          "type" : "string",
          "enum" : [ "MUTUAL_TLS", "SCRAM_SHA_256", "SCRAM_SHA_512", "OAUTH_BEARER", "PLAIN" ]
        }
      }
    }
  },
  "properties" : {
    "settings" : {
      "title" : "Settings",
      "readOnly" : true,
      "type" : "object"
    },
    "uniqueConsumerGroup" : {
      "title" : "Unique consumer group",
      "readOnly" : false,
      "type" : "boolean"
    },
    "issuerUrl" : {
      "title" : "Issuer url",
      "readOnly" : false,
      "type" : "string"
    },
    "dataClassificationEnabled" : {
      "title" : "Data classification enabled",
      "readOnly" : false,
      "type" : "boolean"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "wizardCompleted" : {
      "title" : "Wizard completed",
      "readOnly" : false,
      "type" : "boolean"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "contact" : {
      "title" : "Contact",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "name" : {
      "title" : "Name",
      "readOnly" : false,
      "type" : "string"
    },
    "customerId" : {
      "title" : "Customer id",
      "readOnly" : false,
      "type" : "string"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "logo" : {
      "title" : "Logo",
      "readOnly" : false,
      "type" : "string"
    },
    "shortName" : {
      "title" : "Short name",
      "readOnly" : false,
      "type" : "string"
    },
    "supportedAuthenticationMethods" : {
      "title" : "Supported authentication methods",
      "readOnly" : false,
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "$ref" : "#/definitions/tenantAuthenticationMethods"
      }
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "properties" : {
      "title" : "Properties",
      "readOnly" : true,
      "type" : "object"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

20.2. List all tenants

A GET request lists all tenants in the system. This operation can be done by an Axual admin only.

20.2.1. Curl request

$ curl 'http://api.example.com/tenants' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

20.2.2. HTTP request

GET /tenants HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

20.2.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 13574

{
  "_embedded" : {
    "tenants" : [ {
      "properties" : null,
      "name" : "Super Test Tenant",
      "shortName" : "supertenant",
      "uniqueConsumerGroup" : true,
      "logo" : "supertenant.png",
      "issuerUrl" : "http://api.example.com/auth/realms/supertenant",
      "dataClassificationEnabled" : true,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      } ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1149c97f04c24cad8d9c97faa5a375ac",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : { },
      "name" : "Clean Tenant cc",
      "shortName" : "clntntcc",
      "uniqueConsumerGroup" : true,
      "logo" : "clean.png",
      "issuerUrl" : "http://api.example.com/auth/realms/clntntcc",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "false",
        "schemaRolesEnforced" : "false"
      },
      "uid" : "1149c97f04c42ha69d9c97f420a375ac",
      "created_at" : "2023-03-10T03:16:23",
      "modified_at" : "2023-03-10T03:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : null,
      "name" : "BYOK Tenant",
      "shortName" : "BYOKtenant",
      "uniqueConsumerGroup" : true,
      "logo" : "BYOKtenant.png",
      "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
      "dataClassificationEnabled" : true,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1149c97f04c42had8d9c97faa5a375ac",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : null,
      "name" : "Limited BYOK Tenant",
      "shortName" : "LmtBYOKtnt",
      "uniqueConsumerGroup" : false,
      "logo" : "BYOKtenant.png",
      "issuerUrl" : "http://api.example.com/auth/realms/limitedBYOKtenant",
      "dataClassificationEnabled" : true,
      "supportedAuthenticationMethods" : [ ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1248c97f04c42had8d9c97faa5a375bd",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : { },
      "name" : "Clean Tenant aiven",
      "shortName" : "clntnt",
      "uniqueConsumerGroup" : true,
      "logo" : "clean.png",
      "issuerUrl" : "http://api.example.com/auth/realms/clntnt",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "1259c97f04c42ha69d9c97f420a375ac",
      "created_at" : "2023-03-10T03:16:23",
      "modified_at" : "2023-03-10T03:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : null,
      "name" : "TenantWithNoEnv",
      "shortName" : "tenNoEnv",
      "uniqueConsumerGroup" : true,
      "logo" : "tenantWithNoEnv.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenantWithNoEnv",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "12s34t9629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : {
        "replication.factor" : "1",
        "min.insync.replicas" : "1",
        "cleanup.policy" : "delete"
      },
      "name" : "TenantActiveSubscription",
      "shortName" : "tenantS",
      "uniqueConsumerGroup" : true,
      "logo" : "tenantActiveSubs.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenantActiveSubs",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : true,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "false",
        "schemaRolesEnforced" : "false"
      },
      "uid" : "12we419629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : { },
      "name" : "TenantForSharedCluster",
      "shortName" : "tenantSC",
      "uniqueConsumerGroup" : true,
      "logo" : "tenantSharedCluster.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenantSharedCluster",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_512"
      } ],
      "wizardCompleted" : false,
      "customerId" : null,
      "settings" : { },
      "uid" : "23e42t9629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : {
        "replication.factor" : "1",
        "min.insync.replicas" : "1",
        "cleanup.policy" : "delete"
      },
      "name" : "TenantA",
      "shortName" : "tenanta",
      "uniqueConsumerGroup" : true,
      "logo" : "tenanta.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : true,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "true",
        "schemaRolesEnforced" : "true",
        "onlyResourceManagerCanUpdateAndDeploy" : "false"
      },
      "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : {
        "replication.factor" : "9",
        "min.insync.replicas" : "9",
        "segment.ms" : "999999999",
        "cleanup.policy" : "compact"
      },
      "name" : "TenantB",
      "shortName" : "tenantb",
      "uniqueConsumerGroup" : true,
      "logo" : "tenantb.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenantb",
      "dataClassificationEnabled" : true,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : true,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "true",
        "schemaRolesEnforced" : "false"
      },
      "uid" : "ddb92faaa7c74dfe9e579c69e3782fe8",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 10,
    "totalPages" : 1,
    "number" : 0
  }
}

20.3. Create tenant

A POST request is used to create a new tenant. This operation can be done by an Axual admin only.

20.3.1. Request fields

Path Type Description Constraints

name

String

Full name of the tenant

Must match the regular expression (?i)^[a-z0-9\.\-_ ]+$. Must not be empty. Size must be between 3 and 50 inclusive

shortName

String

Short name of the tenant

Must match the regular expression (?i)^[a-z][a-z0-9]*$. Must not be empty. Size must be between 1 and 12 inclusive

supportedAuthenticationMethods

Array

A list of supported authentication methods. If not specified, default value is SSL. Each authentication methods has a rank defining the order, 0 is the first.

Must not be empty. Must not be null

properties

Object

A list of Tenant specific variables in Key,Value format.

settings

Object

A list of Tenant specific settings in Key,Value format.

retentionTime

Number

The time in milliseconds after which the messages can be deleted from all streams. This is an optional field. If not specified, default value is 7 days (604800000).

partitions

Number

Defines the number of partitions configured for every stream of this tenant. This is an optional field. If not specified, default value is 12

20.3.2. Curl request

$ curl 'http://api.example.com/tenants' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "Test Tenant",
  "shortName" : "test",
  "issuerUrl" : "http://some.issuer.url",
  "retentionTime" : 50000,
  "partitions" : 12,
  "supportedAuthenticationMethods" : [ {
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256",
    "rank" : 0
  } ],
  "settings" : {
    "notificationsEnabled" : true,
    "schemaRolesEnforced" : true,
    "dataMaskingEnabled" : true,
    "onlyResourceManagerCanUpdateAndDeploy" : true
  }
}'

20.3.3. HTTP request

POST /tenants HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 440
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "Test Tenant",
  "shortName" : "test",
  "issuerUrl" : "http://some.issuer.url",
  "retentionTime" : 50000,
  "partitions" : 12,
  "supportedAuthenticationMethods" : [ {
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256",
    "rank" : 0
  } ],
  "settings" : {
    "notificationsEnabled" : true,
    "schemaRolesEnforced" : true,
    "dataMaskingEnabled" : true,
    "onlyResourceManagerCanUpdateAndDeploy" : true
  }
}

20.3.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 08:12:27 GMT
Location: http://api.example.com/tenants/ae8d928a0e184d8286e246062b99d03f
Content-Type: application/hal+json
Content-Length: 1256

{
  "properties" : {
    "cleanup.policy" : "delete"
  },
  "name" : "Test Tenant",
  "shortName" : "test",
  "uniqueConsumerGroup" : true,
  "logo" : null,
  "issuerUrl" : "http://some.issuer.url",
  "dataClassificationEnabled" : false,
  "supportedAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  } ],
  "wizardCompleted" : true,
  "customerId" : null,
  "settings" : {
    "notificationsEnabled" : "true",
    "schemaRolesEnforced" : "true",
    "dataMaskingEnabled" : "true",
    "onlyResourceManagerCanUpdateAndDeploy" : "true"
  },
  "uid" : "ae8d928a0e184d8286e246062b99d03f",
  "created_at" : "2025-06-25T08:12:27.483149156",
  "modified_at" : "2025-06-25T08:12:27.483149156",
  "created_by" : "superadmin@supertesttenant.nl",
  "modified_by" : "superadmin@supertesttenant.nl",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "contact" : {
      "href" : "...",
      "templated" : true,
      "title" : "Business contact of this tenant"
    }
  }
}

20.4. Retrieve a tenant

The tenants/{id} item resource is used to retrieve, update and delete individual tenants.

A GET request will retrieve the details of a Tenant.

If, inside the details of a Tenant, is display _embedded property, it means the contact for the current Tenant is not yet set. Otherwise, if it is present, the _embedded property contains all the user detail of the contact.

At the bottom of the details of a Tenant there are links that point directly to the User detail page of contact, if it is set already, otherwise the link point to 'ResourceNotFound'.

20.4.1. Curl request

$ curl 'http://api.example.com/tenants/55ef719629a94a07b9bf8ac0f3c495e5' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

20.4.2. HTTP request

GET /tenants/55ef719629a94a07b9bf8ac0f3c495e5 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

20.4.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 1400

{
  "properties" : {
    "replication.factor" : "1",
    "min.insync.replicas" : "1",
    "cleanup.policy" : "delete"
  },
  "name" : "TenantA",
  "shortName" : "tenanta",
  "uniqueConsumerGroup" : true,
  "logo" : "tenanta.png",
  "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
  "dataClassificationEnabled" : false,
  "supportedAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "wizardCompleted" : true,
  "customerId" : null,
  "settings" : {
    "notificationsEnabled" : "true",
    "schemaRolesEnforced" : "true",
    "onlyResourceManagerCanUpdateAndDeploy" : "false"
  },
  "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "contact" : {
      "href" : "...",
      "templated" : true,
      "title" : "Business contact of this tenant"
    }
  }
}
Relation Description

edit

Existence of this link indicates that the currently authenticated user can edit this Tenant

20.5. Update a tenant name

A PATCH request is used to update a tenant. Only an Axual admin can perform this action.

$ curl 'http://api.example.com/tenants/55ef719629a94a07b9bf8ac0f3c495e5' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "New Tenant"
}'
PATCH /tenants/55ef719629a94a07b9bf8ac0f3c495e5 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 27
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "New Tenant"
}
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "1"
Last-Modified: Wed, 25 Jun 2025 08:12:27 GMT
Content-Type: application/hal+json
Content-Length: 1466

{
  "properties" : {
    "replication.factor" : "1",
    "min.insync.replicas" : "1",
    "cleanup.policy" : "delete"
  },
  "name" : "New Tenant",
  "shortName" : "tenanta",
  "uniqueConsumerGroup" : true,
  "logo" : "tenanta.png",
  "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
  "dataClassificationEnabled" : false,
  "supportedAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "wizardCompleted" : true,
  "customerId" : null,
  "settings" : {
    "notificationsEnabled" : "true",
    "schemaRolesEnforced" : "true",
    "onlyResourceManagerCanUpdateAndDeploy" : "false",
    "dataMaskingEnabled" : "false"
  },
  "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2025-06-25T08:12:27.518576292",
  "created_by" : null,
  "modified_by" : "tenadmin@tenanta.nl",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "contact" : {
      "href" : "...",
      "templated" : true,
      "title" : "Business contact of this tenant"
    }
  }
}

20.6. Update tenant shortname

A PATCH request is used to update the tenant. Once the tenant is created, tenant shortname cannot be updated.

PATCH /tenants/55ef719629a94a07b9bf8ac0f3c495e5 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 32
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "shortName" : "New Tenant"
}
HTTP/1.1 400 Bad Request
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 303

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Tenant short-name can not be edited." ],
  "subErrors" : [ {
    "field" : "Tenant.shortName",
    "rejectedValue" : "New Tenant",
    "recommendedValues" : null,
    "errors" : [ "Tenant short-name can not be edited." ]
  } ]
}

20.7. Update a tenant supported authentication methods

A PATCH request is used to update a tenant supportedAuthenticationMethods. These supportedAuthenticationMethods define which type of authentication will be required to any applications connecting to a tenant’s instance.

Each supportedAuthenticationMethods has a rank defining the order of importance, the lowest rank has the top priority.

Allowed values are:

Protocol Mechanism

SSL

MUTUAL_TLS

SASL

SCRAM_SHA_256

SASL

SCRAM_SHA_512

SASL

OAUTH_BEARER

 
$ curl 'http://api.example.com/tenants/55ef719629a94a07b9bf8ac0f3c495e5' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "supportedAuthenticationMethods" : [ {
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256",
    "rank" : 2
  }, {
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS",
    "rank" : 1
  }, {
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_512",
    "rank" : 0
  }, {
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER",
    "rank" : 3
  } ]
}'
PATCH /tenants/55ef719629a94a07b9bf8ac0f3c495e5 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 366
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "supportedAuthenticationMethods" : [ {
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256",
    "rank" : 2
  }, {
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS",
    "rank" : 1
  }, {
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_512",
    "rank" : 0
  }, {
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER",
    "rank" : 3
  } ]
}
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "1"
Last-Modified: Wed, 25 Jun 2025 08:12:27 GMT
Content-Type: application/hal+json
Content-Length: 1545

{
  "properties" : {
    "replication.factor" : "1",
    "min.insync.replicas" : "1",
    "cleanup.policy" : "delete"
  },
  "name" : "TenantA",
  "shortName" : "tenanta",
  "uniqueConsumerGroup" : true,
  "logo" : "tenanta.png",
  "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
  "dataClassificationEnabled" : false,
  "supportedAuthenticationMethods" : [ {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 3,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  }, {
    "rank" : 1,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 0,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_512"
  } ],
  "wizardCompleted" : true,
  "customerId" : null,
  "settings" : {
    "notificationsEnabled" : "true",
    "schemaRolesEnforced" : "true",
    "onlyResourceManagerCanUpdateAndDeploy" : "false",
    "dataMaskingEnabled" : "false"
  },
  "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2025-06-25T08:12:27.777502857",
  "created_by" : null,
  "modified_by" : "tenadmin@tenanta.nl",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "contact" : {
      "href" : "...",
      "templated" : true,
      "title" : "Business contact of this tenant"
    }
  }
}

20.8. Update a tenant notifications enabled settings

A PATCH request is used to update a tenant notificationsEnabled settings.

By default, notificationsEnabled for a tenant is set to false.

When the notificationsEnabled is enabled on the tenants, users receive emails about various events related to their applications and topics.

20.8.1. Curl request

$ curl 'http://api.example.com/tenants/55ef719629a94a07b9bf8ac0f3c495e5' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "settings" : {
    "notificationsEnabled" : "true"
  }
}'

20.8.2. HTTP request

PATCH /tenants/55ef719629a94a07b9bf8ac0f3c495e5 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 60
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "settings" : {
    "notificationsEnabled" : "true"
  }
}

20.8.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "1"
Last-Modified: Wed, 25 Jun 2025 08:12:27 GMT
Content-Type: application/hal+json
Content-Length: 1463

{
  "properties" : {
    "replication.factor" : "1",
    "min.insync.replicas" : "1",
    "cleanup.policy" : "delete"
  },
  "name" : "TenantA",
  "shortName" : "tenanta",
  "uniqueConsumerGroup" : true,
  "logo" : "tenanta.png",
  "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
  "dataClassificationEnabled" : false,
  "supportedAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "wizardCompleted" : true,
  "customerId" : null,
  "settings" : {
    "notificationsEnabled" : "true",
    "schemaRolesEnforced" : "true",
    "onlyResourceManagerCanUpdateAndDeploy" : "false",
    "dataMaskingEnabled" : "false"
  },
  "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2025-06-25T08:12:27.638761192",
  "created_by" : null,
  "modified_by" : "tenadmin@tenanta.nl",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "contact" : {
      "href" : "...",
      "templated" : true,
      "title" : "Business contact of this tenant"
    }
  }
}

20.9. Update a tenant schema roles enforced settings

A PATCH request is used to update a tenant schemaRolesEnforced settings.

By default, schemaRolesEnforced for a tenant is set to false.

When the schemaRolesEnforced=true on the tenants, only users with the SCHEMA_ADMIN or SCHEMA_AUTHOR role can create or delete any schema or schema version. Ensure that schema roles are set up before changing the value to true.

20.9.1. Curl request

$ curl 'http://api.example.com/tenants/55ef719629a94a07b9bf8ac0f3c495e5' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "settings" : {
    "schemaRolesEnforced" : "true"
  }
}'

20.9.2. HTTP request

PATCH /tenants/55ef719629a94a07b9bf8ac0f3c495e5 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 59
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "settings" : {
    "schemaRolesEnforced" : "true"
  }
}

20.9.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "1"
Last-Modified: Wed, 25 Jun 2025 08:12:27 GMT
Content-Type: application/hal+json
Content-Length: 1463

{
  "properties" : {
    "replication.factor" : "1",
    "min.insync.replicas" : "1",
    "cleanup.policy" : "delete"
  },
  "name" : "TenantA",
  "shortName" : "tenanta",
  "uniqueConsumerGroup" : true,
  "logo" : "tenanta.png",
  "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
  "dataClassificationEnabled" : false,
  "supportedAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "wizardCompleted" : true,
  "customerId" : null,
  "settings" : {
    "notificationsEnabled" : "true",
    "schemaRolesEnforced" : "true",
    "onlyResourceManagerCanUpdateAndDeploy" : "false",
    "dataMaskingEnabled" : "false"
  },
  "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2025-06-25T08:12:27.684130039",
  "created_by" : null,
  "modified_by" : "tenadmin@tenanta.nl",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "contact" : {
      "href" : "...",
      "templated" : true,
      "title" : "Business contact of this tenant"
    }
  }
}

20.10. Update a tenant data masking enabled settings

A PATCH request is used to update a tenant dataMaskingEnabled settings.

By default, dataMaskingEnabled for a tenant is set to false.

When the dataMaskingEnabled=true on the tenants, activate all Data Masking fields/buttons on the UI.

20.10.1. Curl request

$ curl 'http://api.example.com/tenants/55ef719629a94a07b9bf8ac0f3c495e5' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "settings" : {
    "dataMaskingEnabled" : "true"
  }
}'

20.10.2. HTTP request

PATCH /tenants/55ef719629a94a07b9bf8ac0f3c495e5 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 58
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "settings" : {
    "dataMaskingEnabled" : "true"
  }
}

20.10.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "1"
Last-Modified: Wed, 25 Jun 2025 08:12:27 GMT
Content-Type: application/hal+json
Content-Length: 1462

{
  "properties" : {
    "replication.factor" : "1",
    "min.insync.replicas" : "1",
    "cleanup.policy" : "delete"
  },
  "name" : "TenantA",
  "shortName" : "tenanta",
  "uniqueConsumerGroup" : true,
  "logo" : "tenanta.png",
  "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
  "dataClassificationEnabled" : false,
  "supportedAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "wizardCompleted" : true,
  "customerId" : null,
  "settings" : {
    "notificationsEnabled" : "true",
    "schemaRolesEnforced" : "true",
    "onlyResourceManagerCanUpdateAndDeploy" : "false",
    "dataMaskingEnabled" : "true"
  },
  "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2025-06-25T08:12:27.547012105",
  "created_by" : null,
  "modified_by" : "tenadmin@tenanta.nl",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "contact" : {
      "href" : "...",
      "templated" : true,
      "title" : "Business contact of this tenant"
    }
  }
}

20.11. Update a tenant only resource manager can update and deploy settings

A PATCH request is used to update a tenant’s onlyResourceManagerCanUpdateAndDeploy settings.

By default, this setting is set to false, allowing all group members to update and deploy resources.

When onlyResourceManagerCanUpdateAndDeploy=true on the tenant, only users with the RESOURCE_MANAGER role are permitted to update or deploy their owned resources.

20.11.1. Curl request

$ curl 'http://api.example.com/tenants/55ef719629a94a07b9bf8ac0f3c495e5' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "settings" : {
    "onlyResourceManagerCanUpdateAndDeploy" : "true"
  }
}'

20.11.2. HTTP request

PATCH /tenants/55ef719629a94a07b9bf8ac0f3c495e5 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 77
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "settings" : {
    "onlyResourceManagerCanUpdateAndDeploy" : "true"
  }
}

20.11.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "1"
Last-Modified: Wed, 25 Jun 2025 08:12:27 GMT
Content-Type: application/hal+json
Content-Length: 1462

{
  "properties" : {
    "replication.factor" : "1",
    "min.insync.replicas" : "1",
    "cleanup.policy" : "delete"
  },
  "name" : "TenantA",
  "shortName" : "tenanta",
  "uniqueConsumerGroup" : true,
  "logo" : "tenanta.png",
  "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
  "dataClassificationEnabled" : false,
  "supportedAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "wizardCompleted" : true,
  "customerId" : null,
  "settings" : {
    "notificationsEnabled" : "true",
    "schemaRolesEnforced" : "true",
    "onlyResourceManagerCanUpdateAndDeploy" : "true",
    "dataMaskingEnabled" : "false"
  },
  "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2025-06-25T08:12:27.608893993",
  "created_by" : null,
  "modified_by" : "tenadmin@tenanta.nl",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "contact" : {
      "href" : "...",
      "templated" : true,
      "title" : "Business contact of this tenant"
    }
  }
}

20.12. Search endpoints

20.12.1. /tenants/search/findByName

Search for a tenant by exact name.

Parameter Description

name

Exact name to search for.

 
GET /tenants/search/findByName?name=TenantA HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1783

{
  "_embedded" : {
    "tenants" : [ {
      "properties" : {
        "replication.factor" : "1",
        "min.insync.replicas" : "1",
        "cleanup.policy" : "delete"
      },
      "name" : "TenantA",
      "shortName" : "tenanta",
      "uniqueConsumerGroup" : true,
      "logo" : "tenanta.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : true,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "true",
        "schemaRolesEnforced" : "true",
        "onlyResourceManagerCanUpdateAndDeploy" : "false"
      },
      "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

20.12.2. /tenants/search/findByNameContaining

Search for a tenant by name containing search term.

Parameter Description

name

Term to search for within tenant name.

 
GET /tenants/search/findByNameContaining?name=TenantA HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 3486

{
  "_embedded" : {
    "tenants" : [ {
      "properties" : {
        "replication.factor" : "1",
        "min.insync.replicas" : "1",
        "cleanup.policy" : "delete"
      },
      "name" : "TenantActiveSubscription",
      "shortName" : "tenantS",
      "uniqueConsumerGroup" : true,
      "logo" : "tenantActiveSubs.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenantActiveSubs",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : true,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "false",
        "schemaRolesEnforced" : "false"
      },
      "uid" : "12we419629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    }, {
      "properties" : {
        "replication.factor" : "1",
        "min.insync.replicas" : "1",
        "cleanup.policy" : "delete"
      },
      "name" : "TenantA",
      "shortName" : "tenanta",
      "uniqueConsumerGroup" : true,
      "logo" : "tenanta.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : true,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "true",
        "schemaRolesEnforced" : "true",
        "onlyResourceManagerCanUpdateAndDeploy" : "false"
      },
      "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

20.12.3. /tenants/search/findByShortName

Search for a tenant by exact short name.

Parameter Description

shortName

Tenant short name to search for.

 
GET /tenants/search/findByShortName?shortName=tenanta HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1783

{
  "_embedded" : {
    "tenants" : [ {
      "properties" : {
        "replication.factor" : "1",
        "min.insync.replicas" : "1",
        "cleanup.policy" : "delete"
      },
      "name" : "TenantA",
      "shortName" : "tenanta",
      "uniqueConsumerGroup" : true,
      "logo" : "tenanta.png",
      "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
      "dataClassificationEnabled" : false,
      "supportedAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "wizardCompleted" : true,
      "customerId" : null,
      "settings" : {
        "notificationsEnabled" : "true",
        "schemaRolesEnforced" : "true",
        "onlyResourceManagerCanUpdateAndDeploy" : "false"
      },
      "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "contact" : {
          "href" : "...",
          "templated" : true,
          "title" : "Business contact of this tenant"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

20.13. Onboard Tenant With Shared Cluster

This POST endpoint is used to onboard a new tenant with the shared cluster.

20.13.1. Curl request

$ curl 'http://api.example.com/tenants/23e42t9629a94a07b9bf8ac0f3c495e5/onboard' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'

20.13.2. HTTP request

POST /tenants/23e42t9629a94a07b9bf8ac0f3c495e5/onboard HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

20.13.3. HTTP response

HTTP/1.1 200 OK

21. Users

A User is a person logging into Self-Service. Every user is identified by a unique email address that also identifies the Tenant they belong to. A user can never see users of other tenant.

The /users resource is used to create and list users.

21.1. Users Schema

The /users resource uses the following json-schema:

GET /profile/users HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 2113

{
  "title" : "User",
  "definitions" : {
    "emailAddress" : {
      "type" : "object",
      "properties" : {
        "email" : {
          "title" : "Email",
          "readOnly" : true,
          "type" : "string"
        }
      }
    },
    "role" : {
      "type" : "object",
      "properties" : {
        "name" : {
          "title" : "Name",
          "readOnly" : true,
          "type" : "string"
        }
      }
    }
  },
  "properties" : {
    "lastName" : {
      "title" : "Last name",
      "readOnly" : false,
      "type" : "string"
    },
    "settings" : {
      "title" : "Settings",
      "readOnly" : true,
      "type" : "object"
    },
    "roles" : {
      "title" : "Roles",
      "readOnly" : true,
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "$ref" : "#/definitions/role"
      }
    },
    "fullName" : {
      "title" : "Full name",
      "readOnly" : true,
      "type" : "string"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "firstName" : {
      "title" : "First name",
      "readOnly" : false,
      "type" : "string"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "emailAddress" : {
      "title" : "Email address",
      "readOnly" : true,
      "type" : "object",
      "$ref" : "#/definitions/emailAddress"
    },
    "phoneNumber" : {
      "title" : "Phone number",
      "readOnly" : false,
      "type" : "string"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "middleName" : {
      "title" : "Middle name",
      "readOnly" : false,
      "type" : "string"
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

21.2. List all users

A GET request will list all users belonging to the same tenant as the logged in user.

21.2.1. Curl request

$ curl 'http://api.example.com/users' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

21.2.2. HTTP request

GET /users HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

21.2.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 12985

{
  "_embedded" : {
    "users" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "kad",
      "lastName" : "member",
      "middleName" : null,
      "emailAddress" : {
        "email" : "kadmember@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "007b994a6ab34165a93fd4c7a8db1388"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "envOwner",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "envowner@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "1759cc36cacd4dc28ed1b0336e22e06d"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "firstNameTest",
      "lastName" : "lastNameTest",
      "middleName" : "van der",
      "emailAddress" : {
        "email" : "testuser@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "admin",
      "lastName" : "user2",
      "middleName" : null,
      "emailAddress" : {
        "email" : "adminuser2@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "1e596ab9191a3dc67e2e6ca23a230246"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "po2",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "po2@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "1ecbda9a995f4ab2a4c95716087b21c7"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "streamOwner",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "streamowner@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "1ecbda9a995f4ab2a4c95716087b21c8"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "schemaOwner",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "schemaowner@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "28ed1b01759cd4dc336ecc36ca22e06d"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "strAuthor",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "strauthor@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "3cab41ad252e48a49631d1346d227a17"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "group",
      "lastName" : "manager",
      "middleName" : null,
      "emailAddress" : {
        "email" : "groupmanager@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "465a7a8db09a6ab3419913883fd4c07b"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "appOwner",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "appowner@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "51234a7a81994d1ca35ca7894cde08c6"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "po1",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "po1@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "51234a7a81994d1ca35ca7894cde08c9"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "envAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "envadmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "7cb463240b8049578b298c214c28512a"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "regular2",
      "lastName" : "user2",
      "middleName" : null,
      "emailAddress" : {
        "email" : "regularuser2@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "91a3dc676abe2e623a2302469191e5ca"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "envAuthor",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "envauthor@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "strAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "stradmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "a0018341100c431d8a8117be2ad12d8a"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "regular4",
      "lastName" : "user",
      "middleName" : null,
      "emailAddress" : {
        "email" : "regularuser4@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "abe22469vu485961a363a230ca1e291e"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "schAuthor",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "schauthor@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "bb66c8d7cd5b2e509ec0ff840ef37c62"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "schAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "schadmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "bcc36324058049578b298c214c28512a"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "appAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "appadmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "caa51002633244ffbe36f4ccf8a8f501"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "powerUser",
      "lastName" : "powerUser",
      "middleName" : null,
      "emailAddress" : {
        "email" : "poweruser@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd"
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 28,
    "totalPages" : 2,
    "number" : 0
  }
}
Relation Description

create

Existence of this link indicates that the currently authenticated user can create a User

21.3. Retrieve a user

The /users/{id} item resource is used to retrieve, update individual users.

A GET request will retrieve the details of a User.

21.3.1. Curl request

$ curl 'http://api.example.com/users/dc67596abe224691a363a230ca1e291e' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

21.3.2. HTTP request

GET /users/dc67596abe224691a363a230ca1e291e HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

21.3.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 1070

{
  "firstName" : "regular",
  "lastName" : "user",
  "middleName" : null,
  "emailAddress" : {
    "email" : "regularuser@tenanta.nl"
  },
  "phoneNumber" : null,
  "roles" : [ ],
  "settings" : {
    "notificationEnabled" : "true"
  },
  "fullName" : "regular user",
  "uid" : "dc67596abe224691a363a230ca1e291e",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "user" : {
      "href" : "...",
      "templated" : true,
      "title" : "A user"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "assign_roles" : {
      "href" : "...",
      "title" : "Indication that authenticated user can assign roles to this user"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    }
  }
}
Relation Description

edit

Existence of this link indicates that the currently authenticated user can edit the User

assign_roles

Existence of this link indicates that the currently authenticated user can assign roles to this user

delete

Existence of this link indicates that the currently authenticated user can delete this user

21.4. Create User

The endpoint /users is now deprecated. Please contact the Administration team regarding the topic of creating new Users.

A POST request is used to create a new User. This operation can be done by a Tenant Admin only.

21.4.1. Request fields

Path Type Description Constraints

firstName

String

The first name of the user

Must not be empty. Size must be between 1 and 50 inclusive

lastName

String

The last name of the user

Must not be empty. Size must be between 1 and 50 inclusive

middleName

String

The tussenvoegsel of the user

Size must be between 0 and 16 inclusive

emailAddress

String

The complete mail address of the user

password

String

The password of the user

Size must be between 0 and 72 inclusive

phoneNumber

String

The phoneNumber of the user

This is an optional field. Must be a valid phone number like +31612345678 or 0612345678.

21.4.2. Curl request

$ curl 'http://api.example.com/users' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "firstName" : "User",
  "lastName" : "Vrij",
  "middleName" : "van",
  "emailAddress" : "user.van.vrij@tenanta.nl",
  "password" : "notsecret",
  "phoneNumber" : "0612345678",
  "settings" : {
    "notificationEnabled" : "false"
  }
}'

21.4.3. HTTP request

POST /users HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 238
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "firstName" : "User",
  "lastName" : "Vrij",
  "middleName" : "van",
  "emailAddress" : "user.van.vrij@tenanta.nl",
  "password" : "notsecret",
  "phoneNumber" : "0612345678",
  "settings" : {
    "notificationEnabled" : "false"
  }
}

21.4.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 08:12:26 GMT
Location: http://api.example.com/users/f5363398dc1549719545b05426e5704a
Content-Type: application/hal+json
Content-Length: 1134

{
  "firstName" : "User",
  "lastName" : "Vrij",
  "middleName" : "van",
  "emailAddress" : {
    "email" : "user.van.vrij@tenanta.nl"
  },
  "phoneNumber" : "0612345678",
  "roles" : [ ],
  "settings" : {
    "notificationEnabled" : "false"
  },
  "fullName" : "User van Vrij",
  "uid" : "f5363398dc1549719545b05426e5704a",
  "created_at" : "2025-06-25T08:12:26.632211817",
  "modified_at" : "2025-06-25T08:12:26.632211817",
  "created_by" : "tenadmin@tenanta.nl",
  "modified_by" : "tenadmin@tenanta.nl",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "user" : {
      "href" : "...",
      "templated" : true,
      "title" : "A user"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "assign_roles" : {
      "href" : "...",
      "title" : "Indication that authenticated user can assign roles to this user"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    }
  }
}

21.5. Update user

A PATCH request is used to update a User.

21.5.1. Update phoneNumber

$ curl 'http://api.example.com/users/dc67596abe224691a363a230ca1e291e' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "phoneNumber" : "+31063433333"
}'
PATCH /users/dc67596abe224691a363a230ca1e291e HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 36
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "phoneNumber" : "+31063433333"
}
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
Content-Type: application/hal+json
Content-Length: 1080

{
  "firstName" : "regular",
  "lastName" : "user",
  "middleName" : null,
  "emailAddress" : {
    "email" : "regularuser@tenanta.nl"
  },
  "phoneNumber" : "+31063433333",
  "roles" : [ ],
  "settings" : {
    "notificationEnabled" : "true"
  },
  "fullName" : "regular user",
  "uid" : "dc67596abe224691a363a230ca1e291e",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "user" : {
      "href" : "...",
      "templated" : true,
      "title" : "A user"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "assign_roles" : {
      "href" : "...",
      "title" : "Indication that authenticated user can assign roles to this user"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    }
  }
}

21.5.2. Update notification enabled settings

A PATCH request is used to update a user notificationEnabled settings.

By default, notificationEnabled for a user is set to true.

When the notificationEnabled is disabled for a user, receiving emails about various events related to the owned applications and topics will be stopped, even if tenant notification settings is enabled.

Curl request
$ curl 'http://api.example.com/users/dc67596abe224691a363a230ca1e291e' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "settings" : {
    "notificationEnabled" : "false"
  }
}'
HTTP request
PATCH /users/dc67596abe224691a363a230ca1e291e HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 60
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "settings" : {
    "notificationEnabled" : "false"
  }
}
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
Content-Type: application/hal+json
Content-Length: 1071

{
  "firstName" : "regular",
  "lastName" : "user",
  "middleName" : null,
  "emailAddress" : {
    "email" : "regularuser@tenanta.nl"
  },
  "phoneNumber" : null,
  "roles" : [ ],
  "settings" : {
    "notificationEnabled" : "false"
  },
  "fullName" : "regular user",
  "uid" : "dc67596abe224691a363a230ca1e291e",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "user" : {
      "href" : "...",
      "templated" : true,
      "title" : "A user"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "assign_roles" : {
      "href" : "...",
      "title" : "Indication that authenticated user can assign roles to this user"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    }
  }
}

21.6. Delete user

A DELETE request is used to delete a User.

$ curl 'http://api.example.com/users/007b994a6ab34165a93fd4c7a8db1388' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
DELETE /users/007b994a6ab34165a93fd4c7a8db1388 HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

21.7. Users search endpoints

21.7.1. /users/search/findByFirstName

Returns all users with firstName containing the given firstName.

Parameter Description

firstName

A name or part of name

 
GET /users/search/findByFirstName?firstName=poweruser HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 960

{
  "_embedded" : {
    "users" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "powerUser",
      "lastName" : "powerUser",
      "middleName" : null,
      "emailAddress" : {
        "email" : "poweruser@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

21.7.2. /users/search/findByLastName

Returns all users with lastName containing the given lastName.

Parameter Description

lastName

A surname or part of surname

 
GET /users/search/findByLastName?lastName=lastNameTest HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 971

{
  "_embedded" : {
    "users" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "firstNameTest",
      "lastName" : "lastNameTest",
      "middleName" : "van der",
      "emailAddress" : {
        "email" : "testuser@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

21.7.3. /users/search/searchUser

Returns all users with firstName, middleName, lastName, localPart containing the given searchKeyword.

Parameter Description

searchKeyword

The key word used to search

 
GET /users/search/searchUser?searchKeyword=tenAdmin HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1585

{
  "_embedded" : {
    "users" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "tenAdmin",
      "lastName" : "TenantA",
      "middleName" : "middleName",
      "emailAddress" : {
        "email" : "tenadmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "ea0e7f147df84179a151bdc21f5bb813"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "tenAdmin",
      "lastName" : "TenantA",
      "middleName" : "middleName",
      "emailAddress" : {
        "email" : "noGroup@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "w3f45f147df84179a151bdc21f5bb813"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

21.7.4. /users/search/findByRole

Returns all users with given roles. Pass the name of the role as parameter.

Parameter Description

role

The name of role

 
GET /users/search/findByRole?role=TENANT_ADMIN HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 2193

{
  "_embedded" : {
    "users" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "admin",
      "lastName" : "user2",
      "middleName" : null,
      "emailAddress" : {
        "email" : "adminuser2@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "1e596ab9191a3dc67e2e6ca23a230246"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "powerUser",
      "lastName" : "powerUser",
      "middleName" : null,
      "emailAddress" : {
        "email" : "poweruser@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "tenAdmin",
      "lastName" : "TenantA",
      "middleName" : "middleName",
      "emailAddress" : {
        "email" : "tenadmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "ea0e7f147df84179a151bdc21f5bb813"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

21.7.5. /users/search/findByEmailAddress

Return user with emailAddress as the given emailAddress

Parameter Description

email

A valid email object

 
GET /users/search/findByEmailAddress?email=appowner%40tenanta.nl HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 769

{
  "_embedded" : {
    "users" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        },
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        }
      },
      "settings" : { },
      "firstName" : "appOwner",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "appowner@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "51234a7a81994d1ca35ca7894cde08c6"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

22. Groups

A group in Flux represents a DevOps team within a tenant. Although different tenants may have different names for their teams, in Flux, they are represented by a group.

22.1. Group permissions

Every group can have zero or more users. Being a member of a group grants you certain permissions. The permission depends on the resource the group owns. If a group is owner of an application, every member of that group will have full rights on that application. This includes editing and even deleting the application.

Any group can be attached to an application, stream or environment. These resources have a owners field which represent the group that owns the resource. A resource can exist without any group owning it.

When listing a resource that has an existing 'owners' group, it will be show as embedded object of the resource. If the resource has no 'owners' group, it will be not shown as embedded object of the resource.

22.2. Group Manager

Group Manager can add/remove users to the group like a Tenant Admin. Additionally, they have the authority to add/remove Resource Managers. A group can be created without a Group Manager. Only Tenant Admin can update this group. Multiple Group Managers for a single group are supported.

22.3. Add manager to a group

To make user a group manager send PATCH request.

22.3.1. Curl request

$ curl 'http://api.example.com/groups/2d8e99afd6e047f69c9595b4f2525fa6' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "Team Amazing",
  "emailAddress" : "team.amazing@tenanta.nl",
  "phoneNumber" : "+31612345678",
  "members" : [ "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a", "http://api.example.com/users/1ecbda9a995f4ab2a4c95716087b21c8", "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17" ],
  "managers" : [ "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17", "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a" ],
  "properties" : {
    "group.property1" : "value1",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property4" : "value4",
    "group.property5" : "value5"
  }
}'

22.3.2. HTTP request

PATCH /groups/2d8e99afd6e047f69c9595b4f2525fa6 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 664
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "Team Amazing",
  "emailAddress" : "team.amazing@tenanta.nl",
  "phoneNumber" : "+31612345678",
  "members" : [ "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a", "http://api.example.com/users/1ecbda9a995f4ab2a4c95716087b21c8", "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17" ],
  "managers" : [ "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17", "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a" ],
  "properties" : {
    "group.property1" : "value1",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property4" : "value4",
    "group.property5" : "value5"
  }
}

22.3.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 21:16:23 GMT
Location: http://api.example.com/groups/2d8e99afd6e047f69c9595b4f2525fa6
Content-Type: application/hal+json
Content-Length: 4235

{
  "name" : "Team Amazing",
  "properties" : {
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property1" : "value1",
    "group.property4" : "value4",
    "group.property5" : "value5"
  },
  "emailAddress" : {
    "email" : "team.amazing@tenanta.nl"
  },
  "phoneNumber" : "+31612345678",
  "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "members" : [ {
      "settings" : { },
      "firstName" : "strAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "stradmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "a0018341100c431d8a8117be2ad12d8a",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    }, {
      "settings" : { },
      "firstName" : "strAuthor",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "strauthor@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "3cab41ad252e48a49631d1346d227a17",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    }, {
      "settings" : { },
      "firstName" : "streamOwner",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "streamowner@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "1ecbda9a995f4ab2a4c95716087b21c8",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ],
    "managers" : [ {
      "settings" : { },
      "firstName" : "strAuthor",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "strauthor@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "3cab41ad252e48a49631d1346d227a17",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    }, {
      "settings" : { },
      "firstName" : "strAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "stradmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "a0018341100c431d8a8117be2ad12d8a",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "group" : {
      "href" : "...",
      "title" : "A group"
    },
    "members" : [ {
      "href" : "...",
      "title" : "Users belonging to this group"
    } ],
    "managers" : {
      "href" : "..."
    },
    "resourceManagers" : {
      "href" : "..."
    }
  }
}
Relation Description

members

The members of this Group can be found at this link. This link is also used add/remove users from this group.

managers

The manager of this Group can be found at this link. This link is also used add/remove users from this group.

resourceManagers

The resource manager of this Group can be found at this link. This link is also used add/remove users from this group.

22.4. Remove manager from a group

To remove user from group manager send PATCH request to remove the user from group manager.

22.4.1. Curl request

$ curl 'http://api.example.com/groups/2d8e99afd6e047f69c9595b4f2525fa6' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "Team Amazing",
  "emailAddress" : "team.amazing@tenanta.nl",
  "phoneNumber" : "+31612345678",
  "members" : [ "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a", "http://api.example.com/users/1ecbda9a995f4ab2a4c95716087b21c8", "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17" ],
  "managers" : [ "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17" ],
  "properties" : {
    "group.property1" : "value1",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property4" : "value4",
    "group.property5" : "value5"
  }
}'

22.4.2. HTTP request

PATCH /groups/2d8e99afd6e047f69c9595b4f2525fa6 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 599
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "Team Amazing",
  "emailAddress" : "team.amazing@tenanta.nl",
  "phoneNumber" : "+31612345678",
  "members" : [ "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a", "http://api.example.com/users/1ecbda9a995f4ab2a4c95716087b21c8", "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17" ],
  "managers" : [ "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17" ],
  "properties" : {
    "group.property1" : "value1",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property4" : "value4",
    "group.property5" : "value5"
  }
}

22.4.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 21:16:23 GMT
Location: http://api.example.com/groups/2d8e99afd6e047f69c9595b4f2525fa6
Content-Type: application/hal+json
Content-Length: 3621

{
  "name" : "Team Amazing",
  "properties" : {
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property1" : "value1",
    "group.property4" : "value4",
    "group.property5" : "value5"
  },
  "emailAddress" : {
    "email" : "team.amazing@tenanta.nl"
  },
  "phoneNumber" : "+31612345678",
  "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "members" : [ {
      "settings" : { },
      "firstName" : "strAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "stradmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "a0018341100c431d8a8117be2ad12d8a",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    }, {
      "settings" : { },
      "firstName" : "strAuthor",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "strauthor@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "3cab41ad252e48a49631d1346d227a17",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    }, {
      "settings" : { },
      "firstName" : "streamOwner",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "streamowner@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "1ecbda9a995f4ab2a4c95716087b21c8",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ],
    "managers" : [ {
      "settings" : { },
      "firstName" : "strAuthor",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "strauthor@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "3cab41ad252e48a49631d1346d227a17",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "group" : {
      "href" : "...",
      "title" : "A group"
    },
    "members" : [ {
      "href" : "...",
      "title" : "Users belonging to this group"
    } ],
    "managers" : {
      "href" : "..."
    },
    "resourceManagers" : {
      "href" : "..."
    }
  }
}

22.5. Resource Manager

Only Resource Managers have the authority to update and deploy the resources they own. While a group can be created without a Resource Manager, only a Tenant Admin or Group Manager can add/remove Resource Managers to the group. Multiple Resource Managers for a single group are supported.

This feature is only available if the tenant setting onlyResourceManagerCanUpdateAndDeploy is set to true. Otherwise, all group members will have permissions to update and deploy resources.

22.6. Add resource manager to a group

To make user a resource manager send PATCH request.

22.6.1. Curl request

$ curl 'http://api.example.com/groups/2d8e99afd6e047f69c9595b4f2525fa6' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "Team Amazing",
  "emailAddress" : "team.amazing@tenanta.nl",
  "phoneNumber" : "+31612345678",
  "members" : [ "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a", "http://api.example.com/users/1ecbda9a995f4ab2a4c95716087b21c8", "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17" ],
  "resourceManagers" : [ "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17", "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a" ],
  "properties" : {
    "group.property1" : "value1",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property4" : "value4",
    "group.property5" : "value5"
  }
}'

22.6.2. HTTP request

PATCH /groups/2d8e99afd6e047f69c9595b4f2525fa6 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 672
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "Team Amazing",
  "emailAddress" : "team.amazing@tenanta.nl",
  "phoneNumber" : "+31612345678",
  "members" : [ "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a", "http://api.example.com/users/1ecbda9a995f4ab2a4c95716087b21c8", "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17" ],
  "resourceManagers" : [ "http://api.example.com/users/3cab41ad252e48a49631d1346d227a17", "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a" ],
  "properties" : {
    "group.property1" : "value1",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property4" : "value4",
    "group.property5" : "value5"
  }
}

22.6.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 21:16:23 GMT
Location: http://api.example.com/groups/2d8e99afd6e047f69c9595b4f2525fa6
Content-Type: application/hal+json
Content-Length: 4265

{
  "name" : "Team Amazing",
  "properties" : {
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property1" : "value1",
    "group.property4" : "value4",
    "group.property5" : "value5"
  },
  "emailAddress" : {
    "email" : "team.amazing@tenanta.nl"
  },
  "phoneNumber" : "+31612345678",
  "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "members" : [ {
      "settings" : { },
      "firstName" : "strAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "stradmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "a0018341100c431d8a8117be2ad12d8a",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    }, {
      "settings" : { },
      "firstName" : "strAuthor",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "strauthor@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "3cab41ad252e48a49631d1346d227a17",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    }, {
      "settings" : { },
      "firstName" : "streamOwner",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "streamowner@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "1ecbda9a995f4ab2a4c95716087b21c8",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ],
    "managers" : [ ],
    "resourceManagers" : [ {
      "settings" : { },
      "firstName" : "strAuthor",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "strauthor@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "3cab41ad252e48a49631d1346d227a17",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    }, {
      "settings" : { },
      "firstName" : "strAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "stradmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "a0018341100c431d8a8117be2ad12d8a",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "group" : {
      "href" : "...",
      "title" : "A group"
    },
    "members" : [ {
      "href" : "...",
      "title" : "Users belonging to this group"
    } ],
    "managers" : {
      "href" : "..."
    },
    "resourceManagers" : {
      "href" : "..."
    }
  }
}
Relation Description

members

The members of this Group can be found at this link. This link is also used add/remove users from this group.

managers

The manager of this Group can be found at this link. This link is also used add/remove users from this group.

resourceManagers

The resource manager of this Group can be found at this link. This link is also used add/remove users from this group.

22.7. Remove resource manager from a group

To remove user from resource manager send PATCH request to remove the user from group manager.

22.7.1. Curl request

$ curl 'http://api.example.com/groups/GroupWithTwoResourceManagers0000' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "Team Amazing",
  "emailAddress" : "team.amazing@tenanta.nl",
  "phoneNumber" : "+31612345678",
  "members" : [ "http://api.example.com/users/vu48596abe224691a363a230ca1e291e", "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a", "http://api.example.com/users/91a3dc676abe2e623a2302469191e5ca" ],
  "resourceManagers" : [ "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a" ],
  "properties" : {
    "group.property1" : "value1",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property4" : "value4",
    "group.property5" : "value5"
  }
}'

22.7.2. HTTP request

PATCH /groups/GroupWithTwoResourceManagers0000 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 607
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "Team Amazing",
  "emailAddress" : "team.amazing@tenanta.nl",
  "phoneNumber" : "+31612345678",
  "members" : [ "http://api.example.com/users/vu48596abe224691a363a230ca1e291e", "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a", "http://api.example.com/users/91a3dc676abe2e623a2302469191e5ca" ],
  "resourceManagers" : [ "http://api.example.com/users/a0018341100c431d8a8117be2ad12d8a" ],
  "properties" : {
    "group.property1" : "value1",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property4" : "value4",
    "group.property5" : "value5"
  }
}

22.7.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Sat, 07 Jun 2025 21:16:23 GMT
Location: http://api.example.com/groups/GroupWithTwoResourceManagers0000
Content-Type: application/hal+json
Content-Length: 3644

{
  "name" : "Team Amazing",
  "properties" : {
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property1" : "value1",
    "group.property4" : "value4",
    "group.property5" : "value5"
  },
  "emailAddress" : {
    "email" : "team.amazing@tenanta.nl"
  },
  "phoneNumber" : "+31612345678",
  "uid" : "GroupWithTwoResourceManagers0000",
  "created_at" : "2025-06-07T23:16:23",
  "modified_at" : "2025-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "members" : [ {
      "settings" : { },
      "firstName" : "regular2",
      "lastName" : "user2",
      "middleName" : null,
      "emailAddress" : {
        "email" : "regularuser2@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "91a3dc676abe2e623a2302469191e5ca",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    }, {
      "settings" : { },
      "firstName" : "regular3",
      "lastName" : "user",
      "middleName" : null,
      "emailAddress" : {
        "email" : "regularuser3@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "vu48596abe224691a363a230ca1e291e",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    }, {
      "settings" : { },
      "firstName" : "strAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "stradmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "a0018341100c431d8a8117be2ad12d8a",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ],
    "managers" : [ ],
    "resourceManagers" : [ {
      "settings" : { },
      "firstName" : "strAdmin",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "stradmin@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "a0018341100c431d8a8117be2ad12d8a",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "group" : {
      "href" : "...",
      "title" : "A group"
    },
    "members" : [ {
      "href" : "...",
      "title" : "Users belonging to this group"
    } ],
    "managers" : {
      "href" : "..."
    },
    "resourceManagers" : {
      "href" : "..."
    }
  }
}

22.8. Group schema

The groups resource uses the following json-schema:

GET /profile/groups HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 1808

{
  "title" : "Group",
  "definitions" : {
    "emailAddress" : {
      "type" : "object",
      "properties" : {
        "email" : {
          "title" : "Email",
          "readOnly" : true,
          "type" : "string"
        }
      }
    }
  },
  "properties" : {
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "emailAddress" : {
      "title" : "Email address",
      "readOnly" : false,
      "type" : "object",
      "$ref" : "#/definitions/emailAddress"
    },
    "phoneNumber" : {
      "title" : "Phone number",
      "readOnly" : false,
      "type" : "string"
    },
    "members" : {
      "title" : "Members",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "name" : {
      "title" : "Name",
      "readOnly" : false,
      "type" : "string"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "resourceManagers" : {
      "title" : "Resource managers",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "managers" : {
      "title" : "Managers",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "properties" : {
      "title" : "Properties",
      "readOnly" : true,
      "type" : "object"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

22.9. List all groups

A GET request will list all the groups visible to the currently logged in user.

22.9.1. Curl request

$ curl 'http://api.example.com/groups' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

22.9.2. HTTP request

GET /groups HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

22.9.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 16047

{
  "_embedded" : {
    "groups" : [ {
      "name" : "Team with viewer groups",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "123a5c2af42b6775c6ea9b5a4f6b83f9",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Stream-tenAApplication1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : "abc789964",
      "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Team Null",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "514d4e9a834841699644c2420b439553",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Team Kad",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "514d4e9a834841869644c2ad8b439553",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Team Gone",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "514d4oit834841869644c2ad8b439553",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Team App Admins",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "514d4oit834841869644c2ad8b439997",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Team with env viewer group",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "5c25a483f9af4275c6eb67123f6baa9b",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Environment-tenantaenv22",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "66625b8c334d48ac88abff939e9cf453",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Stream-tenAApplication2",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "88eb98e0eff34fde923c15687e6d75d5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Environment-tenAenv1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "env_viewer_group",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "b446b5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Application-tenAApplication1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "application-viewer-group",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "g664g5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Team with two resource managers",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "GroupWithTwoResourceManagers0000",
      "created_at" : "2025-06-07T23:16:23",
      "modified_at" : "2025-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "stream_viewer_group",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "itad8484ppob4399983iu1869644c27",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 15,
    "totalPages" : 1,
    "number" : 0
  }
}
Relation Description

self

Link to current request.

profile

Link for schema metadata in ALPS/JSON Schema format

search

Link to search endpoint for the group

create

Existence of this link indicates that the currently authenticated user can create a Group

22.10. Create group

A POST request is used to create a new group. A group can only be created by a user having GROUP_ADMIN role.

22.10.1. Request fields

Path Type Description Constraints

name

String

The name of the group.

Must match the regular expression (?i)^[a-z0-9\.\-_ ]+$. Must not be empty. Size must be between 3 and 80 inclusive

members

Array

Users belonging to this group. This field would be absent if group has no members.

managers

Array

Managers of this group. This field would be absent if group has no managers.

resourceManagers

Array

Resource Managers of this group. This field will be absent if the group has no resource managers or if the tenant’s onlyResourceManagerCanUpdateAndDeploy setting is set to false.

emailAddress

String

Email address of this group. Optional.

properties

Object

A list of Group specific variables in Key,Value format.

phoneNumber

String

Phone number to contact this group. Optional.

Must be a valid phone number like +31612345678 or 0612345678.

22.10.2. Curl request

$ curl 'http://api.example.com/groups' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "Team Amazing",
  "emailAddress" : "team.amazing@tenanta.nl",
  "phoneNumber" : "+31612345678",
  "members" : [ "http://api.example.com/users/9e66c8d7cd5c4e509ec0fe840ef37c62" ],
  "properties" : {
    "group.property1" : "value1",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property4" : "value4",
    "group.property5" : "value5"
  }
}'

22.10.3. HTTP request

POST /groups HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 385
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "Team Amazing",
  "emailAddress" : "team.amazing@tenanta.nl",
  "phoneNumber" : "+31612345678",
  "members" : [ "http://api.example.com/users/9e66c8d7cd5c4e509ec0fe840ef37c62" ],
  "properties" : {
    "group.property1" : "value1",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property4" : "value4",
    "group.property5" : "value5"
  }
}

22.10.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 06:12:27 GMT
Location: http://api.example.com/groups/760b71b571cf47cab260bf1b1ad6861b
Content-Type: application/hal+json
Content-Length: 1826

{
  "name" : "Team Amazing",
  "properties" : {
    "group.property4" : "value4",
    "group.property5" : "value5",
    "group.property2" : "value2",
    "group.property3" : "value3",
    "group.property1" : "value1"
  },
  "emailAddress" : {
    "email" : "team.amazing@tenanta.nl"
  },
  "phoneNumber" : "+31612345678",
  "uid" : "760b71b571cf47cab260bf1b1ad6861b",
  "created_at" : "2025-06-25T08:12:27.020045937",
  "modified_at" : "2025-06-25T08:12:27.020045937",
  "created_by" : "tenadmin@tenanta.nl",
  "modified_by" : "tenadmin@tenanta.nl",
  "_embedded" : {
    "members" : [ {
      "settings" : { },
      "firstName" : "envAuthor",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "envauthor@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ],
    "managers" : [ ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "group" : {
      "href" : "...",
      "title" : "A group"
    },
    "members" : [ {
      "href" : "...",
      "title" : "Users belonging to this group"
    } ],
    "managers" : {
      "href" : "..."
    },
    "resourceManagers" : {
      "href" : "..."
    }
  }
}
Relation Description

members

The members of this Group can be found at this link. This link is also used add/remove users from this group.

managers

The manager of this Group can be found at this link. This link is also used add/remove users from this group.

resourceManagers

The resource manager of this Group can be found at this link. This link is also used add/remove users from this group.

22.11. Retrieve a group

A GET request on /groups/{id} will fetch the details of the group.

22.11.1. HTTP request

GET /groups/c339c5cf9b5a4f6b8342c6ea2f9b6775 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

22.11.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1564

{
  "name" : "Application-tenAApplication1",
  "properties" : { },
  "emailAddress" : null,
  "phoneNumber" : null,
  "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "members" : [ {
      "settings" : { },
      "firstName" : "appOwner",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "appowner@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "51234a7a81994d1ca35ca7894cde08c6",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ],
    "managers" : [ ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "group" : {
      "href" : "...",
      "title" : "A group"
    },
    "members" : [ {
      "href" : "...",
      "title" : "Users belonging to this group"
    } ],
    "managers" : {
      "href" : "..."
    },
    "resourceManagers" : {
      "href" : "..."
    }
  }
}

22.11.3. Response fields

Path Type Description

name

String

The name of the group.

uid

String

The uid of the group.

created_at

String

The created date of the group.

members

Array

Users belonging to this group. This field would be absent if group has no members.

managers

Array

Managers of this group. This field would be absent if group has no managers.

resourceManagers

Array

Resource Managers of this group. This field will be absent if the group has no resource managers or if the tenant’s onlyResourceManagerCanUpdateAndDeploy setting is set to false.
Relation Description

self

Link to current request.

group

Link to a group.

members

The members of this Group can be found at this link. This link is also used add/remove users from this group.

managers

The managers of this Group can be found at this link. This link is also used add/remove managers from this group.

resourceManagers

The resource manager of this Group can be found at this link. This link is also used add/remove resource managers from this group.

edit

Existence of this link indicates that the currently authenticated user can edit the Group

delete

Existence of this link indicates that the currently authenticated user can delete the Group

22.12. Update a Group

A PATCH request is used to update a Group. Below is an example where name of the group is modified.

$ curl 'http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "Team Medallion"
}'
PATCH /groups/c339c5cf9b5a4f6b8342c6ea2f9b6775 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 31
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "Team Medallion"
}
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 21:16:23 GMT
Location: http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775
Content-Type: application/hal+json
Content-Length: 1550

{
  "name" : "Team Medallion",
  "properties" : { },
  "emailAddress" : null,
  "phoneNumber" : null,
  "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "members" : [ {
      "settings" : { },
      "firstName" : "appOwner",
      "lastName" : "TenantA",
      "middleName" : null,
      "emailAddress" : {
        "email" : "appowner@tenanta.nl"
      },
      "phoneNumber" : null,
      "uid" : "51234a7a81994d1ca35ca7894cde08c6",
      "_links" : {
        "tenant" : {
          "href" : "...",
          "title" : "A tenant"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "user" : {
          "href" : "...",
          "templated" : true,
          "title" : "A user"
        }
      }
    } ],
    "managers" : [ ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "group" : {
      "href" : "...",
      "title" : "A group"
    },
    "members" : [ {
      "href" : "...",
      "title" : "Users belonging to this group"
    } ],
    "managers" : {
      "href" : "..."
    },
    "resourceManagers" : {
      "href" : "..."
    }
  }
}

22.13. Delete endpoints

Deleting group is a two-step process a GET request to check the constraints followed by the DELETE request

22.13.1. Delete group constraints

A GET request is used to get the constraints for deleting Group.

$ curl 'http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /groups/c339c5cf9b5a4f6b8342c6ea2f9b6775/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 102

{
  "canDelete" : false,
  "environmentsCount" : 0,
  "applicationsCount" : 39,
  "streamsCount" : 1
}

22.13.2. Delete group

A DELETE request is used to delete a Group.

$ curl 'http://api.example.com/groups/514d4oit834841869644c2ad8b439553' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
DELETE /groups/514d4oit834841869644c2ad8b439553 HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

22.14. Add user to group (Deprecated)

To add an existing user to a group, a POST request to the members link must be placed with the URI of the user in request body as shown below. The Content-Type header should be set to text/uri-list. To add multiple users in 1 request, specify multiple URIs in separate lines.

$ curl 'http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775/members' -i -X POST \
    -H 'Content-Type: text/uri-list;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d 'http://localhost/users/dc67596abe224691a363a230ca1e291e'
POST /groups/c339c5cf9b5a4f6b8342c6ea2f9b6775/members HTTP/1.1
Content-Type: text/uri-list;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 55
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

http://localhost/users/dc67596abe224691a363a230ca1e291e
HTTP/1.1 204 No Content

22.15. Replace existing users in group (Deprecated)

It is possible to replace all existing users of a group with new user by placing a PUT request to the members link. The request body should have the URI(s) of the users that must be added. Content-Type header must be text/uri-list. This operation will remove all existing users and replace with the user provided in the body.

This operation can be used to remove a single user. First fetch the current members array, then delete the user that should be removed from the array and finally send the PUT request with new array in request body.

$ curl 'http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775/members' -i -X PUT \
    -H 'Content-Type: text/uri-list' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d 'http://localhost/users/dc67596abe224691a363a230ca1e291e'
PUT /groups/c339c5cf9b5a4f6b8342c6ea2f9b6775/members HTTP/1.1
Content-Type: text/uri-list
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 55
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

http://localhost/users/dc67596abe224691a363a230ca1e291e
HTTP/1.1 204 No Content

22.16. Remove user from group (Deprecated)

To remove a single user from a group, send a DELETE request to /groups/gid/members/uid endpoint where gid is the UID of the group and uid is the UID of the user to be removed.

$ curl 'http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775/members/51234a7a81994d1ca35ca7894cde08c6' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
DELETE /groups/c339c5cf9b5a4f6b8342c6ea2f9b6775/members/51234a7a81994d1ca35ca7894cde08c6 HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content

22.17. Group search endpoints

22.17.1. /groups/search/findByName

Search for a group by exact name.

Parameter Description

name

Stream name to search for.

 
$ curl 'http://api.example.com/groups/search/findByName?name=tenanta-stream1' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 256

{
  "_embedded" : {
    "groups" : [ ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 0,
    "totalPages" : 0,
    "number" : 0
  }
}

22.17.2. /groups/search/findByNameContaining

Search for a group by name containing search term.

Parameter Description

name

Term to search within group name.

 
$ curl 'http://api.example.com/groups/search/findByNameContaining?name=group' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 4426

{
  "_embedded" : {
    "groups" : [ {
      "name" : "Team with viewer groups",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "123a5c2af42b6775c6ea9b5a4f6b83f9",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Team with env viewer group",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "5c25a483f9af4275c6eb67123f6baa9b",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "env_viewer_group",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "b446b5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "application-viewer-group",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "g664g5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "stream_viewer_group",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "itad8484ppob4399983iu1869644c27",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}

22.17.3. /groups/search/findByMembersContains

Search for a group by user having a valid URI of an existing User.

Parameter Description

user

A valid URI of a user

 
$ curl 'http://api.example.com/groups/search/findByMembersContains?user=http%3A%2F%2Flocalhost%2Fusers%2F007b994a6ab34165a93fd4c7a8db1388' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1126

{
  "_embedded" : {
    "groups" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "templated" : true,
          "title" : "A group"
        },
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ]
      },
      "name" : "Team Kad",
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "514d4e9a834841869644c2ad8b439553",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

23. Instances

An Instance represents a single installation of Axual Event Bus (AEB). An AEB instance is usually marked for a particular functionality like Acceptance testing, Load/Stress testing etc.

The instances collection resource is used to create and list Instances.

23.1. Instance Schema

The instances resource uses the following json-schema:

GET /profile/instances HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 7590

{
  "title" : "Instance",
  "definitions" : {
    "cACert" : {
      "type" : "object",
      "properties" : {
        "pem" : {
          "title" : "Pem",
          "readOnly" : false,
          "type" : "string"
        },
        "expiresOn" : {
          "title" : "Expires on",
          "readOnly" : false,
          "type" : "string",
          "format" : "date-time"
        }
      }
    },
    "instanceAuthenticationMethods" : {
      "type" : "object",
      "properties" : {
        "protocol" : {
          "title" : "Protocol",
          "readOnly" : false,
          "type" : "string"
        },
        "rank" : {
          "title" : "Rank",
          "readOnly" : true,
          "type" : "integer"
        },
        "mechanism" : {
          "title" : "Mechanism",
          "readOnly" : false,
          "type" : "string",
          "enum" : [ "MUTUAL_TLS", "SCRAM_SHA_256", "SCRAM_SHA_512", "OAUTH_BEARER", "PLAIN" ]
        }
      }
    },
    "ksmlProvisioner" : {
      "type" : "object",
      "properties" : {
        "uid" : {
          "title" : "Uid",
          "readOnly" : true,
          "type" : "string"
        },
        "schemaRegistryUrlOverride" : {
          "title" : "Schema registry url override",
          "readOnly" : false,
          "type" : "string"
        },
        "name" : {
          "title" : "Name",
          "readOnly" : false,
          "type" : "string"
        },
        "modified_by" : {
          "title" : "Modified by",
          "readOnly" : false,
          "type" : "string"
        },
        "created_at" : {
          "title" : "Created at",
          "readOnly" : true,
          "type" : "string",
          "format" : "date-time"
        },
        "bootstrapUrlOverride" : {
          "title" : "Bootstrap url override",
          "readOnly" : false,
          "type" : "string"
        },
        "modified_at" : {
          "title" : "Modified at",
          "readOnly" : false,
          "type" : "string",
          "format" : "date-time"
        },
        "created_by" : {
          "title" : "Created by",
          "readOnly" : true,
          "type" : "string"
        },
        "url" : {
          "title" : "Url",
          "readOnly" : false,
          "type" : "string"
        }
      }
    },
    "instanceCluster" : {
      "type" : "object",
      "properties" : {
        "cluster" : {
          "title" : "Cluster",
          "readOnly" : false,
          "type" : "string",
          "format" : "uri"
        },
        "uid" : {
          "title" : "Uid",
          "readOnly" : true,
          "type" : "string"
        },
        "ksmlUrl" : {
          "title" : "Ksml url",
          "readOnly" : true,
          "type" : "object"
        },
        "schemaRegistryUrls" : {
          "title" : "Schema registry urls",
          "readOnly" : false,
          "type" : "string"
        },
        "distributionConfig" : {
          "title" : "Distribution config",
          "readOnly" : false,
          "type" : "object"
        },
        "srProperties" : {
          "title" : "Sr properties",
          "readOnly" : false,
          "type" : "object"
        },
        "singleKsmlProvisioner" : {
          "title" : "Single ksml provisioner",
          "readOnly" : true,
          "type" : "object"
        },
        "ksmlProvisioners" : {
          "title" : "Ksml provisioners",
          "readOnly" : false,
          "type" : "array",
          "uniqueItems" : true,
          "items" : {
            "$ref" : "#/definitions/ksmlProvisioner"
          }
        },
        "instanceClusterSrListener" : {
          "title" : "Instance cluster sr listener",
          "readOnly" : false,
          "type" : "object"
        },
        "schemaRegistryVersion" : {
          "title" : "Schema registry version",
          "readOnly" : false,
          "type" : "string"
        },
        "schemaRegistryType" : {
          "title" : "Schema registry type",
          "readOnly" : false,
          "type" : "string",
          "enum" : [ "Apicurio", "Confluent" ]
        },
        "srKeycloakDetails" : {
          "title" : "Sr keycloak details",
          "readOnly" : false,
          "type" : "object"
        }
      }
    }
  },
  "properties" : {
    "connectCerts" : {
      "title" : "Connect certs",
      "readOnly" : false,
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "$ref" : "#/definitions/cACert"
      }
    },
    "settings" : {
      "title" : "Settings",
      "readOnly" : true,
      "type" : "object"
    },
    "ksmlUrl" : {
      "title" : "Ksml url",
      "readOnly" : true,
      "type" : "object"
    },
    "ksmlEnabled" : {
      "title" : "Ksml enabled",
      "readOnly" : true,
      "type" : "boolean"
    },
    "environmentMapping" : {
      "title" : "Environment mapping",
      "readOnly" : false,
      "type" : "boolean"
    },
    "ksmlProvisioner" : {
      "title" : "Ksml provisioner",
      "readOnly" : true,
      "type" : "object"
    },
    "description" : {
      "title" : "Description",
      "readOnly" : false,
      "type" : "string"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "connectLoggingSupportEnabled" : {
      "title" : "Connect logging support enabled",
      "readOnly" : false,
      "type" : "boolean"
    },
    "connectUrls" : {
      "title" : "Connect urls",
      "readOnly" : false,
      "type" : "string"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "enabledAuthenticationMethods" : {
      "title" : "Enabled authentication methods",
      "readOnly" : false,
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "$ref" : "#/definitions/instanceAuthenticationMethods"
      }
    },
    "instanceClusters" : {
      "title" : "Instance clusters",
      "readOnly" : false,
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "$ref" : "#/definitions/instanceCluster"
      }
    },
    "supportTier" : {
      "title" : "Support tier",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "selfApprovalEnabled" : {
      "title" : "Self approval enabled",
      "readOnly" : true,
      "type" : "boolean"
    },
    "name" : {
      "title" : "Name",
      "readOnly" : false,
      "type" : "string"
    },
    "connectEnabled" : {
      "title" : "Connect enabled",
      "readOnly" : false,
      "type" : "boolean"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "granularBrowsePermission" : {
      "title" : "Granular browse permission",
      "readOnly" : false,
      "type" : "boolean"
    },
    "shortName" : {
      "title" : "Short name",
      "readOnly" : false,
      "type" : "string"
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "properties" : {
      "title" : "Properties",
      "readOnly" : false,
      "type" : "object"
    },
    "caCerts" : {
      "title" : "Ca certs",
      "readOnly" : false,
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "$ref" : "#/definitions/cACert"
      }
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

23.2. List all instances

A GET request will list all the Instances available.

23.2.1. Curl request

$ curl 'http://api.example.com/instances' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.2.2. HTTP request

GET /instances HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.2.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 13757

{
  "_embedded" : {
    "instances" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "supportTier" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "TenantA OTA2",
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : null,
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE",
        "environmentMapping" : "true"
      },
      "enabledAuthenticationMethods" : [ {
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256",
        "rank" : 0
      }, {
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS",
        "rank" : 1
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "Zone2ClusterOTA",
          "tenant" : null,
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ]
        },
        "schemaRegistryUrls" : "https://schema.local6"
      } ],
      "shortName" : "ota2",
      "description" : "Second TenantA OTA Instance",
      "uid" : "6e37bcf4d4a44334924aa0f961286668",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "supportTier" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "TenantA OTA",
      "settings" : {
        "environmentMapping" : "true",
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE",
        "topicOwnerBrowsePermission" : "true"
      },
      "enabledAuthenticationMethods" : [ {
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS",
        "rank" : 0
      }, {
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256",
        "rank" : 1
      }, {
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER",
        "rank" : 2
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "Zone1ClusterOTA",
          "tenant" : null,
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ]
        },
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2"
      }, {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "Zone2ClusterOTA",
          "tenant" : null,
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ]
        },
        "schemaRegistryUrls" : "https://schema.local3"
      } ],
      "shortName" : "ota",
      "description" : "TenantA OTA Instance",
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "supportTier" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "TenantA Prod",
      "settings" : {
        "connectEnabled" : "false",
        "granularBrowsePermission" : "false",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "TENANT",
        "environmentMapping" : "true"
      },
      "enabledAuthenticationMethods" : [ {
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS",
        "rank" : 0
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "Zone1ClusterPROD",
          "tenant" : null,
          "uid" : "db0766d053ca46d59b0a1af2817c535a",
          "providerType" : "apache-kafka",
          "topicPattern" : null,
          "groupPattern" : null,
          "transactionalPattern" : null,
          "bootstrapServers" : [ ]
        },
        "schemaRegistryUrls" : "https://schema.local4"
      } ],
      "shortName" : "prod",
      "description" : "TenantA Prod Instance",
      "uid" : "f6969bd9f3f7435aa6bc6c62cb960393",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "supportTier" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "TenantA LST",
      "settings" : {
        "connectEnabled" : "false",
        "granularBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "INSTANCE",
        "environmentMapping" : "false"
      },
      "enabledAuthenticationMethods" : [ {
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS",
        "rank" : 0
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "Zone2ClusterOTA",
          "tenant" : null,
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ]
        },
        "schemaRegistryUrls" : "https://schema.local7"
      } ],
      "shortName" : "lst",
      "description" : "TenantA LST Instance",
      "uid" : "g7969bd9f3f7435aa6bc6c62cb960304",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "supportTier" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "TenantA Multi KSML",
      "settings" : {
        "connectEnabled" : "false",
        "granularBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "INSTANCE",
        "environmentMapping" : "false"
      },
      "enabledAuthenticationMethods" : [ {
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS",
        "rank" : 0
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "multiClusterKsmlCluster00",
          "tenant" : null,
          "uid" : "multi-cluster-ksml-cluster000000",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ]
        },
        "schemaRegistryUrls" : null
      }, {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "multiClusterKsmlCluster01",
          "tenant" : null,
          "uid" : "multi-cluster-ksml-cluster000001",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ]
        },
        "schemaRegistryUrls" : null
      } ],
      "shortName" : "multiClstrKsmlInst",
      "description" : "TenantA multi-cluster-ksml-instance0000 Instance",
      "uid" : "multi-cluster-ksml-instance00000",
      "created_at" : "2024-06-07T23:16:23",
      "modified_at" : "2024-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "supportTier" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "TenantA KSML",
      "settings" : {
        "connectEnabled" : "false",
        "granularBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE",
        "environmentMapping" : "false"
      },
      "enabledAuthenticationMethods" : [ {
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS",
        "rank" : 0
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "singleClusterKsmlCluster",
          "tenant" : null,
          "uid" : "single-cluster-ksml-cluster00000",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ]
        },
        "schemaRegistryUrls" : null
      } ],
      "shortName" : "ksmlinst",
      "description" : "TenantA single-cluster-ksml-instance0000 Instance",
      "uid" : "single-cluster-ksml-instance0000",
      "created_at" : "2024-06-07T23:16:23",
      "modified_at" : "2024-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 6,
    "totalPages" : 1,
    "number" : 0
  }
}
Relation Description

create

Existence of create link indicates that currently authenticated user can create new Instance.

23.3. Get Schema Registry details for Instance Cluster

A GET request is used to create a schema registry details for an instance cluster.

23.3.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478/clusters/66c12e25ab06458eac988f0d700fbe81/schema-registry' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.3.2. HTTP request

GET /instances/b9301e9144324928911f7d83ec40c478/clusters/66c12e25ab06458eac988f0d700fbe81/schema-registry HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.3.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 998

{
  "url" : "http://sr:8081",
  "schemaRegistryType" : "apicurio",
  "credentials" : {
    "authenticationType" : "Basic-Auth",
    "certificate" : null,
    "privateKey" : null,
    "username" : "Username",
    "password" : "",
    "truststore" : null
  },
  "keycloakDetails" : {
    "url" : "http://podman-daemon.gitlab.svc:30033",
    "masterRealm" : "master",
    "adminUsername" : "admin",
    "adminPassword" : null,
    "adminClientId" : "admin-cli",
    "apicurioRealm" : "apicurio"
  },
  "schemaRegistryVersion" : "2.0",
  "listeners" : {
    "Conflunt SerDes" : "HTTPS://some-url",
    "Apicurio SerDes" : "HTTPS://some-url",
    "key" : "value"
  },
  "properties" : {
    "key" : "value"
  },
  "skipFields" : null,
  "srCredentialsModified" : true,
  "keycloakDetailsModified" : true,
  "_links" : {
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "cluster" : {
      "href" : "...",
      "title" : "A cluster"
    }
  }
}

23.4. Create instance

A POST request is used to create an instance. The request should have at-least one existing Cluster URI.

Please note that in case duplicated PEMs are provided for caCerts or connectCerts attributes, or duplicated authentication methods are provided for the enabledAuthenticationMethods attribute, you will not get any validation error and the server will internally handle the duplicated items.

23.4.1. Request fields

Path Type Description Constraints

name

String

The name of the instance.

Must match the regular expression (?i)^[a-z0-9\.\-_ ]+$. Must not be empty. Size must be between 3 and 50 inclusive

shortName

String

A short name of the instance.

Must match the regular expression (?i)^[a-z][a-z0-9]*$. Must not be empty. Size must be between 1 and 12 inclusive

description

String

A short text summarizing the purpose of the instance.

Size must be between 0 and 200 inclusive

connectEnabled

Boolean

A toggle to enable/disable connect on this instance. When connect is enabled, a valid connectUrl needs to be provided in order to create a Connect.

ksmlEnabled

Boolean

A toggle to enable/disable KSML on this instance. When KSML is enabled, a valid ksmlUrl needs to be provided.

instanceClusters

Array

An array of cluster objects for the instance. Each cluster object contains cluster’s URI

Must not be null

caCerts

Array

Collection of CA certificates that should be in the chain of client certificates used for produce/consume. These CA certificates are also used to talk to Schema Registry when browsing the stream

supportTier

String

A valid URI of Support Tier for the instance

enabledAuthenticationMethods

Array

A list of enabled authentication methods. If not specified, the default value is SSL.

Must not be empty. Must not be null

properties

Object

A list of Instance specific variables in Key,Value format.

environmentMapping

Boolean

Enable/disable mapping an environment to the instance. When set to false, the instance cannot have mapped environments. If not specified, the default value is true.

selfApproval

Boolean

Enable/disable self approval to the instance. When set to false, the application access grant cannot be self approved by same requested user. If not specified, the default value is true.

granularBrowsePermission

Boolean

Enable/disable granular browse permissions to the instance. When set to false, it will not be possible to configure fine-grained browse permission to a stream in the instance. granularBrowsePermission is set to false by default.

topicOwnerBrowsePermission

Boolean

Allow/disallow Topic Owner to browse their streams irrespectively of the Granular Browse Permissions. When set to true, Topic Owner will always allow to browse their streams in the instance. topicOwnerBrowsePermission is set to false by default.

certificateReusePreventionLevel

String

A configuration to set certificate reuse prevention level. The possible values are NONE, INSTANCE and TENANT. By default it’s set to NONE which means there is no restriction for this instance to reuse certificates.When set to INSTANCE each certificate must be unique within the Instance scope.When set to TENANT each certificate must be unique within the Tenant scope

23.4.2. Curl request

$ curl 'http://api.example.com/instances' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "AEB LST",
  "description" : "AEB Load Stress Testing Instance",
  "instanceClusters" : [ {
    "cluster" : "http://api.example.com/clusters/f2e75fe2226745bea34ea9f56621f78f"
  } ],
  "supportTier" : "http://api.example.com/supportTiers/14cadc6238fc4695916a8053302743f5",
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----\n"
  } ],
  "enabledAuthenticationMethods" : [ {
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  } ],
  "shortName" : "aeblst",
  "connectEnabled" : false,
  "ksmlEnabled" : false,
  "environmentMapping" : true,
  "granularBrowsePermission" : true,
  "certificateReusePreventionLevel" : "NONE"
}'

23.4.3. HTTP request

POST /instances HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 2561
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "AEB LST",
  "description" : "AEB Load Stress Testing Instance",
  "instanceClusters" : [ {
    "cluster" : "http://api.example.com/clusters/f2e75fe2226745bea34ea9f56621f78f"
  } ],
  "supportTier" : "http://api.example.com/supportTiers/14cadc6238fc4695916a8053302743f5",
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----\n"
  } ],
  "enabledAuthenticationMethods" : [ {
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  } ],
  "shortName" : "aeblst",
  "connectEnabled" : false,
  "ksmlEnabled" : false,
  "environmentMapping" : true,
  "granularBrowsePermission" : true,
  "certificateReusePreventionLevel" : "NONE"
}

23.4.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
location: http://api.example.com/instances/6a64ed31534f4080a37cc6ff7ffe2063
Content-Type: application/hal+json
Content-Length: 5193

{
  "uid" : "6a64ed31534f4080a37cc6ff7ffe2063",
  "properties" : { },
  "name" : "AEB LST",
  "description" : "AEB Load Stress Testing Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : null,
    "providerInfo" : { },
    "schemaRegistryType" : null,
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----\n",
    "expiresOn" : "2038-05-24T10:34:14"
  } ],
  "connectCerts" : [ ],
  "shortName" : "aeblst",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  } ],
  "tenant" : {
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : false,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : null,
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : false,
  "selfApproval" : true,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : null,
  "instanceClusterSRListeners" : [ ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.5. Instance properties

Every instance object holds certain important properties that apply to every stream that ends up on this instance. These are explained below:

23.5.1. replication.factor

Number of replicas maintained by Kafka for each stream. Default value is 1.

23.5.2. num.partitions

Number of partitions created by Kafka for each stream. Default value is 2.

23.5.3. cleanup.policy

Policy used to clean up segments beyond the retention window. Possible values are delete, compact. Default value is delete.

23.5.4. min.insync.replicas

The number of in-sync replicas that must be available before a produce is considered successful. Default value is 1.

23.5.5. segment.ms

Time duration after which Kafka will force the log to roll even if the segment file isn’t full. Default value is 86400s.

23.5.6. create-stream.disable-time

Time duration after which Management API will allow recreating a stream-config that has been deleted previously. Default value is 0, time unit is minutes.

23.6. Create Distribution Config for Instance Cluster

A POST request is used to create a distribution config for an instance cluster.

23.6.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478/clusters/543c3b7d55634eba83b1472775c131c4/distribution' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "distributionUrl" : "http://localhost:62226",
  "kafkaCredentials" : {
    "authenticationType" : "MTLS",
    "certificate" : "-----BEGIN CERTIFICATE-----\r\nMIIFhjCCA26gAwIBAgICECwwDQYJKoZIhvcNAQELBQAwKzEpMCcGA1UEAwwgQXh1\r\nYWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEwHhcNMTkwNjEzMTQwNTMyWhcN\r\nMjExMTI5MTQwNTMyWjBjMQswCQYDVQQGEwJOTDEQMA4GA1UECAwHVXRyZWNodDEQ\r\nMA4GA1UEBwwHVXRyZWNodDEOMAwGA1UECgwFQXh1YWwxDjAMBgNVBAsMBUF4dWFs\r\nMRAwDgYDVQQDDAd0ZXN0IENOMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKC\r\nAgEAnZaQX6aDGnNsua3DNlV/RI8BmjvpFaqOWNmWQYive6w8BTciuq+EeVUM6SGc\r\nST4YCFsuNFQjxYCiGMzFBp1kBWOY/x255MVik/zlcSZgSIqr2zikyR/9d9F9QEQr\r\nUXPthu3UwLXWJu+itfiOKDb5a2SY512MXaUDNntiZdSoL9IzV3vKOxNibyT3Ldmc\r\nf4FvBpF3cH+/SFjWi7Nu7u6xqQDotm/u3S61XaFlenTHwHvNezLtSU7xVFoFOGk+\r\nC0OTfLFXcEeRPujTpDC15PweBwlnwmmj7QjmJYI6Eq1dJ5JW5rrHLO1qYqZtfyG3\r\nl1PsGpxWHNJGTIyNjbQzcjdCCZBSdEVnICAU6m4RG33EXkjExPerlEhCcw8D703r\r\nWB8fgBc1n3wM/NZ3YXsHxTIcBTYFeIAzs3sGDKZ4cjxzktFIAUQ5aIMj9vc95et8\r\nTE8EiVpDDbL0SppmSawoA+/U+sx7t8Hh9m/HnGNAIULuj4CWYqvgM2/4ptSdpQfl\r\nzCKe4Hp1ACfcuOs/O5sj0PhosdOHKoLFki+Bf+wL5I83VpNnDHuEZ+zNF83JdcWL\r\ncd5hWWZ+EcW9GO3ITUKvBwKTKWB9wHCdyuAUTj6UrF1X4PYMvV5rK081gguefJH9\r\nh9RlBWy+5JDU2j7nt1Jrl4CM1v73LftCKmCC6bF8wPfl34MCAwEAAaN8MHowCQYD\r\nVR0TBAIwADAdBgNVHQ4EFgQUbFnI40k82TldvwpXAmngw+Gy4OYwHwYDVR0jBBgw\r\nFoAUa9IpV4tSNiwFCsZXuRp0eKwTH2YwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQW\r\nMBQGCCsGAQUFBwMBBggrBgEFBQcDAjANBgkqhkiG9w0BAQsFAAOCAgEAlMAVbb+M\r\nKx6ej6boH27b5fSZGCiXEanQ0u8uO1DeLJsagYwsb9EsCLQpVc5+M+rhMk++yVvr\r\n2Yb+UkTWfWcUwTcfLk3TEYe8X/8zqY+uDJOumNpSIgyF0kPeQ9KGNjaCZLa87Npb\r\n0dvXIabohJlEMGJt2/cAK19keC5VbxwKeSk95RUiSwgE8K4DbtyFUIIy8a1y+Mwu\r\nvlfIz/FVgQWlWjSZ0NUx7/oKgznDg5oRjiuD6yYM084soiW3RgxGQ/sxqUXJyc++\r\nFU3xwO3mVX1tjry/d42KRSxsLpM2+jAXawwzRWFjuFUExl1i1OgaGtU33MRo6siO\r\n0BPal3eBC5I7rGb8GOuYQmO5QLPpj8+sxCzqzKQOZ9ATLvdjM6v9EiRp5nuTXFh4\r\nV07qQ4hxs4KeRz9Oig5VpnHQ8/SGWFPV2TgEnPr3Lu6knNjvI8O9wwo1mF/Q3yUc\r\nHE1YdLJ9ctJ2KHbsPpWDO4Zk7+6LejkbscYzEOA2pUlQzpv1rZmOQcnhnhKHlppK\r\ni5ogPiczSIdmOqQ1jQNS7hzdWZCxpGdjsXtVrYRFUDRv9vqHieBSzuh/GI/PvW7d\r\nPNRKkMlItv+C4UczOBM1y3kMsHwFSvFfC++TBlA4PkSmtpgnMAXePUlck6H8irtD\r\naqeURSylqc7U1W1KbsDpI97UCxbVZnFPMhE=\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\r\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\r\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\r\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\r\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\r\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\r\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\r\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\r\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\r\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\r\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\r\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\r\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\r\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\r\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\r\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\r\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\r\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\r\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\r\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\r\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\r\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\r\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\r\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\r\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\r\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\r\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\r\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\r\n-----END CERTIFICATE-----\r\n",
    "privateKey" : "-----BEGIN PRIVATE KEY-----\r\nMIIJQQIBADANBgkqhkiG9w0BAQEFAASCCSswggknAgEAAoICAQCdlpBfpoMac2y5\r\nrcM2VX9EjwGaO+kVqo5Y2ZZBiK97rDwFNyK6r4R5VQzpIZxJPhgIWy40VCPFgKIY\r\nzMUGnWQFY5j/HbnkxWKT/OVxJmBIiqvbOKTJH/130X1ARCtRc+2G7dTAtdYm76K1\r\n+I4oNvlrZJjnXYxdpQM2e2Jl1Kgv0jNXe8o7E2JvJPct2Zx/gW8GkXdwf79IWNaL\r\ns27u7rGpAOi2b+7dLrVdoWV6dMfAe817Mu1JTvFUWgU4aT4LQ5N8sVdwR5E+6NOk\r\nMLXk/B4HCWfCaaPtCOYlgjoSrV0nklbmuscs7Wpipm1/IbeXU+wanFYc0kZMjI2N\r\ntDNyN0IJkFJ0RWcgIBTqbhEbfcReSMTE96uUSEJzDwPvTetYHx+AFzWffAz81ndh\r\newfFMhwFNgV4gDOzewYMpnhyPHOS0UgBRDlogyP29z3l63xMTwSJWkMNsvRKmmZJ\r\nrCgD79T6zHu3weH2b8ecY0AhQu6PgJZiq+Azb/im1J2lB+XMIp7genUAJ9y46z87\r\nmyPQ+Gix04cqgsWSL4F/7AvkjzdWk2cMe4Rn7M0Xzcl1xYtx3mFZZn4Rxb0Y7chN\r\nQq8HApMpYH3AcJ3K4BROPpSsXVfg9gy9XmsrTzWCC558kf2H1GUFbL7kkNTaPue3\r\nUmuXgIzW/vct+0IqYILpsXzA9+XfgwIDAQABAoICAA3yTUSpz+B/ZpfoMOaWGnVO\r\n0q17r90jAwYJ+6pBFoazb3xmrMQo1GiIhmP7fYFd5XKX3zbyW1gXUkEvniA/vaJc\r\ndiXd053Tei3uq7+fzdWdsCfuk2bZVe1MtPEDF3JV+CeA1NtZPGKlwpioLqyQcPJ4\r\nLLANL2b6O5aOxN6OO3Q//hs38WXZCVUcyGNeZuNB6TmDljZ2l88nTZV/g8nRhheW\r\n5QGAVntsrtBigECeJS97xWupziY2vlTgwqWDauJEUMEwULS3ILuYj2JwjSh+x4mH\r\n447pGoDX0MZxCAKvJRdjdB1nWkk3mbqxT+94ZG8YFkUkoNpcIayUo9JuqD7rdQSP\r\n/PyxYgy7jmKh0flINuqdgwVZpz/8hjrGOfufYPrNfAZqjan1zt8hDQTyTI0V8Ngc\r\nXzSWMVddXObPyOrdlBbJRHvhQ5lpIh/TKqAURCKptpSarLdcwlQqiru6leDCNAwv\r\nAUPQ/212MrSl59p5T9RdvxikOfhFDalYcl3xywSjZowwRuSzgYXpRr8STKxxzlGB\r\nvO4rQYHPzdP3JvytFqPghSNSVt+M6qu1ph6ou70YHSpVuocvB5+6iHDDgr0vrSXE\r\nawm4EOSEI+J9F5/YkIE1UtOI6Aj5HHguAWJXBj0ZGiv/bpAVNr+eTx1Ga9qM8nx4\r\n/2LxlF0urRWZw+qfXL3BAoIBAQDaI0L8k460PSUVF/dL5jwqvSPZey+piHJGWfBr\r\n5wWslDYn/ABJYKj3NYFF4WDvnabXa8qTmxGOvMuwAwpkp3iEY7MB651tJ26CSCQ4\r\nYSYwYve/uuhlfQhtFiEihbj9jPebWJK1mQTU+SMOrxWU6UfkFTtsBqnB1ewAorWg\r\nAbqICUoW4Up10GOAsKRaRu6vhbReTRjM6/G2d3WlFiVsroVPbJeAAWCM7StQaio+\r\nUKfDJwv8TTC6nPLiYjXfwCLhMSmmD89rreWh8MvVefNTQ4sHcdLJe7reWYxYgOQ3\r\nXokPFDkbUOqZ1vwahDADYzzI0Nc0YgZW5vR8aYJkhnr7IzUlAoIBAQC48Nb2QXdl\r\ns9WUzCkKqhonUJhv5+85HIzE7EwnBaNgPAV+whLc1RHYXYGbIXmwZnGPW9gO8E9a\r\nnoVCCOLKEofhDQnbOH0xucESsGe1CeTj9gjlr0ASxqp7C2EnDBOBbd2g1KGX+IER\r\ny4YD3D1qeegG/Sntdh4G2x7W/omHRkz+uZ9EuJDd6VBZZwckGJ0kv4iUBAxn1BtL\r\ngTkFJwManqrQd/4Ceh4osUlXgmpMgjZWzXA+i2jrZh4uWTvvUFEh/GsAqVhXcrHS\r\nEkSTB8pVRmXq5WIefPNkQqfoXX3aa0KYgPK8TpJWu/oqzPLCzP12ioCFNDsFIx8o\r\ngFIqSniwhKWHAoIBACdMmQHmF5yTM34UXkI3TXmpr667yb9yTJwuEeluqpAH96XG\r\necq+dlJrOkn7q7ofnfJLgiiLlGMx0kR4l8PAhC7dw19CMo96vicMljHuFrI68kWB\r\nh+LY3s7AYOHWU5iib+11zKCY28z+wXkgw/Oa/4+w3467uJOqVaVbqvsTtKZTfhyX\r\nJBILpBGIQWPeSZwnq3Id06z/iQGFjhVa4w0sd+nyN20hUmKxS89mAQxO/ZpkC329\r\n7lyAcCWm6evQsrf9YnJ/gK/2mVtOhXqFSPgkQATsVbxk5Sqv2WAMgJEVH/4ud4db\r\nUZi7qZmhXQEPPOE09sCCNIAthbhwTcSMkdVy510CggEAQr3PpdEcaJyMsIU5LnsS\r\nsyt3x7LY9zBhcNOh69cyDZG7nfIl4oIWTZH5KuXax5lA1C6d+04oJRjeGGWiirBD\r\nTylobC+npqFVlwwIcSIf81CgB1vGcMA3V+5UYkYOaAAhImB57KEm2ygqtgvuMhXK\r\ncXM9hU/CKFE9gPMc6K+rK6YLXz6IMT143Lq8rf8f/toMTPZlD7dRHl+FF2Hr0dh+\r\n5nrXNUeiyKaqRCVxfSjkuVCseDXRaFpS/AECCyxeCzjP2M5EblKa76feDX2bPEkK\r\nkMm1LjGDmKQhek77Ey7wOp8WenSUhS6TaozJ8xkNQ5FaLjgaMJFrNi+Q92gmw/Uq\r\n0wKCAQA7eo+Wz6VBg7i//jrVaZl7MqmuqpaID6vXpAbmjU5BGEoOzxK9cIS0AMsL\r\npY5QzwQb+y9S35qpkaXsgndlyvdMBq58e5NN+Z8WEULuO85CW3rD6e1rWlXx6M3Y\r\nLFSKJQUjQ63FQJ+LX8nHylDkV/9T/sCFiYa1zv3AW2c7rz8eqXP9MabptpMqRfwZ\r\nUVlECszO2xb3zwg7WEnZu+DBNKsTIrKT8w/h3KvvWRbORpDOYcjW64V2NnjBP6Pc\r\nCUE2QsYVDOG/UDXjNanf3DnMCVVMJn06p+HQCDlATFnScu1qo++A7Dj4HTWmDtiU\r\nDsbI3yNePnNb5x1AZjii68cy9pLG\r\n-----END PRIVATE KEY-----"
  },
  "connectCredentials" : {
    "authenticationType" : "basic_auth",
    "username" : "test",
    "password" : "test123"
  },
  "properties" : {
    "description" : "Nice"
  }
}'

23.6.2. HTTP request

POST /instances/b9301e9144324928911f7d83ec40c478/clusters/543c3b7d55634eba83b1472775c131c4/distribution HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 7773
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "distributionUrl" : "http://localhost:62226",
  "kafkaCredentials" : {
    "authenticationType" : "MTLS",
    "certificate" : "-----BEGIN CERTIFICATE-----\r\nMIIFhjCCA26gAwIBAgICECwwDQYJKoZIhvcNAQELBQAwKzEpMCcGA1UEAwwgQXh1\r\nYWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEwHhcNMTkwNjEzMTQwNTMyWhcN\r\nMjExMTI5MTQwNTMyWjBjMQswCQYDVQQGEwJOTDEQMA4GA1UECAwHVXRyZWNodDEQ\r\nMA4GA1UEBwwHVXRyZWNodDEOMAwGA1UECgwFQXh1YWwxDjAMBgNVBAsMBUF4dWFs\r\nMRAwDgYDVQQDDAd0ZXN0IENOMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKC\r\nAgEAnZaQX6aDGnNsua3DNlV/RI8BmjvpFaqOWNmWQYive6w8BTciuq+EeVUM6SGc\r\nST4YCFsuNFQjxYCiGMzFBp1kBWOY/x255MVik/zlcSZgSIqr2zikyR/9d9F9QEQr\r\nUXPthu3UwLXWJu+itfiOKDb5a2SY512MXaUDNntiZdSoL9IzV3vKOxNibyT3Ldmc\r\nf4FvBpF3cH+/SFjWi7Nu7u6xqQDotm/u3S61XaFlenTHwHvNezLtSU7xVFoFOGk+\r\nC0OTfLFXcEeRPujTpDC15PweBwlnwmmj7QjmJYI6Eq1dJ5JW5rrHLO1qYqZtfyG3\r\nl1PsGpxWHNJGTIyNjbQzcjdCCZBSdEVnICAU6m4RG33EXkjExPerlEhCcw8D703r\r\nWB8fgBc1n3wM/NZ3YXsHxTIcBTYFeIAzs3sGDKZ4cjxzktFIAUQ5aIMj9vc95et8\r\nTE8EiVpDDbL0SppmSawoA+/U+sx7t8Hh9m/HnGNAIULuj4CWYqvgM2/4ptSdpQfl\r\nzCKe4Hp1ACfcuOs/O5sj0PhosdOHKoLFki+Bf+wL5I83VpNnDHuEZ+zNF83JdcWL\r\ncd5hWWZ+EcW9GO3ITUKvBwKTKWB9wHCdyuAUTj6UrF1X4PYMvV5rK081gguefJH9\r\nh9RlBWy+5JDU2j7nt1Jrl4CM1v73LftCKmCC6bF8wPfl34MCAwEAAaN8MHowCQYD\r\nVR0TBAIwADAdBgNVHQ4EFgQUbFnI40k82TldvwpXAmngw+Gy4OYwHwYDVR0jBBgw\r\nFoAUa9IpV4tSNiwFCsZXuRp0eKwTH2YwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQW\r\nMBQGCCsGAQUFBwMBBggrBgEFBQcDAjANBgkqhkiG9w0BAQsFAAOCAgEAlMAVbb+M\r\nKx6ej6boH27b5fSZGCiXEanQ0u8uO1DeLJsagYwsb9EsCLQpVc5+M+rhMk++yVvr\r\n2Yb+UkTWfWcUwTcfLk3TEYe8X/8zqY+uDJOumNpSIgyF0kPeQ9KGNjaCZLa87Npb\r\n0dvXIabohJlEMGJt2/cAK19keC5VbxwKeSk95RUiSwgE8K4DbtyFUIIy8a1y+Mwu\r\nvlfIz/FVgQWlWjSZ0NUx7/oKgznDg5oRjiuD6yYM084soiW3RgxGQ/sxqUXJyc++\r\nFU3xwO3mVX1tjry/d42KRSxsLpM2+jAXawwzRWFjuFUExl1i1OgaGtU33MRo6siO\r\n0BPal3eBC5I7rGb8GOuYQmO5QLPpj8+sxCzqzKQOZ9ATLvdjM6v9EiRp5nuTXFh4\r\nV07qQ4hxs4KeRz9Oig5VpnHQ8/SGWFPV2TgEnPr3Lu6knNjvI8O9wwo1mF/Q3yUc\r\nHE1YdLJ9ctJ2KHbsPpWDO4Zk7+6LejkbscYzEOA2pUlQzpv1rZmOQcnhnhKHlppK\r\ni5ogPiczSIdmOqQ1jQNS7hzdWZCxpGdjsXtVrYRFUDRv9vqHieBSzuh/GI/PvW7d\r\nPNRKkMlItv+C4UczOBM1y3kMsHwFSvFfC++TBlA4PkSmtpgnMAXePUlck6H8irtD\r\naqeURSylqc7U1W1KbsDpI97UCxbVZnFPMhE=\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\r\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\r\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\r\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\r\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\r\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\r\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\r\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\r\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\r\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\r\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\r\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\r\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\r\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\r\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\r\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\r\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\r\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\r\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\r\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\r\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\r\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\r\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\r\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\r\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\r\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\r\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\r\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\r\n-----END CERTIFICATE-----\r\n",
    "privateKey" : "-----BEGIN PRIVATE KEY-----\r\nMIIJQQIBADANBgkqhkiG9w0BAQEFAASCCSswggknAgEAAoICAQCdlpBfpoMac2y5\r\nrcM2VX9EjwGaO+kVqo5Y2ZZBiK97rDwFNyK6r4R5VQzpIZxJPhgIWy40VCPFgKIY\r\nzMUGnWQFY5j/HbnkxWKT/OVxJmBIiqvbOKTJH/130X1ARCtRc+2G7dTAtdYm76K1\r\n+I4oNvlrZJjnXYxdpQM2e2Jl1Kgv0jNXe8o7E2JvJPct2Zx/gW8GkXdwf79IWNaL\r\ns27u7rGpAOi2b+7dLrVdoWV6dMfAe817Mu1JTvFUWgU4aT4LQ5N8sVdwR5E+6NOk\r\nMLXk/B4HCWfCaaPtCOYlgjoSrV0nklbmuscs7Wpipm1/IbeXU+wanFYc0kZMjI2N\r\ntDNyN0IJkFJ0RWcgIBTqbhEbfcReSMTE96uUSEJzDwPvTetYHx+AFzWffAz81ndh\r\newfFMhwFNgV4gDOzewYMpnhyPHOS0UgBRDlogyP29z3l63xMTwSJWkMNsvRKmmZJ\r\nrCgD79T6zHu3weH2b8ecY0AhQu6PgJZiq+Azb/im1J2lB+XMIp7genUAJ9y46z87\r\nmyPQ+Gix04cqgsWSL4F/7AvkjzdWk2cMe4Rn7M0Xzcl1xYtx3mFZZn4Rxb0Y7chN\r\nQq8HApMpYH3AcJ3K4BROPpSsXVfg9gy9XmsrTzWCC558kf2H1GUFbL7kkNTaPue3\r\nUmuXgIzW/vct+0IqYILpsXzA9+XfgwIDAQABAoICAA3yTUSpz+B/ZpfoMOaWGnVO\r\n0q17r90jAwYJ+6pBFoazb3xmrMQo1GiIhmP7fYFd5XKX3zbyW1gXUkEvniA/vaJc\r\ndiXd053Tei3uq7+fzdWdsCfuk2bZVe1MtPEDF3JV+CeA1NtZPGKlwpioLqyQcPJ4\r\nLLANL2b6O5aOxN6OO3Q//hs38WXZCVUcyGNeZuNB6TmDljZ2l88nTZV/g8nRhheW\r\n5QGAVntsrtBigECeJS97xWupziY2vlTgwqWDauJEUMEwULS3ILuYj2JwjSh+x4mH\r\n447pGoDX0MZxCAKvJRdjdB1nWkk3mbqxT+94ZG8YFkUkoNpcIayUo9JuqD7rdQSP\r\n/PyxYgy7jmKh0flINuqdgwVZpz/8hjrGOfufYPrNfAZqjan1zt8hDQTyTI0V8Ngc\r\nXzSWMVddXObPyOrdlBbJRHvhQ5lpIh/TKqAURCKptpSarLdcwlQqiru6leDCNAwv\r\nAUPQ/212MrSl59p5T9RdvxikOfhFDalYcl3xywSjZowwRuSzgYXpRr8STKxxzlGB\r\nvO4rQYHPzdP3JvytFqPghSNSVt+M6qu1ph6ou70YHSpVuocvB5+6iHDDgr0vrSXE\r\nawm4EOSEI+J9F5/YkIE1UtOI6Aj5HHguAWJXBj0ZGiv/bpAVNr+eTx1Ga9qM8nx4\r\n/2LxlF0urRWZw+qfXL3BAoIBAQDaI0L8k460PSUVF/dL5jwqvSPZey+piHJGWfBr\r\n5wWslDYn/ABJYKj3NYFF4WDvnabXa8qTmxGOvMuwAwpkp3iEY7MB651tJ26CSCQ4\r\nYSYwYve/uuhlfQhtFiEihbj9jPebWJK1mQTU+SMOrxWU6UfkFTtsBqnB1ewAorWg\r\nAbqICUoW4Up10GOAsKRaRu6vhbReTRjM6/G2d3WlFiVsroVPbJeAAWCM7StQaio+\r\nUKfDJwv8TTC6nPLiYjXfwCLhMSmmD89rreWh8MvVefNTQ4sHcdLJe7reWYxYgOQ3\r\nXokPFDkbUOqZ1vwahDADYzzI0Nc0YgZW5vR8aYJkhnr7IzUlAoIBAQC48Nb2QXdl\r\ns9WUzCkKqhonUJhv5+85HIzE7EwnBaNgPAV+whLc1RHYXYGbIXmwZnGPW9gO8E9a\r\nnoVCCOLKEofhDQnbOH0xucESsGe1CeTj9gjlr0ASxqp7C2EnDBOBbd2g1KGX+IER\r\ny4YD3D1qeegG/Sntdh4G2x7W/omHRkz+uZ9EuJDd6VBZZwckGJ0kv4iUBAxn1BtL\r\ngTkFJwManqrQd/4Ceh4osUlXgmpMgjZWzXA+i2jrZh4uWTvvUFEh/GsAqVhXcrHS\r\nEkSTB8pVRmXq5WIefPNkQqfoXX3aa0KYgPK8TpJWu/oqzPLCzP12ioCFNDsFIx8o\r\ngFIqSniwhKWHAoIBACdMmQHmF5yTM34UXkI3TXmpr667yb9yTJwuEeluqpAH96XG\r\necq+dlJrOkn7q7ofnfJLgiiLlGMx0kR4l8PAhC7dw19CMo96vicMljHuFrI68kWB\r\nh+LY3s7AYOHWU5iib+11zKCY28z+wXkgw/Oa/4+w3467uJOqVaVbqvsTtKZTfhyX\r\nJBILpBGIQWPeSZwnq3Id06z/iQGFjhVa4w0sd+nyN20hUmKxS89mAQxO/ZpkC329\r\n7lyAcCWm6evQsrf9YnJ/gK/2mVtOhXqFSPgkQATsVbxk5Sqv2WAMgJEVH/4ud4db\r\nUZi7qZmhXQEPPOE09sCCNIAthbhwTcSMkdVy510CggEAQr3PpdEcaJyMsIU5LnsS\r\nsyt3x7LY9zBhcNOh69cyDZG7nfIl4oIWTZH5KuXax5lA1C6d+04oJRjeGGWiirBD\r\nTylobC+npqFVlwwIcSIf81CgB1vGcMA3V+5UYkYOaAAhImB57KEm2ygqtgvuMhXK\r\ncXM9hU/CKFE9gPMc6K+rK6YLXz6IMT143Lq8rf8f/toMTPZlD7dRHl+FF2Hr0dh+\r\n5nrXNUeiyKaqRCVxfSjkuVCseDXRaFpS/AECCyxeCzjP2M5EblKa76feDX2bPEkK\r\nkMm1LjGDmKQhek77Ey7wOp8WenSUhS6TaozJ8xkNQ5FaLjgaMJFrNi+Q92gmw/Uq\r\n0wKCAQA7eo+Wz6VBg7i//jrVaZl7MqmuqpaID6vXpAbmjU5BGEoOzxK9cIS0AMsL\r\npY5QzwQb+y9S35qpkaXsgndlyvdMBq58e5NN+Z8WEULuO85CW3rD6e1rWlXx6M3Y\r\nLFSKJQUjQ63FQJ+LX8nHylDkV/9T/sCFiYa1zv3AW2c7rz8eqXP9MabptpMqRfwZ\r\nUVlECszO2xb3zwg7WEnZu+DBNKsTIrKT8w/h3KvvWRbORpDOYcjW64V2NnjBP6Pc\r\nCUE2QsYVDOG/UDXjNanf3DnMCVVMJn06p+HQCDlATFnScu1qo++A7Dj4HTWmDtiU\r\nDsbI3yNePnNb5x1AZjii68cy9pLG\r\n-----END PRIVATE KEY-----"
  },
  "connectCredentials" : {
    "authenticationType" : "basic_auth",
    "username" : "test",
    "password" : "test123"
  },
  "properties" : {
    "description" : "Nice"
  }
}

23.6.3. HTTP response

HTTP/1.1 204 No Content

23.7. Create or Update Schema Registry details for Instance Cluster

A POST request is used to create or update schema registry details for a specific instance cluster.

23.7.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478/clusters/66c12e25ab06458eac988f0d700fbe81/schema-registry' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "url" : "http://sr:8081",
  "schemaRegistryVersion" : "2.0",
  "schemaRegistryType" : "apiCurio",
  "keycloakDetails" : {
    "url" : "http://podman-daemon.gitlab.svc:30033",
    "masterRealm" : "master",
    "adminUsername" : "admin",
    "adminPassword" : "admin",
    "adminClientId" : "admin-cli",
    "apicurioRealm" : "apicurio"
  },
  "credentials" : {
    "authenticationType" : "Basic-Auth",
    "username" : "Username",
    "password" : "Password"
  },
  "listeners" : {
    "Conflunt SerDes" : "HTTPS://some-url",
    "Apicurio SerDes" : "HTTPS://some-url",
    "key" : "value"
  },
  "properties" : {
    "key" : "value"
  }
}'

23.7.2. HTTP request

POST /instances/b9301e9144324928911f7d83ec40c478/clusters/66c12e25ab06458eac988f0d700fbe81/schema-registry HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 642
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "url" : "http://sr:8081",
  "schemaRegistryVersion" : "2.0",
  "schemaRegistryType" : "apiCurio",
  "keycloakDetails" : {
    "url" : "http://podman-daemon.gitlab.svc:30033",
    "masterRealm" : "master",
    "adminUsername" : "admin",
    "adminPassword" : "admin",
    "adminClientId" : "admin-cli",
    "apicurioRealm" : "apicurio"
  },
  "credentials" : {
    "authenticationType" : "Basic-Auth",
    "username" : "Username",
    "password" : "Password"
  },
  "listeners" : {
    "Conflunt SerDes" : "HTTPS://some-url",
    "Apicurio SerDes" : "HTTPS://some-url",
    "key" : "value"
  },
  "properties" : {
    "key" : "value"
  }
}

23.7.3. HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

This endpoint allows for selective updating of schema registry details, including listeners, properties, credentials, and Keycloak details. You can control which fields to skip during validation by using the optional skipFields parameter.

The skipFields parameter can include the following boolean flags:

  • keycloakDetails: Set to true to skip the update of Keycloak details.

  • credentials: Set to true to skip the update of schema registry credentials.

Do not include skipFields or set its values to false to allow updating credentials alongside other schema registry details.

23.7.4. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478/clusters/66c12e25ab06458eac988f0d700fbe81/schema-registry' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "url" : "http://sr-apicurio:8081",
  "schemaRegistryType" : "apICURIO",
  "credentials" : {
    "authenticationType" : "Basic-Auth",
    "username" : "New-Username",
    "password" : "New-Password"
  },
  "keycloakDetails" : {
    "url" : "http://podman-daemon.gitlab.svc:30033",
    "adminUsername" : "admin",
    "adminPassword" : "admin"
  },
  "listeners" : {
    "new" : "HTTPS://new-url"
  },
  "properties" : {
    "new" : "new"
  },
  "skipFields" : {
    "keycloakDetails" : false,
    "credentials" : false
  }
}'

23.7.5. HTTP request

POST /instances/b9301e9144324928911f7d83ec40c478/clusters/66c12e25ab06458eac988f0d700fbe81/schema-registry HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 526
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "url" : "http://sr-apicurio:8081",
  "schemaRegistryType" : "apICURIO",
  "credentials" : {
    "authenticationType" : "Basic-Auth",
    "username" : "New-Username",
    "password" : "New-Password"
  },
  "keycloakDetails" : {
    "url" : "http://podman-daemon.gitlab.svc:30033",
    "adminUsername" : "admin",
    "adminPassword" : "admin"
  },
  "listeners" : {
    "new" : "HTTPS://new-url"
  },
  "properties" : {
    "new" : "new"
  },
  "skipFields" : {
    "keycloakDetails" : false,
    "credentials" : false
  }
}

23.7.6. HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

23.8. Retrieve an instance

The instances/{id} item resource is used to retrieve, update and delete individual Instances.

A GET request will retrieve the details of an Instance.

23.8.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.8.2. HTTP request

GET /instances/b9301e9144324928911f7d83ec40c478 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.8.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 7610

{
  "uid" : "b9301e9144324928911f7d83ec40c478",
  "properties" : {
    "min.insync.replicas" : "1",
    "create-stream.disable-time" : "1",
    "retention.ms" : "172800000",
    "num.partitions" : "3",
    "segment.ms" : "172800000",
    "replication.factor" : "2"
  },
  "name" : "TenantA OTA",
  "description" : "TenantA OTA Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  }, {
    "schemaRegistryUrls" : "https://schema.local3",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
    "expiresOn" : null
  } ],
  "connectCerts" : [ ],
  "shortName" : "ota",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "tenant" : {
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : true,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : "https://connect1.url,https://connect2.url",
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : true,
  "selfApproval" : true,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.8.0",
  "instanceClusterSRListeners" : [ {
    "cluster" : {
      "name" : "Zone2ClusterOTA",
      "description" : "",
      "location" : "Zone2",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.4.0",
      "uid" : "543c3b7d55634eba83b1472775c131c4",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : ""
    },
    "schemaRegistryListeners" : {
      "TLS" : "sr-url:24000"
    }
  }, {
    "cluster" : {
      "name" : "Zone1ClusterOTA",
      "description" : "",
      "location" : "Zone1",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ {
        "bootstrapServer" : "bootstrapserver1:9093"
      } ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : {
        "MUTUAL_TLS" : "broker:9090"
      },
      "kafkaVersion" : "3.5.1",
      "uid" : "66c12e25ab06458eac988f0d700fbe81",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "bootstrapserver1:9093"
    },
    "schemaRegistryListeners" : {
      "NO_AUTH" : "sr-url:25000",
      "TLS" : "sr-url:24000"
    }
  } ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}
Relation Description

synchronize

Existence of this link indicates that currently authenticated user can synchronize this Instance.

23.9. Retrieve an instance for Confluent Cloud

The instances/{id} item resource is used to retrieve, update and delete individual Instances along with the authentication details of the provider.

A GET request will retrieve the details of an Instance.

23.9.1. Curl request

$ curl 'http://api.example.com/instances/ae301e9144324928911f7d83ec40f345' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.9.2. HTTP request

GET /instances/ae301e9144324928911f7d83ec40f345 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.9.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 3966

{
  "uid" : "ae301e9144324928911f7d83ec40f345",
  "properties" : { },
  "name" : "BYOKTenant CC",
  "description" : "BYOKTenant CC Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
    "providerInfo" : {
      "Axl-Sr-Url-Confluent" : "schema-registry-url",
      "Axl-Sr-Api-Key-Confluent" : "schema-registry-api-key",
      "Axl-Cluster-Id-Confluent" : "cluster-id",
      "Axl-Api-Key-Confluent" : "cloud-api-key",
      "Axl-Cluster-Api-Key-Confluent" : "cluster-api-key",
      "Axl-Provider-Type" : "confluent-cloud",
      "Axl-Env-Id-Confluent" : "env-id",
      "Axl-Sr-Id-Confluent" : "schema-registry-id",
      "Axl-Sr-Secret-Confluent" : "schema-registry-secret",
      "Axl-Secret-Confluent" : "cloud-secret",
      "Axl-Cluster-Url-Confluent" : "cluster-url",
      "Axl-Cluster-Secret-Confluent" : "cluster-secret"
    },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : {
      "distributionUrl" : "http://localhost:62226",
      "kafkaCredentials" : {
        "authenticationType" : "MTLS",
        "certificate" : "certificate"
      },
      "connectCredentials" : {
        "authenticationType" : "basic_auth",
        "username" : "test"
      },
      "properties" : {
        "description" : "Nice"
      }
    },
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ ],
  "connectCerts" : [ ],
  "shortName" : "BYOKCC",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  } ],
  "tenant" : {
    "properties" : null,
    "name" : "BYOK Tenant",
    "shortName" : "BYOKtenant",
    "uniqueConsumerGroup" : true,
    "logo" : "BYOKtenant.png",
    "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
    "dataClassificationEnabled" : true,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : false,
    "customerId" : null,
    "settings" : { },
    "uid" : "1149c97f04c42had8d9c97faa5a375ac",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : false,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : null,
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : false,
  "selfApproval" : true,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.7.1",
  "instanceClusterSRListeners" : [ ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.10. Retrieve an instance for Apache Kafka

The instances/{id} item resource is used to retrieve, update and delete individual Instances along with the authentication details of the provider.

A GET request will retrieve the details of an Instance.

23.10.1. Curl request

$ curl 'http://api.example.com/instances/bd401e9144324928911f7d83ec40f345' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.10.2. HTTP request

GET /instances/bd401e9144324928911f7d83ec40f345 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.10.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 5334

{
  "uid" : "bd401e9144324928911f7d83ec40f345",
  "properties" : { },
  "name" : "BYOKTenant APACHE-KAFKA",
  "description" : "BYOKTenant Apache-Kafka Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : null,
    "providerInfo" : {
      "Axl-Broker-Private-Key-ApacheKafka" : "",
      "Axl-Sr-Password-ApacheKafka" : "",
      "Axl-Broker-Password-ApacheKafka" : "",
      "Axl-Broker-Protocol-Type-ApacheKafka" : "cluster-protocol-type",
      "Axl-Broker-Security-Protocol-Type-ApacheKafka" : "cluster-security-protocol-type",
      "Axl-Sr-Private-Key-ApacheKafka" : "",
      "Axl-Broker-Username-ApacheKafka" : "cluster-username",
      "Axl-Sr-Cert-ApacheKafka" : "schema-registry-cert",
      "Axl-Sr-Protocol-Type-ApacheKafka" : "No-Auth",
      "Axl-Broker-Cert-ApacheKafka" : "cluster-cert",
      "Axl-Provider-Type" : "apache-kafka",
      "Axl-Broker-CA-Validation-ApacheKafka" : "cluster-ca-validation",
      "Axl-Sr-Truststore-ApacheKafka" : "schema-registry-ca-cert",
      "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
      "Axl-Broker-Truststore-ApacheKafka" : "cluster-ca-cert",
      "Axl-Sr-Url-ApacheKafka" : "schema-registry-url",
      "Axl-Sr-Username-ApacheKafka" : "schema-registry-username"
    },
    "schemaRegistryType" : "Apicurio",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  }, {
    "schemaRegistryUrls" : null,
    "providerInfo" : {
      "Axl-Broker-Private-Key-ApacheKafka" : "",
      "Axl-Sr-Password-ApacheKafka" : "",
      "Axl-Broker-Password-ApacheKafka" : "",
      "Axl-Broker-Protocol-Type-ApacheKafka" : "cluster-protocol-type",
      "Axl-Broker-Security-Protocol-Type-ApacheKafka" : "cluster-security-protocol-type",
      "Axl-Sr-Private-Key-ApacheKafka" : "",
      "Axl-Broker-Username-ApacheKafka" : "cluster-username",
      "Axl-Sr-Cert-ApacheKafka" : "schema-registry-cert",
      "Axl-Sr-Protocol-Type-ApacheKafka" : "No-Auth",
      "Axl-Broker-Cert-ApacheKafka" : "cluster-cert",
      "Axl-Provider-Type" : "apache-kafka",
      "Axl-Broker-CA-Validation-ApacheKafka" : "cluster-ca-validation",
      "Axl-Sr-Truststore-ApacheKafka" : "schema-registry-ca-cert",
      "Axl-Bootstrap-Server-ApacheKafka" : "cluster-bootstrap",
      "Axl-Broker-Truststore-ApacheKafka" : "cluster-ca-cert",
      "Axl-Sr-Url-ApacheKafka" : "schema-registry-url",
      "Axl-Sr-Username-ApacheKafka" : "schema-registry-username"
    },
    "schemaRegistryType" : null,
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ ],
  "connectCerts" : [ ],
  "shortName" : "BYOKKAFKA",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  } ],
  "tenant" : {
    "properties" : null,
    "name" : "BYOK Tenant",
    "shortName" : "BYOKtenant",
    "uniqueConsumerGroup" : true,
    "logo" : "BYOKtenant.png",
    "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
    "dataClassificationEnabled" : true,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : false,
    "customerId" : null,
    "settings" : { },
    "uid" : "1149c97f04c42had8d9c97faa5a375ac",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : false,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : null,
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : false,
  "selfApproval" : true,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.8.0",
  "instanceClusterSRListeners" : [ ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.11. Retrieve an instance with Distribution Config

The instances/{id} item resource is used to retrieve Instances along with the distribution config.

A GET request will retrieve the details of an Instance.

23.11.1. Curl request

$ curl 'http://api.example.com/instances/ae301e9144324928911f7d83ec40f345' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.11.2. HTTP request

GET /instances/ae301e9144324928911f7d83ec40f345 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.11.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 3966

{
  "uid" : "ae301e9144324928911f7d83ec40f345",
  "properties" : { },
  "name" : "BYOKTenant CC",
  "description" : "BYOKTenant CC Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
    "providerInfo" : {
      "Axl-Sr-Url-Confluent" : "schema-registry-url",
      "Axl-Sr-Api-Key-Confluent" : "schema-registry-api-key",
      "Axl-Cluster-Id-Confluent" : "cluster-id",
      "Axl-Api-Key-Confluent" : "cloud-api-key",
      "Axl-Cluster-Api-Key-Confluent" : "cluster-api-key",
      "Axl-Provider-Type" : "confluent-cloud",
      "Axl-Env-Id-Confluent" : "env-id",
      "Axl-Sr-Id-Confluent" : "schema-registry-id",
      "Axl-Sr-Secret-Confluent" : "schema-registry-secret",
      "Axl-Secret-Confluent" : "cloud-secret",
      "Axl-Cluster-Url-Confluent" : "cluster-url",
      "Axl-Cluster-Secret-Confluent" : "cluster-secret"
    },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : {
      "distributionUrl" : "http://localhost:62226",
      "kafkaCredentials" : {
        "authenticationType" : "MTLS",
        "certificate" : "certificate"
      },
      "connectCredentials" : {
        "authenticationType" : "basic_auth",
        "username" : "test"
      },
      "properties" : {
        "description" : "Nice"
      }
    },
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ ],
  "connectCerts" : [ ],
  "shortName" : "BYOKCC",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  } ],
  "tenant" : {
    "properties" : null,
    "name" : "BYOK Tenant",
    "shortName" : "BYOKtenant",
    "uniqueConsumerGroup" : true,
    "logo" : "BYOKtenant.png",
    "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
    "dataClassificationEnabled" : true,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : false,
    "customerId" : null,
    "settings" : { },
    "uid" : "1149c97f04c42had8d9c97faa5a375ac",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : false,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : null,
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : false,
  "selfApproval" : true,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.7.1",
  "instanceClusterSRListeners" : [ ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.12. Retrieve Distribution Overview for an Instance

The /instances/{id}/distributions item resource is used to retrieve Instances along with the distribution overview.

A GET request will retrieve all the distributions configured in the clusters of an Instance.

23.12.1. Curl request

$ curl 'http://api.example.com/instances/we341e9144324928911f7d83ec40f123/distributions' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.12.2. HTTP request

GET /instances/we341e9144324928911f7d83ec40f123/distributions HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.12.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420

{
  "distributions" : [ {
    "name" : "message-distribution-from-BYOKClusterForApacheKafka-to-BYOKClusterForCC",
    "type" : "MESSAGE",
    "source" : "BYOKClusterForApacheKafka",
    "target" : "BYOKClusterForCC"
  }, {
    "name" : "message-distribution-from-BYOKClusterForCC-to-BYOKClusterForApacheKafka",
    "type" : "MESSAGE",
    "source" : "BYOKClusterForCC",
    "target" : "BYOKClusterForApacheKafka"
  } ]
}

When there is one or less cluster configured to an instance empty list is returned

23.12.4. Curl request

$ curl 'http://api.example.com/instances/ae301e9144324928911f7d83ec40f345/distributions' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.12.5. HTTP request

GET /instances/ae301e9144324928911f7d83ec40f345/distributions HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.12.6. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 27

{
  "distributions" : [ ]
}

23.13. Retrieve Distribution Config for an instance cluster

The instances/{id}/clusters/{id} item resource is used to retrieve the distribution config for an instance cluster.

A GET request will retrieve the distribution config of an Instance Cluster.

23.13.1. Curl request

$ curl 'http://api.example.com/instances/ae301e9144324928911f7d83ec40f345/clusters/9gr818181cd44798ab70322830800dbc/distribution' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.13.2. HTTP request

GET /instances/ae301e9144324928911f7d83ec40f345/clusters/9gr818181cd44798ab70322830800dbc/distribution HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.13.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 297

{
  "distributionUrl" : "http://localhost:62226",
  "kafkaCredentials" : {
    "authenticationType" : "MTLS",
    "certificate" : "certificate"
  },
  "connectCredentials" : {
    "authenticationType" : "basic_auth",
    "username" : "test"
  },
  "properties" : {
    "description" : "Nice"
  }
}

When there is no distribution config configured for an instance cluster, an empty response is returned.

23.13.4. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478/clusters/66c12e25ab06458eac988f0d700fbe81/distribution' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.13.5. HTTP request

GET /instances/b9301e9144324928911f7d83ec40c478/clusters/66c12e25ab06458eac988f0d700fbe81/distribution HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.13.6. HTTP response

HTTP/1.1 200 OK

23.13.7. /instances/search/findByAttributes

A GET request is used to retrieve all instances based on parameters.

Query parameters
Parameter Description

name

Instance name to search for.

shortName

Instance shortName to search for.

sort

Property to sort on and the direction.

page

Navigate through different pages.

size

Property to define the page size.
HTTP request
GET /instances/search/findByAttributes?name=&shortName=ota&sort=name%2Casc&page=0&size=5 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 5109

{
  "_embedded" : {
    "instances" : [ {
      "name" : "TenantA OTA",
      "settings" : {
        "environmentMapping" : "true",
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE",
        "topicOwnerBrowsePermission" : "true"
      },
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "enabledAuthenticationMethods" : [ {
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS",
        "rank" : 0
      }, {
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256",
        "rank" : 1
      }, {
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER",
        "rank" : 2
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "Zone1ClusterOTA",
          "tenant" : null,
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ]
        },
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2"
      }, {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "Zone2ClusterOTA",
          "tenant" : null,
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ]
        },
        "schemaRegistryUrls" : "https://schema.local3"
      } ],
      "shortName" : "ota",
      "description" : "TenantA OTA Instance",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "instance" : {
          "href" : "...",
          "title" : "An instance"
        },
        "supportTier" : {
          "href" : "..."
        }
      },
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "name" : "TenantA OTA2",
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : null,
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE",
        "environmentMapping" : "true"
      },
      "uid" : "6e37bcf4d4a44334924aa0f961286668",
      "enabledAuthenticationMethods" : [ {
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256",
        "rank" : 0
      }, {
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS",
        "rank" : 1
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "_links" : {
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "name" : "Zone2ClusterOTA",
          "tenant" : null,
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ]
        },
        "schemaRegistryUrls" : "https://schema.local6"
      } ],
      "shortName" : "ota2",
      "description" : "Second TenantA OTA Instance",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "instance" : {
          "href" : "...",
          "title" : "An instance"
        },
        "supportTier" : {
          "href" : "..."
        }
      },
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 5,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

23.14. Update an instance

A PATCH request is used to update an instance.

To leave an attribute of an instance unchanged, any of the above may be omitted from the request.

The schema registry type selection is only valid when a Schema Registry is provided for a Cluster. The value can be either CONFLUENT or APICURIO. When the value is not provided, it will default to registering as CONFLUENT.

If an array of Clusters is supplied in the request body, it will replace existing Clusters, if any.

Please note that in case duplicated PEMs are provided for caCerts or connectCerts attributes, or duplicated authentication methods are provided for the enabledAuthenticationMethods attribute, you will not get any validation error and the server will internally handle the duplicated items.

23.14.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "description" : "modified description"
}'

23.14.2. HTTP request

PATCH /instances/b9301e9144324928911f7d83ec40c478 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 44
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "description" : "modified description"
}

23.14.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 7610

{
  "uid" : "b9301e9144324928911f7d83ec40c478",
  "properties" : {
    "min.insync.replicas" : "1",
    "create-stream.disable-time" : "1",
    "retention.ms" : "172800000",
    "num.partitions" : "3",
    "segment.ms" : "172800000",
    "replication.factor" : "2"
  },
  "name" : "TenantA OTA",
  "description" : "modified description",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  }, {
    "schemaRegistryUrls" : "https://schema.local3",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
    "expiresOn" : null
  } ],
  "connectCerts" : [ ],
  "shortName" : "ota",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "tenant" : {
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : true,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : "https://connect1.url,https://connect2.url",
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : true,
  "selfApproval" : true,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.8.0",
  "instanceClusterSRListeners" : [ {
    "cluster" : {
      "name" : "Zone2ClusterOTA",
      "description" : "",
      "location" : "Zone2",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.4.0",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "",
      "uid" : "543c3b7d55634eba83b1472775c131c4"
    },
    "schemaRegistryListeners" : {
      "TLS" : "sr-url:24000"
    }
  }, {
    "cluster" : {
      "name" : "Zone1ClusterOTA",
      "description" : "",
      "location" : "Zone1",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ {
        "bootstrapServer" : "bootstrapserver1:9093"
      } ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : {
        "MUTUAL_TLS" : "broker:9090"
      },
      "kafkaVersion" : "3.5.1",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "bootstrapserver1:9093",
      "uid" : "66c12e25ab06458eac988f0d700fbe81"
    },
    "schemaRegistryListeners" : {
      "NO_AUTH" : "sr-url:25000",
      "TLS" : "sr-url:24000"
    }
  } ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.15. Update an instance with Connect enable

The PATCH request can be used to turn on Connect functionality for the instance.

23.15.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "connectEnabled" : true,
  "connectUrls" : "test-connect-worker-1,test-connect-worker-2"
}'

23.15.2. HTTP request

PATCH /instances/b9301e9144324928911f7d83ec40c478 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 94
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "connectEnabled" : true,
  "connectUrls" : "test-connect-worker-1,test-connect-worker-2"
}

23.15.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 7613

{
  "uid" : "b9301e9144324928911f7d83ec40c478",
  "properties" : {
    "min.insync.replicas" : "1",
    "create-stream.disable-time" : "1",
    "retention.ms" : "172800000",
    "num.partitions" : "3",
    "segment.ms" : "172800000",
    "replication.factor" : "2"
  },
  "name" : "TenantA OTA",
  "description" : "TenantA OTA Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  }, {
    "schemaRegistryUrls" : "https://schema.local3",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
    "expiresOn" : null
  } ],
  "connectCerts" : [ ],
  "shortName" : "ota",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "tenant" : {
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : true,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : "test-connect-worker-1,test-connect-worker-2",
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : true,
  "selfApproval" : false,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.8.0",
  "instanceClusterSRListeners" : [ {
    "cluster" : {
      "name" : "Zone2ClusterOTA",
      "description" : "",
      "location" : "Zone2",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.4.0",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "",
      "uid" : "543c3b7d55634eba83b1472775c131c4"
    },
    "schemaRegistryListeners" : {
      "TLS" : "sr-url:24000"
    }
  }, {
    "cluster" : {
      "name" : "Zone1ClusterOTA",
      "description" : "",
      "location" : "Zone1",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ {
        "bootstrapServer" : "bootstrapserver1:9093"
      } ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : {
        "MUTUAL_TLS" : "broker:9090"
      },
      "kafkaVersion" : "3.5.1",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "bootstrapserver1:9093",
      "uid" : "66c12e25ab06458eac988f0d700fbe81"
    },
    "schemaRegistryListeners" : {
      "NO_AUTH" : "sr-url:25000",
      "TLS" : "sr-url:24000"
    }
  } ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.16. Update an instance with Connect Logging-Support enabled

The PATCH request can be used to enable Connect Logging-Support for the instance. This will automatically create the topics and authorisations required by the Connect-Logger to function correctly.

23.16.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "connectEnabled" : true,
  "connectUrls" : "test-connect-worker-1,test-connect-worker-2",
  "connectLoggingSupportEnabled" : true,
  "connectCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIEsjCCApqgAwIBAgIRANlGfD2h/5K+2AqXk+2/GmswDQYJKoZIhvcNAQELBQAw\nKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEwHhcN\nMjAwNDAxMTIzMzUzWhcNMjUwMzMxMTIzMzUzWjBXMQswCQYDVQQGEwJOTDEQMA4G\nA1UEBwwHVXRyZWNodDETMBEGA1UECgwKQXh1YWwgQi5WLjEhMB8GA1UEAwwYRXhh\nbXBsZSBTdHJlYW0gUHJvY2Vzc29yMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAo8DILU6LFXEpN2DcD7f9haAMq9ddlDYDomDM7PAk7UwYGUuycpX11z9s\nSdbO5a0WNc/qN2Zi/tPn7cYrYod6nsLG+NfBSMYNakvc7at8Ym2m2I3k5klQM3YH\nSTUf+a9O3Gfz6Q2XZ6GvHIf63omEH8cBD9fk9BLmDKgQHwcNf9mvWa4se9ONsY1l\nGs/R+q7hmGLZbbyr2lWSrXp0GKKfoxtS/mv0Z0lcuvxgGpB3HHMY6pegBuhOOVwC\nv1HUUTAORoYmwOuFD0fO6vAmwGUuyPwCSJxcDXGJYwnpK953yJYM1UAF/BKe5fFM\nZ3Ce75R06feQaZYilp7XQN4YYBJWZwIDAQABo4GkMIGhMAkGA1UdEwQCMAAwHQYD\nVR0OBBYEFLjtlM29zjwQ7SR5IbR3CARf+ENiMEkGA1UdIwRCMECAFGvSKVeLUjYs\nBQrGV7kadHisEx9moSSkIjAgMR4wHAYDVQQDDBVBeHVhbCBEdW1teSBSb290IDIw\nMTiCAhAAMAsGA1UdDwQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUH\nAwEwDQYJKoZIhvcNAQELBQADggIBAKk6ID1SYackve9eCe9hk//OZY7wWUirRP+7\nJIoCi+cAMx4hn1M5XPi4yQaGMe2vQXgcOgu2h7ljqXdpkSL4ZTAv1PCyOEMHJ0Wn\nHc4biKr6reQ7GQzsjygB5ULr9T5CEH/HAfAw9n7ttrxadPOlLbgilucyO8LeLrPZ\nJ0Jbo1Yf1VJE5SZmWN9U47AlDhEZnWjAQolcIqVWOcVYYT12ca9epH+slnBXDX7B\ny41AYaPwA0c/j+mlSXdFsU8HxU9NSu1R15bzW3+4uTIPvIeB3s+yjHBt35Sb9IRS\nGoaGIcE9HJZh9QTqgPUDxlXgDvWttfzIp2wNeWpmd9WP+Ai7CT9M2PxSGYDunl27\neY/U83AaScaSoSXn9tXHtXyRHrD/OAlWc+NzZtFJxRlRw7sc4ElmHbSoBVcDpi38\nTGBD+zxTpKMeTaVhJpGvhzc9MVy5qaI6Bcdg6J4SusiTiMro9bu/kxuxrLcE1E7w\nAmeqQwPoaZZ3O200kd4bd7Iil6g3mP8nVkkeLuJA5/ax9FEdbEH+jpfk3ouf+AKe\np1whWsEx5KOqApnl6NByRq+zqohofmyDWCIXzSXp0neQEryByatZDUVuf1HUQCAv\nFkoZdzOnT+scywMfxyqrP0N8nvh/0CBPX/s+7B9v+KJm54ZQcxAEsms/NvkNPunx\nVANhOECv\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----"
  } ]
}'

23.16.2. HTTP request

PATCH /instances/b9301e9144324928911f7d83ec40c478 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 5654
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "connectEnabled" : true,
  "connectUrls" : "test-connect-worker-1,test-connect-worker-2",
  "connectLoggingSupportEnabled" : true,
  "connectCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIEsjCCApqgAwIBAgIRANlGfD2h/5K+2AqXk+2/GmswDQYJKoZIhvcNAQELBQAw\nKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEwHhcN\nMjAwNDAxMTIzMzUzWhcNMjUwMzMxMTIzMzUzWjBXMQswCQYDVQQGEwJOTDEQMA4G\nA1UEBwwHVXRyZWNodDETMBEGA1UECgwKQXh1YWwgQi5WLjEhMB8GA1UEAwwYRXhh\nbXBsZSBTdHJlYW0gUHJvY2Vzc29yMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAo8DILU6LFXEpN2DcD7f9haAMq9ddlDYDomDM7PAk7UwYGUuycpX11z9s\nSdbO5a0WNc/qN2Zi/tPn7cYrYod6nsLG+NfBSMYNakvc7at8Ym2m2I3k5klQM3YH\nSTUf+a9O3Gfz6Q2XZ6GvHIf63omEH8cBD9fk9BLmDKgQHwcNf9mvWa4se9ONsY1l\nGs/R+q7hmGLZbbyr2lWSrXp0GKKfoxtS/mv0Z0lcuvxgGpB3HHMY6pegBuhOOVwC\nv1HUUTAORoYmwOuFD0fO6vAmwGUuyPwCSJxcDXGJYwnpK953yJYM1UAF/BKe5fFM\nZ3Ce75R06feQaZYilp7XQN4YYBJWZwIDAQABo4GkMIGhMAkGA1UdEwQCMAAwHQYD\nVR0OBBYEFLjtlM29zjwQ7SR5IbR3CARf+ENiMEkGA1UdIwRCMECAFGvSKVeLUjYs\nBQrGV7kadHisEx9moSSkIjAgMR4wHAYDVQQDDBVBeHVhbCBEdW1teSBSb290IDIw\nMTiCAhAAMAsGA1UdDwQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUH\nAwEwDQYJKoZIhvcNAQELBQADggIBAKk6ID1SYackve9eCe9hk//OZY7wWUirRP+7\nJIoCi+cAMx4hn1M5XPi4yQaGMe2vQXgcOgu2h7ljqXdpkSL4ZTAv1PCyOEMHJ0Wn\nHc4biKr6reQ7GQzsjygB5ULr9T5CEH/HAfAw9n7ttrxadPOlLbgilucyO8LeLrPZ\nJ0Jbo1Yf1VJE5SZmWN9U47AlDhEZnWjAQolcIqVWOcVYYT12ca9epH+slnBXDX7B\ny41AYaPwA0c/j+mlSXdFsU8HxU9NSu1R15bzW3+4uTIPvIeB3s+yjHBt35Sb9IRS\nGoaGIcE9HJZh9QTqgPUDxlXgDvWttfzIp2wNeWpmd9WP+Ai7CT9M2PxSGYDunl27\neY/U83AaScaSoSXn9tXHtXyRHrD/OAlWc+NzZtFJxRlRw7sc4ElmHbSoBVcDpi38\nTGBD+zxTpKMeTaVhJpGvhzc9MVy5qaI6Bcdg6J4SusiTiMro9bu/kxuxrLcE1E7w\nAmeqQwPoaZZ3O200kd4bd7Iil6g3mP8nVkkeLuJA5/ax9FEdbEH+jpfk3ouf+AKe\np1whWsEx5KOqApnl6NByRq+zqohofmyDWCIXzSXp0neQEryByatZDUVuf1HUQCAv\nFkoZdzOnT+scywMfxyqrP0N8nvh/0CBPX/s+7B9v+KJm54ZQcxAEsms/NvkNPunx\nVANhOECv\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----"
  } ]
}

23.16.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 13131

{
  "uid" : "b9301e9144324928911f7d83ec40c478",
  "properties" : {
    "min.insync.replicas" : "1",
    "create-stream.disable-time" : "1",
    "retention.ms" : "172800000",
    "num.partitions" : "3",
    "segment.ms" : "172800000",
    "replication.factor" : "2"
  },
  "name" : "TenantA OTA",
  "description" : "TenantA OTA Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  }, {
    "schemaRegistryUrls" : "https://schema.local3",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
    "expiresOn" : null
  } ],
  "connectCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIEsjCCApqgAwIBAgIRANlGfD2h/5K+2AqXk+2/GmswDQYJKoZIhvcNAQELBQAw\nKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEwHhcN\nMjAwNDAxMTIzMzUzWhcNMjUwMzMxMTIzMzUzWjBXMQswCQYDVQQGEwJOTDEQMA4G\nA1UEBwwHVXRyZWNodDETMBEGA1UECgwKQXh1YWwgQi5WLjEhMB8GA1UEAwwYRXhh\nbXBsZSBTdHJlYW0gUHJvY2Vzc29yMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAo8DILU6LFXEpN2DcD7f9haAMq9ddlDYDomDM7PAk7UwYGUuycpX11z9s\nSdbO5a0WNc/qN2Zi/tPn7cYrYod6nsLG+NfBSMYNakvc7at8Ym2m2I3k5klQM3YH\nSTUf+a9O3Gfz6Q2XZ6GvHIf63omEH8cBD9fk9BLmDKgQHwcNf9mvWa4se9ONsY1l\nGs/R+q7hmGLZbbyr2lWSrXp0GKKfoxtS/mv0Z0lcuvxgGpB3HHMY6pegBuhOOVwC\nv1HUUTAORoYmwOuFD0fO6vAmwGUuyPwCSJxcDXGJYwnpK953yJYM1UAF/BKe5fFM\nZ3Ce75R06feQaZYilp7XQN4YYBJWZwIDAQABo4GkMIGhMAkGA1UdEwQCMAAwHQYD\nVR0OBBYEFLjtlM29zjwQ7SR5IbR3CARf+ENiMEkGA1UdIwRCMECAFGvSKVeLUjYs\nBQrGV7kadHisEx9moSSkIjAgMR4wHAYDVQQDDBVBeHVhbCBEdW1teSBSb290IDIw\nMTiCAhAAMAsGA1UdDwQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUH\nAwEwDQYJKoZIhvcNAQELBQADggIBAKk6ID1SYackve9eCe9hk//OZY7wWUirRP+7\nJIoCi+cAMx4hn1M5XPi4yQaGMe2vQXgcOgu2h7ljqXdpkSL4ZTAv1PCyOEMHJ0Wn\nHc4biKr6reQ7GQzsjygB5ULr9T5CEH/HAfAw9n7ttrxadPOlLbgilucyO8LeLrPZ\nJ0Jbo1Yf1VJE5SZmWN9U47AlDhEZnWjAQolcIqVWOcVYYT12ca9epH+slnBXDX7B\ny41AYaPwA0c/j+mlSXdFsU8HxU9NSu1R15bzW3+4uTIPvIeB3s+yjHBt35Sb9IRS\nGoaGIcE9HJZh9QTqgPUDxlXgDvWttfzIp2wNeWpmd9WP+Ai7CT9M2PxSGYDunl27\neY/U83AaScaSoSXn9tXHtXyRHrD/OAlWc+NzZtFJxRlRw7sc4ElmHbSoBVcDpi38\nTGBD+zxTpKMeTaVhJpGvhzc9MVy5qaI6Bcdg6J4SusiTiMro9bu/kxuxrLcE1E7w\nAmeqQwPoaZZ3O200kd4bd7Iil6g3mP8nVkkeLuJA5/ax9FEdbEH+jpfk3ouf+AKe\np1whWsEx5KOqApnl6NByRq+zqohofmyDWCIXzSXp0neQEryByatZDUVuf1HUQCAv\nFkoZdzOnT+scywMfxyqrP0N8nvh/0CBPX/s+7B9v+KJm54ZQcxAEsms/NvkNPunx\nVANhOECv\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
    "expiresOn" : null
  } ],
  "shortName" : "ota",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "tenant" : {
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : true,
  "connectLoggingSupportEnabled" : true,
  "connectUrls" : "test-connect-worker-1,test-connect-worker-2",
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : true,
  "selfApproval" : false,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.8.0",
  "instanceClusterSRListeners" : [ {
    "cluster" : {
      "name" : "Zone2ClusterOTA",
      "description" : "",
      "location" : "Zone2",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.4.0",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "",
      "uid" : "543c3b7d55634eba83b1472775c131c4"
    },
    "schemaRegistryListeners" : {
      "TLS" : "sr-url:24000"
    }
  }, {
    "cluster" : {
      "name" : "Zone1ClusterOTA",
      "description" : "",
      "location" : "Zone1",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ {
        "bootstrapServer" : "bootstrapserver1:9093"
      } ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : {
        "MUTUAL_TLS" : "broker:9090"
      },
      "kafkaVersion" : "3.5.1",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "bootstrapserver1:9093",
      "uid" : "66c12e25ab06458eac988f0d700fbe81"
    },
    "schemaRegistryListeners" : {
      "NO_AUTH" : "sr-url:25000",
      "TLS" : "sr-url:24000"
    }
  } ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.17. Update an instance with KSML enabled

The PATCH request can be used to turn on KSML functionality for the instance.

23.17.1. Curl request

$ curl 'http://api.example.com/instances/6e37bcf4d4a44334924aa0f961286668' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "ksmlEnabled" : true,
  "ksmlUrl" : "http://ksml-url.com"
}'

23.17.2. HTTP request

PATCH /instances/6e37bcf4d4a44334924aa0f961286668 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 63
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "ksmlEnabled" : true,
  "ksmlUrl" : "http://ksml-url.com"
}

23.17.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 4506

{
  "uid" : "6e37bcf4d4a44334924aa0f961286668",
  "properties" : { },
  "name" : "TenantA OTA2",
  "description" : "Second TenantA OTA Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : "https://schema.local6",
    "providerInfo" : { },
    "schemaRegistryType" : "Apicurio",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIDBTCCAe2gAwIBAgIUAYIGW5rUZnprmkcDaANmIxAqKfgwDQYJKoZIhvcNAQEL\nBQAwEjEQMA4GA1UEAwwHUm9vdCBDQTAeFw0yNTAzMTgxNDI1MjNaFw0zNTAzMTYx\nNDI1MjNaMBIxEDAOBgNVBAMMB1Jvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IB\nDwAwggEKAoIBAQDYs10yh8QAJf0Rih0mXeFbGzMZJ49vyio7jEEzgpZrVRRrFJPD\nuvFs/YY0I5Q1NB3Ry4rrmtfo3F8Uw1LKx/pQKOzfdxZJsstsF6uApn4pzHU4mMvG\nANnEbj0sp7opBFVeukIZbvqb98DiSGPXeUFTfmHDG3Hu6/1nBnpTU4vt1zKK14En\nF81sEbppFzWus7ObI5+bPK+8UH9ikvi8odt9tYfiETxsKlyv+bFq/nkkS3fXh58g\nVECscPrZGrkXCKIQSpn8zq20na5wZGv+F4aa3fO29GcO49hd/3qHb3pvlgIsdCzb\nDR2zv6mFLZsMruKN7Chv/8s69heY5xRBYOLRAgMBAAGjUzBRMB0GA1UdDgQWBBTl\nX2hwfMS0Ps8Z/Z6uai8j6OCAtzAfBgNVHSMEGDAWgBTlX2hwfMS0Ps8Z/Z6uai8j\n6OCAtzAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQAJ7lF5nOoX\nfrGZS3O1HbfLshwS6zch/Y1qJ0tCtQ3FvJ1WWBCoq9R1xhQguPIJtX34jygURYmp\nYtEaE3OPfb1LiXrWf0yF+QbBYtuRdIHmzCm6gAgInep/qADnRD8HkReleHwnO8yT\naJL1TFopnb3AOuLiauf34w6z3OVFdtMuAh/CkI/BqgN94p0sJ9JSKQ3X50l6yRco\nhRmmKLzmCtiDq7+8xxskGn6qx0ohCvDzmARyuGiHC7Y/sLTeXbuT8003tsuKxGBz\nnJ74gkz0C8J9lgXkmQXDploGdT0zGJamsixAMKWF7p3zhzNleEtPskf4dSahUIi8\nOiE7s6pw7QkJ\n-----END CERTIFICATE-----",
    "expiresOn" : null
  } ],
  "connectCerts" : [ ],
  "shortName" : "ota2",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  } ],
  "tenant" : {
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : true,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : "https://connect3.url,https://connect4.url",
  "ksmlEnabled" : true,
  "ksmlUrl" : "http://ksml-url.com",
  "granularBrowsePermission" : false,
  "topicOwnerBrowsePermission" : false,
  "selfApproval" : false,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.8.0",
  "instanceClusterSRListeners" : [ ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.18. Update an instance enabled authentication methods

A PATCH request is used to update an instance enabledAuthenticationMethods.

Allowed values are the supportedAuthenticationMethods for the instance’s Tenant.

Each enabledAuthenticationMethods has a rank defining the order of priority, the rank comes from the Tenant’s supportedAuthenticationMethods.

23.18.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "instanceClusters" : [ {
    "cluster" : "http://api.example.com/clusters/543c3b7d55634eba83b1472775c131c4"
  } ],
  "enabledAuthenticationMethods" : [ {
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ]
}'

23.18.2. HTTP request

PATCH /instances/b9301e9144324928911f7d83ec40c478 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 351
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "instanceClusters" : [ {
    "cluster" : "http://api.example.com/clusters/543c3b7d55634eba83b1472775c131c4"
  } ],
  "enabledAuthenticationMethods" : [ {
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ]
}

23.18.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 6262

{
  "uid" : "b9301e9144324928911f7d83ec40c478",
  "properties" : {
    "min.insync.replicas" : "1",
    "create-stream.disable-time" : "1",
    "retention.ms" : "172800000",
    "num.partitions" : "3",
    "segment.ms" : "172800000",
    "replication.factor" : "2"
  },
  "name" : "TenantA OTA",
  "description" : "TenantA OTA Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : null,
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
    "expiresOn" : null
  } ],
  "connectCerts" : [ ],
  "shortName" : "ota",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "tenant" : {
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : true,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : "https://connect1.url,https://connect2.url",
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : true,
  "selfApproval" : true,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.8.0",
  "instanceClusterSRListeners" : [ {
    "cluster" : {
      "name" : "Zone2ClusterOTA",
      "description" : "",
      "location" : "Zone2",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.4.0",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "",
      "uid" : "543c3b7d55634eba83b1472775c131c4"
    },
    "schemaRegistryListeners" : {
      "TLS" : "sr-url:24000"
    }
  } ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.19. Update an instance with granular browse permission

A PATCH request is used to update an instance granularBrowsePermissions.

By default, granularBrowsePermissions for an instance is set to false.

When the granularBrowsePermissions is disabled on the instance, all the existing permissionGroup, that are configured on environments associated with this Instance, will be deleted.

23.19.1. Curl request

$ curl 'http://api.example.com/instances/6e37bcf4d4a44334924aa0f961286668' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "granularBrowsePermission" : true
}'

23.19.2. HTTP request

PATCH /instances/6e37bcf4d4a44334924aa0f961286668 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 39
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "granularBrowsePermission" : true
}

23.19.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 4489

{
  "uid" : "6e37bcf4d4a44334924aa0f961286668",
  "properties" : { },
  "name" : "TenantA OTA2",
  "description" : "Second TenantA OTA Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : "https://schema.local6",
    "providerInfo" : { },
    "schemaRegistryType" : "Apicurio",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIDBTCCAe2gAwIBAgIUAYIGW5rUZnprmkcDaANmIxAqKfgwDQYJKoZIhvcNAQEL\nBQAwEjEQMA4GA1UEAwwHUm9vdCBDQTAeFw0yNTAzMTgxNDI1MjNaFw0zNTAzMTYx\nNDI1MjNaMBIxEDAOBgNVBAMMB1Jvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IB\nDwAwggEKAoIBAQDYs10yh8QAJf0Rih0mXeFbGzMZJ49vyio7jEEzgpZrVRRrFJPD\nuvFs/YY0I5Q1NB3Ry4rrmtfo3F8Uw1LKx/pQKOzfdxZJsstsF6uApn4pzHU4mMvG\nANnEbj0sp7opBFVeukIZbvqb98DiSGPXeUFTfmHDG3Hu6/1nBnpTU4vt1zKK14En\nF81sEbppFzWus7ObI5+bPK+8UH9ikvi8odt9tYfiETxsKlyv+bFq/nkkS3fXh58g\nVECscPrZGrkXCKIQSpn8zq20na5wZGv+F4aa3fO29GcO49hd/3qHb3pvlgIsdCzb\nDR2zv6mFLZsMruKN7Chv/8s69heY5xRBYOLRAgMBAAGjUzBRMB0GA1UdDgQWBBTl\nX2hwfMS0Ps8Z/Z6uai8j6OCAtzAfBgNVHSMEGDAWgBTlX2hwfMS0Ps8Z/Z6uai8j\n6OCAtzAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQAJ7lF5nOoX\nfrGZS3O1HbfLshwS6zch/Y1qJ0tCtQ3FvJ1WWBCoq9R1xhQguPIJtX34jygURYmp\nYtEaE3OPfb1LiXrWf0yF+QbBYtuRdIHmzCm6gAgInep/qADnRD8HkReleHwnO8yT\naJL1TFopnb3AOuLiauf34w6z3OVFdtMuAh/CkI/BqgN94p0sJ9JSKQ3X50l6yRco\nhRmmKLzmCtiDq7+8xxskGn6qx0ohCvDzmARyuGiHC7Y/sLTeXbuT8003tsuKxGBz\nnJ74gkz0C8J9lgXkmQXDploGdT0zGJamsixAMKWF7p3zhzNleEtPskf4dSahUIi8\nOiE7s6pw7QkJ\n-----END CERTIFICATE-----",
    "expiresOn" : null
  } ],
  "connectCerts" : [ ],
  "shortName" : "ota2",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  } ],
  "tenant" : {
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : true,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : "https://connect3.url,https://connect4.url",
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : false,
  "selfApproval" : false,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.8.0",
  "instanceClusterSRListeners" : [ ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.20. Update an instance with environment mapping

A PATCH request is used to update an instance environmentMapping.

By default, environmentMapping for an instance is set to true.

When environmentMapping is false, we cannot map an environment to the instance.

23.20.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "environmentMapping" : false
}'

23.20.2. HTTP request

PATCH /instances/b9301e9144324928911f7d83ec40c478 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 34
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "environmentMapping" : false
}

23.20.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 7612

{
  "uid" : "b9301e9144324928911f7d83ec40c478",
  "properties" : {
    "min.insync.replicas" : "1",
    "create-stream.disable-time" : "1",
    "retention.ms" : "172800000",
    "num.partitions" : "3",
    "segment.ms" : "172800000",
    "replication.factor" : "2"
  },
  "name" : "TenantA OTA",
  "description" : "TenantA OTA Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : "https://schema.local3",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  }, {
    "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
    "expiresOn" : null
  } ],
  "connectCerts" : [ ],
  "shortName" : "ota",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "tenant" : {
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : true,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : "https://connect1.url,https://connect2.url",
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : true,
  "selfApproval" : false,
  "environmentMapping" : false,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.8.0",
  "instanceClusterSRListeners" : [ {
    "cluster" : {
      "name" : "Zone2ClusterOTA",
      "description" : "",
      "location" : "Zone2",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.4.0",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "",
      "uid" : "543c3b7d55634eba83b1472775c131c4"
    },
    "schemaRegistryListeners" : {
      "TLS" : "sr-url:24000"
    }
  }, {
    "cluster" : {
      "name" : "Zone1ClusterOTA",
      "description" : "",
      "location" : "Zone1",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ {
        "bootstrapServer" : "bootstrapserver1:9093"
      } ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : {
        "MUTUAL_TLS" : "broker:9090"
      },
      "kafkaVersion" : "3.5.1",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "bootstrapserver1:9093",
      "uid" : "66c12e25ab06458eac988f0d700fbe81"
    },
    "schemaRegistryListeners" : {
      "NO_AUTH" : "sr-url:25000",
      "TLS" : "sr-url:24000"
    }
  } ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.21. Update an instance with self-approval

A PATCH request is used to update an instance selfApproval.

By default, selfApproval for an instance is set to true.

When selfApproval is set to false, users are not permitted to approve their own application access grant requests.

23.21.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "selfApproval" : false
}'

23.21.2. HTTP request

PATCH /instances/b9301e9144324928911f7d83ec40c478 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 28
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "selfApproval" : false
}

23.21.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 7611

{
  "uid" : "b9301e9144324928911f7d83ec40c478",
  "properties" : {
    "min.insync.replicas" : "1",
    "create-stream.disable-time" : "1",
    "retention.ms" : "172800000",
    "num.partitions" : "3",
    "segment.ms" : "172800000",
    "replication.factor" : "2"
  },
  "name" : "TenantA OTA",
  "description" : "TenantA OTA Instance",
  "instanceClusters" : [ {
    "schemaRegistryUrls" : "https://schema.local3",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  }, {
    "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
    "providerInfo" : { },
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      },
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
    "expiresOn" : null
  } ],
  "connectCerts" : [ ],
  "shortName" : "ota",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "tenant" : {
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "_embedded" : {
    "supportTier" : {
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      }
    }
  },
  "connectEnabled" : true,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : "https://connect1.url,https://connect2.url",
  "ksmlEnabled" : false,
  "ksmlUrl" : null,
  "granularBrowsePermission" : true,
  "topicOwnerBrowsePermission" : true,
  "selfApproval" : false,
  "environmentMapping" : true,
  "authenticationInfo" : null,
  "schemaRegistryVersion" : "2.8.0",
  "instanceClusterSRListeners" : [ {
    "cluster" : {
      "name" : "Zone2ClusterOTA",
      "description" : "",
      "location" : "Zone2",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : { },
      "kafkaVersion" : "3.4.0",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "",
      "uid" : "543c3b7d55634eba83b1472775c131c4"
    },
    "schemaRegistryListeners" : {
      "TLS" : "sr-url:24000"
    }
  }, {
    "cluster" : {
      "name" : "Zone1ClusterOTA",
      "description" : "",
      "location" : "Zone1",
      "billingCloudEnabled" : true,
      "bootstrapServers" : [ {
        "bootstrapServer" : "bootstrapserver1:9093"
      } ],
      "settings" : { },
      "providerType" : "apache-kafka",
      "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
      "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
      "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
      "kafkaListeners" : {
        "MUTUAL_TLS" : "broker:9090"
      },
      "kafkaVersion" : "3.5.1",
      "multiTenant" : true,
      "kafkaCluster" : true,
      "multiEnvironment" : true,
      "bootstrapUrls" : "bootstrapserver1:9093",
      "uid" : "66c12e25ab06458eac988f0d700fbe81"
    },
    "schemaRegistryListeners" : {
      "NO_AUTH" : "sr-url:25000",
      "TLS" : "sr-url:24000"
    }
  } ],
  "certificateReusePreventionLevel" : "None",
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "tenant" : {
      "href" : "...",
      "title" : "A tenant"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "synchronize" : {
      "href" : "..."
    },
    "byok" : {
      "href" : "..."
    }
  }
}

23.22. Update CertificateReusePreventionLevel of an instance

A PATCH request is used to update the CertificateReusePreventionLevel field of an instance. The supported levels are NONE (default value), INSTANCE and TENANT.

Please note that by updating the certificate reuse prevention level, no validation will be applied at the updating time, but after making this update, the check will apply to any newly added certificate based on the prevention level. When the value is updated to INSTANCE means that certificates need to be unique within the Instance scope and when it’s updated to TENANT means that certificates need to be unique within the Tenant scope.

23.23. Update DistributionConfig of an instance

A PATCH request is used to update the distributionconfig field of an instanceCluster. While updating username of the connectConfig it is also required to provide the password in the request and vice versa. While updating certificate of the kafkaConfig it is also required to provide the privateKey in the request and vice versa.

23.23.1. Curl request

$ curl 'http://api.example.com/instances/ae301e9144324928911f7d83ec40f345/clusters/9gr818181cd44798ab70322830800dbc/distribution' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "distributionUrl" : "http://distributor:8081",
  "kafkaCredentials" : {
    "authenticationType" : "MTLS",
    "certificate" : "updatedCertificate",
    "privateKey" : "updatedPrivatekey"
  },
  "connectCredentials" : {
    "authenticationType" : "basic_auth",
    "username" : "updatedUsername",
    "password" : "updatedPassword"
  },
  "properties" : {
    "description" : "Nice",
    "updatedProp" : null
  }
}'

23.23.2. HTTP request

PATCH /instances/ae301e9144324928911f7d83ec40f345/clusters/9gr818181cd44798ab70322830800dbc/distribution HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 418
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "distributionUrl" : "http://distributor:8081",
  "kafkaCredentials" : {
    "authenticationType" : "MTLS",
    "certificate" : "updatedCertificate",
    "privateKey" : "updatedPrivatekey"
  },
  "connectCredentials" : {
    "authenticationType" : "basic_auth",
    "username" : "updatedUsername",
    "password" : "updatedPassword"
  },
  "properties" : {
    "description" : "Nice",
    "updatedProp" : null
  }
}

23.23.3. HTTP response

HTTP/1.1 204 No Content

23.24. Get Distribution Status of an instance

A GET request is used to get the status of a Distribution.

23.24.1. Curl request

$ curl 'http://api.example.com/instances/we341e9144324928911f7d83ec40f123/distributions/message-distribution-from-BYOKClusterForCC-to-BYOKClusterForApacheKafka/status' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

23.24.2. HTTP request

GET /instances/we341e9144324928911f7d83ec40f123/distributions/message-distribution-from-BYOKClusterForCC-to-BYOKClusterForApacheKafka/status HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

23.24.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 139

{
  "status" : "RUNNING",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

23.25. Start a Distribution of an instance

A POST request is used to start a Distribution.

23.25.1. Curl request

$ curl 'http://api.example.com/instances/sh708e9144324928911f7d83ec40f345/distributions/message-distribution-from-BYOKReplica1ForApacheKafka-to-BYOKReplica2ForApacheKafka/start' -i -X POST \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'

23.25.2. HTTP request

POST /instances/sh708e9144324928911f7d83ec40f345/distributions/message-distribution-from-BYOKReplica1ForApacheKafka-to-BYOKReplica2ForApacheKafka/start HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
Content-Type: application/x-www-form-urlencoded

23.25.3. HTTP response

HTTP/1.1 204 No Content

23.26. Stop a Distribution of an instance

A POST request is used to stop a Distribution.

23.26.1. Curl request

$ curl 'http://api.example.com/instances/sh708e9144324928911f7d83ec40f345/distributions/message-distribution-from-BYOKReplica1ForApacheKafka-to-BYOKReplica2ForApacheKafka/stop' -i -X POST \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'

23.26.2. HTTP request

POST /instances/sh708e9144324928911f7d83ec40f345/distributions/message-distribution-from-BYOKReplica1ForApacheKafka-to-BYOKReplica2ForApacheKafka/stop HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
Content-Type: application/x-www-form-urlencoded

23.26.3. HTTP response

HTTP/1.1 200 OK

23.27. Synchronize an instance

A synchronize operation is defined as the process of (re)-deploying all streams that are linked to this instance on the Kafka clusters. This effectively syncs the configuration stored in the database to every Kafka cluster that is part of this instance.

The process involves identifying all environments that are linked to this instance. For each environment, streams that have valid configurations (StreamConfig) are identified and deployed on the cluster.

This is a high-risk operation only allowed for certain roles. Check with your administrator for more details.

A POST request on /instances/uid/synchronize is used to synchronize an instance. When successful, a 204 No content response is returned. Depending on the number of streams that need to be synced, allow at least 30 seconds for the operation to complete.

23.27.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478/synchronize' -i -X POST \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'

23.27.2. HTTP request

POST /instances/b9301e9144324928911f7d83ec40c478/synchronize HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
Content-Type: application/x-www-form-urlencoded

23.27.3. HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

23.28. Delete Instance endpoints

Deleting an instance is a two-step process, a GET request to check the constraints followed by the DELETE request.

23.28.1. Delete instance constraints

A GET request is used to get the constraints for deleting an instance.The constraint indicates that an instance could be deleted if there are no environments defined for it.

Curl request
$ curl 'http://api.example.com/instances/12xc670e77b142a48f55f04ca5554807/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /instances/12xc670e77b142a48f55f04ca5554807/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 82

{
  "canDelete" : true,
  "activeEnvironmentsCount" : 0,
  "envShortNames" : [ ]
}

23.28.2. Delete an instance

A DELETE request is used to delete an instance.

Curl request
$ curl 'http://api.example.com/instances/12xc670e77b142a48f55f04ca5554807' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
HTTP request
DELETE /instances/12xc670e77b142a48f55f04ca5554807 HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

23.29. Delete Schema Registry details for Instance Cluster

A DELETE request is used to create a schema registry details for an instance cluster.

23.29.1. Curl request

$ curl 'http://api.example.com/instances/b9301e9144324928911f7d83ec40c478/clusters/66c12e25ab06458eac988f0d700fbe81/schema-registry' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'

23.29.2. HTTP request

DELETE /instances/b9301e9144324928911f7d83ec40c478/clusters/66c12e25ab06458eac988f0d700fbe81/schema-registry HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

23.29.3. HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

23.30. Instance search endpoints

23.30.1. /instances/search/findByName

Search for an instance by exact name.

Query parameters
Parameter Description

name

Instance name to search for.
HTTP request
GET /instances/search/findByName?name=TenantA+OTA HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 5217

{
  "properties" : {
    "replication.factor" : "2",
    "num.partitions" : "3",
    "create-stream.disable-time" : "1",
    "min.insync.replicas" : "1",
    "retention.ms" : "172800000",
    "segment.ms" : "172800000"
  },
  "name" : "TenantA OTA",
  "description" : "TenantA OTA Instance",
  "instanceClusters" : [ {
    "ksmlProvisioners" : [ ],
    "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "schemaRegistryVersion" : "2.8.0",
    "instanceClusterSrListener" : {
      "NO_AUTH" : "sr-url:25000",
      "TLS" : "sr-url:24000"
    },
    "srProperties" : null,
    "srKeycloakDetails" : null,
    "ksmlUrl" : null,
    "singleKsmlProvisioner" : null,
    "uid" : "IC-0000000002",
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      }
    }
  }, {
    "ksmlProvisioners" : [ ],
    "schemaRegistryUrls" : "https://schema.local3",
    "schemaRegistryType" : "Confluent",
    "distributionConfig" : null,
    "schemaRegistryVersion" : "2.8.0",
    "instanceClusterSrListener" : {
      "TLS" : "sr-url:24000"
    },
    "srProperties" : { },
    "srKeycloakDetails" : null,
    "ksmlUrl" : null,
    "singleKsmlProvisioner" : null,
    "uid" : "IC-0000000003",
    "_links" : {
      "cluster" : {
        "href" : "...",
        "title" : "A cluster"
      }
    }
  } ],
  "caCerts" : [ {
    "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
    "expiresOn" : null
  } ],
  "connectCerts" : [ ],
  "shortName" : "ota",
  "enabledAuthenticationMethods" : [ {
    "rank" : 0,
    "protocol" : "SSL",
    "mechanism" : "MUTUAL_TLS"
  }, {
    "rank" : 1,
    "protocol" : "SASL",
    "mechanism" : "SCRAM_SHA_256"
  }, {
    "rank" : 2,
    "protocol" : "SASL",
    "mechanism" : "OAUTH_BEARER"
  } ],
  "connectEnabled" : true,
  "connectLoggingSupportEnabled" : false,
  "connectUrls" : "https://connect1.url,https://connect2.url",
  "granularBrowsePermission" : true,
  "environmentMapping" : true,
  "settings" : {
    "environmentMapping" : "true",
    "connectEnabled" : "true",
    "granularBrowsePermission" : "true",
    "connectLoggingSupportEnabled" : "false",
    "certificateReusePrevention" : "NONE",
    "topicOwnerBrowsePermission" : "true"
  },
  "ksmlEnabled" : false,
  "selfApprovalEnabled" : true,
  "ksmlProvisioner" : null,
  "ksmlUrl" : null,
  "uid" : "b9301e9144324928911f7d83ec40c478",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "supportTier" : {
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null
    }
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "instance" : {
      "href" : "...",
      "templated" : true,
      "title" : "An instance"
    },
    "byok" : {
      "href" : "..."
    },
    "supportTier" : {
      "href" : "...",
      "templated" : true
    }
  }
}

23.30.2. /instances/search/findByNameContaining

Search for an instance by name containing search term.

Query parameters
Parameter Description

name

Term to search within instance name.
HTTP request
GET /instances/search/findByNameContaining?name=aeb HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 259

{
  "_embedded" : {
    "instances" : [ ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 0,
    "totalPages" : 0,
    "number" : 0
  }
}

This endpoint is used to check the availability of the running connector. This endpoint is currently used by billing.

Curl request
$ curl 'http://api.example.com/connect/nodes/availability' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "applicationType" : "CONNECTOR",
  "connectUrls" : [ "https://connect2.url" ],
  "instanceName" : "dta",
  "tenantName" : "tenanta"
}'
HTTP request
POST /connect/nodes/availability HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 137
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationType" : "CONNECTOR",
  "connectUrls" : [ "https://connect2.url" ],
  "instanceName" : "dta",
  "tenantName" : "tenanta"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 142

{
  "applicationType" : "CONNECTOR",
  "applicationAvailabilityStatus" : {
    "https://connect2.url" : {
      "available" : true
    }
  }
}

This endpoint is used to check the status of the list of running connectors. This endpoint is currently used by billing.

Curl request
$ curl 'http://api.example.com/connect/applications/status' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "applicationType" : "CONNECTOR",
  "connectUrls" : [ "https://connect2.url" ],
  "instanceName" : "dta",
  "tenantName" : "tenanta"
}'
HTTP request
POST /connect/applications/status HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 137
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationType" : "CONNECTOR",
  "connectUrls" : [ "https://connect2.url" ],
  "instanceName" : "dta",
  "tenantName" : "tenanta"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 313

{
  "applicationType" : "CONNECTOR",
  "connectAppStatusList" : [ {
    "name" : "axual-qa-message-distributor",
    "connectorClass" : "io.axual.distributor.message.MessageDistributor",
    "status" : "RUNNING",
    "tasks" : [ {
      "id" : 0,
      "state" : "RUNNING",
      "workerId" : null
    } ]
  } ]
}

24. ConnectPlugins

A ConnectPlugin stores the plugin class, type, version, and optional config explanation available for an Instance.

The /connect_plugins resource is used to return a unique list of connector plugins, not bound to any environment (axual-connect instance).

24.1. List all connect plugins

A GET request will list all the plugins available regardless of the plugin version to the currently logged-in user.

24.1.1. Curl request

$ curl 'http://api.example.com/connect_plugins' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

24.1.2. HTTP request

GET /connect_plugins HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

24.1.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 3805

{
  "_embedded" : {
    "connect_plugins" : [ {
      "_links" : {
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "instance" : {
        "_links" : {
          "supportTier" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "tenant" : {
          "_links" : {
            "contact" : {
              "href" : "...",
              "templated" : true,
              "title" : "Business contact of this tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "shortName" : "tenanta"
        },
        "shortName" : "ota"
      },
      "pluginConfigs" : [ {
        "name" : "name",
        "type" : "STRING",
        "required" : true
      }, {
        "name" : "logger.name",
        "type" : "STRING",
        "required" : true
      }, {
        "name" : "key.converter",
        "type" : "CLASS",
        "required" : true
      }, {
        "name" : "connector.class",
        "type" : "STRING",
        "required" : true
      }, {
        "name" : "tasks.max",
        "type" : "INT",
        "required" : true
      }, {
        "name" : "transforms",
        "type" : "LIST",
        "required" : true
      } ],
      "pluginClass" : "io.axual.test.sink.plugin",
      "pluginType" : "SINK",
      "uid" : "197691609c2fe4f129cfc79f18d5d1269",
      "created_at" : "2020-05-28T10:56:23",
      "modified_at" : "2020-05-28T10:56:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "instance" : {
        "_links" : {
          "supportTier" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "tenant" : {
          "_links" : {
            "contact" : {
              "href" : "...",
              "templated" : true,
              "title" : "Business contact of this tenant"
            },
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            }
          },
          "shortName" : "tenanta"
        },
        "shortName" : "ota"
      },
      "pluginConfigs" : [ {
        "name" : "tasks.max",
        "type" : "INT",
        "required" : true
      } ],
      "pluginClass" : "io.axual.test.source.plugin",
      "pluginType" : "SOURCE",
      "uid" : "427691609c2f20f129bd179f45d5d1269",
      "created_at" : "2020-05-28T10:56:23",
      "modified_at" : "2020-05-28T10:56:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    }
  },
  "page" : {
    "size" : 2,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

24.2. List all environments relevant for an application

A GET request will list all the environments that are relevant for the application with the status of connector on those environments . Only the environments that support the application’s configured pluginClass and are accessible to the user are returned.

24.2.1. Curl request

$ curl 'http://api.example.com/connect_plugins/search/findEnvironmentsByApplication?application=http%3A%2F%2Flocalhost%2Fapplications%2Fdbc9e4670h1c4866deg78722e2930d2g' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

24.2.2. HTTP request

GET /connect_plugins/search/findEnvironmentsByApplication?application=http%3A%2F%2Flocalhost%2Fapplications%2Fdbc9e4670h1c4866deg78722e2930d2g HTTP/1.1
Content-Type: application/json
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

24.2.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 72298

{
  "_embedded" : {
    "environmentWithStatuses" : [ {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv3",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv3",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "156ab08009fe4da8be6905b55552ab63",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "envdefault",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "envdefault",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "156ab08009fe4da96e6905b55552ab63",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv9_with_revoked_app_access_only",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv9",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just revoked app_access configured",
          "uid" : "3b7963da58d7445bbf7a900782713069",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv7_with_app_access_only",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv7",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_access configured",
          "uid" : "48dd87236ec445138330adb1a8a79f7e",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv_with_viewer_groups",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv11",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with viewer groups",
          "uid" : "4c9863da58d7445bbf7a900782713069",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv_no_streams_2",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvns2",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "5e7e07b5e7784baf8dcebe1b03d5d410",
          "created_at" : "2022-10-31T23:16:23",
          "modified_at" : "2022-10-31T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv8_with_app_credential_only",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv8",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_credential configured",
          "uid" : "73f73e189c49430fbf1d8cc7494d24d4",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv9_with_app_principal_and_credential",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantapublicenv9",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with app access and grant configured",
          "uid" : "73f73e918d49430fbf1d8cc7494d24d4",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv_no_streams",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvns",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "a5f2383ccce249459b24b7cb189b40bc",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv4",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv4",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "aa1ee2dd976647109ca904dd8adc050f",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv5",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv5",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "bb5be2dd976647109ca904dd8adc050f",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv_with_viewer_groups_2",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team with env viewer group",
            "emailAddress" : null,
            "uid" : "5c25a483f9af4275c6eb67123f6baa9b",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv12",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with viewer groups 2",
          "uid" : "c7031f7bd5a9782db8307460486945a9",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv2",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv2",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "e11ee2dd976647109ca904dd8adc050f",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenv6_with_app_principal",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv6",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_principal configured",
          "uid" : "e26e0006c5504351a58e3181066cf56a",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenanta_oublic_env_masking_enforced",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaMSK",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with settings",
          "uid" : "ENV-tenanta-public-masking_enforced",
          "created_at" : "2024-06-07T23:16:23",
          "modified_at" : "2024-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    }, {
      "status" : "Undefined",
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            }
          },
          "name" : "tenantaenvresourcemanagers",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team with two resource managers",
            "emailAddress" : null,
            "uid" : "GroupWithTwoResourceManagers0000",
            "created_at" : "2025-06-07T23:16:23",
            "modified_at" : "2025-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvresourcema",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "envOfResourceManagers00",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

25. Confidentialities

Defines the available confidentiality level for a tenant.

As an example following can be the confidentiality levels: - C=0: Public. - C=1: Internal use. - C=2: Confidential. - C=3: Secret.

These levels can then be associated to the streams for the tenant. The purpose of this is to define how confidential the messages on the stream are.

25.1. List all confidentiality

A GET request lists all tenants in the system. This operation can be done by any authenticated user for the tenant.

25.1.1. Curl request

$ curl 'http://api.example.com/confidentialities' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

25.1.2. HTTP request

GET /confidentialities HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

25.1.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1763

{
  "_embedded" : {
    "confidentialities" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        }
      },
      "level" : "L1",
      "color" : "blue",
      "description" : "test confidentiality",
      "uid" : "347ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        }
      },
      "level" : "L2",
      "color" : "blue",
      "description" : "L2 confidentiality",
      "uid" : "648ab08009fe4da8be6905b55552ac43",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

25.2. Create confidentiality

A POST request is used to create a new confidentiality level. This operation can be done by a TENANT_ADMIN only.

25.2.1. Request fields

Path Type Description Constraints

level

String

The name of the level

Size must be between 0 and 50 inclusive

description

String

The description of the level.

Size must be between 0 and 200 inclusive

color

String

The colour of the level.

Size must be between 0 and 12 inclusive

25.2.2. Curl request

$ curl 'http://api.example.com/confidentialities' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "level" : "L2",
  "description" : "This is Level 2",
  "color" : "blue"
}'

25.2.3. HTTP request

POST /confidentialities HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 77
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "level" : "L2",
  "description" : "This is Level 2",
  "color" : "blue"
}

25.2.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 08:12:26 GMT
Location: http://api.example.com/confidentialities/7f796c2ec37e4e21ba2dd00ce3d919cc
Content-Type: application/hal+json
Content-Length: 772

{
  "level" : "l2",
  "description" : "This is Level 2",
  "color" : "blue",
  "uid" : "7f796c2ec37e4e21ba2dd00ce3d919cc",
  "created_at" : "2025-06-25T08:12:26.84806854",
  "modified_at" : "2025-06-25T08:12:26.84806854",
  "created_by" : "tenadmin@tenanta.nl",
  "modified_by" : "tenadmin@tenanta.nl",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "confidentiality" : {
      "href" : "...",
      "templated" : true,
      "title" : "The confidentiality configured for the object"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    }
  }
}

25.3. Retrieve confidentiality

The confidentiality/{id} item resource is used to retrieve, update and delete individual confidentiality level.

A GET request will retrieve the details of a Confidentiality level. This operation can be done by any authenticated user for the tenant.

25.3.1. Curl request

$ curl 'http://api.example.com/confidentialities/347ab08009fe4da8be6905b55552ab52' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

25.3.2. HTTP request

GET /confidentialities/347ab08009fe4da8be6905b55552ab52 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

25.3.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 725

{
  "level" : "L1",
  "description" : "test confidentiality",
  "color" : "blue",
  "uid" : "347ab08009fe4da8be6905b55552ab52",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "confidentiality" : {
      "href" : "...",
      "templated" : true,
      "title" : "The confidentiality configured for the object"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    }
  }
}
Relation Description

edit

Existence of this link indicates that the currently authenticated user can edit this Confidentiality level

delete

Existence of this link indicates that the currently authenticated user can delete this confidentiality level

25.4. Update confidentiality

A PATCH request is used to update a tenant. Only a TENANT_ADMIN can perform this action.

$ curl 'http://api.example.com/confidentialities/347ab08009fe4da8be6905b55552ab52' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "description" : "Updated description"
}'
PATCH /confidentialities/347ab08009fe4da8be6905b55552ab52 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 43
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "description" : "Updated description"
}
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
Content-Type: application/hal+json
Content-Length: 724

{
  "level" : "L1",
  "description" : "Updated description",
  "color" : "blue",
  "uid" : "347ab08009fe4da8be6905b55552ab52",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "confidentiality" : {
      "href" : "...",
      "templated" : true,
      "title" : "The confidentiality configured for the object"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    }
  }
}

25.5. Delete confidentiality

Deleting confidentiality is a two step process a GET request to check the constraints followed by the DELETE request

25.5.1. Delete confidentiality constraints

A GET request is used to get the constraints for deleting Confidentiality. Only a TENANT_ADMIN can perform this

$ curl 'http://api.example.com/confidentialities/648ab08009fe4da8be6905b55552ac43/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /confidentialities/648ab08009fe4da8be6905b55552ac43/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 47

{
  "canDelete" : false,
  "streamsCount" : 1
}

25.5.2. Delete confidentiality

A DELETE request is used to delete a Confidentiality. Only a TENANT_ADMIN can perform this

$ curl 'http://api.example.com/confidentialities/347ab08009fe4da8be6905b55552ab52' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
DELETE /confidentialities/347ab08009fe4da8be6905b55552ab52 HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

26. Integrities

Define the available integrity level for a tenant. These levels can then be associated to the streams for the tenant.

26.1. List all integrity

A GET request will list all the integrities in the system. This operation can be done by a TENANT_ADMIN only.

26.1.1. Curl request

$ curl 'http://api.example.com/integrities' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

26.1.2. HTTP request

GET /integrities HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

26.1.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1728

{
  "_embedded" : {
    "integrities" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        }
      },
      "level" : "L2",
      "color" : "yellow",
      "description" : "This is level 2",
      "uid" : "247ab03ffafe4da2bet905b5e352ab53",
      "created_at" : "2019-06-08T23:16:23",
      "modified_at" : "2019-06-08T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        }
      },
      "level" : "L1",
      "color" : "green",
      "description" : "This is level 1",
      "uid" : "247ab08159fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}
Relation Description

create

Existence of this link indicates thatthe currently authenticated user can create Integrity level

26.2. Create integrity

A POST request is used to create a new integrity level. This operation can be done by a TENANT_ADMIN only.

Below table lists all possible fields that can be provided for integrity level creation.

26.2.1. Request fields

Path Type Description Constraints

level

String

The level of the integrity level

Size must be between 0 and 50 inclusive

description

String

The description of the integrity level

Size must be between 0 and 200 inclusive

color

String

The color of the integrity level

Size must be between 0 and 12 inclusive

26.2.2. Curl request

$ curl 'http://api.example.com/integrities' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "level" : "Level 1",
  "description" : "This is level 1",
  "color" : "green"
}'

26.2.3. HTTP request

POST /integrities HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 83
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "level" : "Level 1",
  "description" : "This is level 1",
  "color" : "green"
}

26.2.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 08:12:29 GMT
Location: http://api.example.com/integrities/e3d70ae4a0054d2e9582c284e42885e5
Content-Type: application/hal+json
Content-Length: 768

{
  "level" : "level 1",
  "description" : "This is level 1",
  "color" : "green",
  "uid" : "e3d70ae4a0054d2e9582c284e42885e5",
  "created_at" : "2025-06-25T08:12:29.653207381",
  "modified_at" : "2025-06-25T08:12:29.653207381",
  "created_by" : "tenadmin@tenanta.nl",
  "modified_by" : "tenadmin@tenanta.nl",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "integrity" : {
      "href" : "...",
      "templated" : true,
      "title" : "The integrity configured for the object"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    }
  }
}

26.3. Retrieve an integrity

The integrity/{id} item resource is used to retrieve, update and delete individual integrity level.

A GET request will retrieve the details of an integrity.

26.3.1. Curl request

$ curl 'http://api.example.com/integrities/247ab08159fe4da8be6905b55552ab52' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

26.3.2. HTTP request

GET /integrities/247ab08159fe4da8be6905b55552ab52 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

26.3.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 709

{
  "level" : "L1",
  "description" : "This is level 1",
  "color" : "green",
  "uid" : "247ab08159fe4da8be6905b55552ab52",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "integrity" : {
      "href" : "...",
      "templated" : true,
      "title" : "The integrity configured for the object"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    }
  }
}
Relation Description

edit

Existence of this link indicates thatthe currently authenticated user can edit this Integrity level

delete

Existence of this link indicates that the currently authenticated user can delete this Integrity level

26.4. Update an integrity

A PATCH request is used to update an integrity. Only a TENANT_ADMIN can perform this action.

$ curl 'http://api.example.com/integrities/247ab08159fe4da8be6905b55552ab52' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "description" : "Updated description",
  "color" : "purple",
  "level" : "level-one"
}'
PATCH /integrities/247ab08159fe4da8be6905b55552ab52 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 90
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "description" : "Updated description",
  "color" : "purple",
  "level" : "level-one"
}
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
Content-Type: application/hal+json
Content-Length: 721

{
  "level" : "level-one",
  "description" : "Updated description",
  "color" : "purple",
  "uid" : "247ab08159fe4da8be6905b55552ab52",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "integrity" : {
      "href" : "...",
      "templated" : true,
      "title" : "The integrity configured for the object"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    }
  }
}

26.5. Delete integrity endpoints

Deleting integrity is a two step process, a GET request to check the constraints followed by the DELETE request. This operation can be done by a TENANT_ADMIN only.

26.5.1. Delete integrity constraints

A GET request is used to get the constraints for deleting integrities.

$ curl 'http://api.example.com/integrities/247ab03ffafe4da2bet905b5e352ab53/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /integrities/247ab03ffafe4da2bet905b5e352ab53/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 47

{
  "canDelete" : false,
  "streamsCount" : 1
}

26.5.2. Delete integrity

A DELETE request is used to delete a integrity.

$ curl 'http://api.example.com/integrities/247ab08159fe4da8be6905b55552ab52' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
DELETE /integrities/247ab08159fe4da8be6905b55552ab52 HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

27. Environments

An Environment represents a functional group of servers that is specific to a Tenant. It is usually grouped based on functional use e.g. System testing, Acceptance testing, Production and others.

Every environment must be linked to an existing Instance before it can be considered ready for business use. This can only be done by an Axual admin user.

The environments collection resource is used to create and list Environments.

27.1. Environment Schema

The environments resource uses the following json-schema:

GET /profile/environments HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 2922

{
  "title" : "Environment",
  "definitions" : { },
  "properties" : {
    "partitions" : {
      "title" : "Partitions",
      "readOnly" : false,
      "type" : "integer"
    },
    "settings" : {
      "title" : "Settings",
      "readOnly" : true,
      "type" : "object"
    },
    "authorizationIssuer" : {
      "title" : "Authorization issuer",
      "readOnly" : false,
      "type" : "string",
      "enum" : [ "Stream owner", "Auto" ]
    },
    "private" : {
      "title" : "Private",
      "readOnly" : true,
      "type" : "boolean"
    },
    "instance" : {
      "title" : "Instance",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "color" : {
      "title" : "Color",
      "readOnly" : false,
      "type" : "string"
    },
    "visibility" : {
      "title" : "Visibility",
      "readOnly" : false,
      "type" : "string",
      "enum" : [ "public", "private" ]
    },
    "ksmlEnabled" : {
      "title" : "Ksml enabled",
      "readOnly" : true,
      "type" : "boolean"
    },
    "streamOwnerAuthorizer" : {
      "title" : "Stream owner authorizer",
      "readOnly" : true,
      "type" : "boolean"
    },
    "description" : {
      "title" : "Description",
      "readOnly" : false,
      "type" : "string"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "owners" : {
      "title" : "Owners",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "retentionTime" : {
      "title" : "Retention time",
      "readOnly" : false,
      "type" : "integer"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "autoApproved" : {
      "title" : "Auto approved",
      "readOnly" : true,
      "type" : "boolean"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "viewers" : {
      "title" : "Viewers",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "name" : {
      "title" : "Name",
      "readOnly" : false,
      "type" : "string"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "shortName" : {
      "title" : "Short name",
      "readOnly" : false,
      "type" : "string"
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "apicurioKeycloakEnabledForAnyInstanceCluster" : {
      "title" : "Apicurio keycloak enabled for any instance cluster",
      "readOnly" : true,
      "type" : "boolean"
    },
    "properties" : {
      "title" : "Properties",
      "readOnly" : true,
      "type" : "object"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

27.2. List all environments

A GET request will list all the environments visible to the currently logged-in user.

27.2.1. Curl request

$ curl 'http://api.example.com/environments' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

27.2.2. HTTP request

GET /environments HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

27.2.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 37939

{
  "_embedded" : {
    "environments" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv3",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv3",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "156ab08009fe4da8be6905b55552ab63",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "envdefault",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "envdefault",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "156ab08009fe4da96e6905b55552ab63",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv9_with_revoked_app_access_only",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv9",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with just revoked app_access configured",
      "uid" : "3b7963da58d7445bbf7a900782713069",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv10",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenantaenv22",
        "emailAddress" : null,
        "uid" : "66625b8c334d48ac88abff939e9cf453",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv10",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "3gr4e2046dad49468e0848571982a4b8",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaprivenv1",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaprivenv1",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment",
      "uid" : "46cfaf47d2d04d12923beefac3d0ba5a",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv7_with_app_access_only",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv7",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with just app_access configured",
      "uid" : "48dd87236ec445138330adb1a8a79f7e",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv_with_viewer_groups",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv11",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with viewer groups",
      "uid" : "4c9863da58d7445bbf7a900782713069",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv_no_streams_2",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenvns2",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "5e7e07b5e7784baf8dcebe1b03d5d410",
      "created_at" : "2022-10-31T23:16:23",
      "modified_at" : "2022-10-31T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaprivenv2",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaprivenv2",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment",
      "uid" : "61b1b34b0c6744dcadb85f4c188517e5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaprivenv5",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Kad",
        "emailAddress" : null,
        "uid" : "514d4e9a834841869644c2ad8b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaprivenv5",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment",
      "uid" : "6u2577bclboz97ievex0fv5hvysemooh",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaprivenv3",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaprivenv3",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment",
      "uid" : "72c1b34b0c6744dcadb85f4c188518f6",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv8_with_app_credential_only",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv8",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with just app_credential configured",
      "uid" : "73f73e189c49430fbf1d8cc7494d24d4",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv9_with_app_principal_and_credential",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantapublicenv9",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with app access and grant configured",
      "uid" : "73f73e918d49430fbf1d8cc7494d24d4",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaprivenv4",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaprivenv4",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment",
      "uid" : "83c1b34b0c6744dcadb85f4c188518g5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaprivenv6",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Kad",
        "emailAddress" : null,
        "uid" : "514d4e9a834841869644c2ad8b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaprivenv6",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment",
      "uid" : "8fe4bc6b01bc4ff39ac9769ffe1fb77f",
      "created_at" : "2022-09-06T10:00:00",
      "modified_at" : "2022-09-06T10:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv_only_app_grant",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenvgrant",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment with just application_access_grant and no mapping to application_access",
      "uid" : "92b521d4411942ca82b33782ddf50edd",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaprivenv7",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaprivenv7",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment with application_access_grant and mapping to application_access",
      "uid" : "a5f2383420e249459b24b7cb189b40bc",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv_no_streams",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenvns",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "a5f2383ccce249459b24b7cb189b40bc",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv4",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication2",
        "emailAddress" : null,
        "uid" : "88eb98e0eff34fde923c15687e6d75d5",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv4",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "aa1ee2dd976647109ca904dd8adc050f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 29,
    "totalPages" : 2,
    "number" : 0
  }
}
Relation Description

create

Existence of this link indicates that the currently authenticated user can create a new Environment

27.3. Create environment

A POST request is used to create a new environment. The fields authorizationIssuer and visibility are currently optional and can be ignored while creating a new Environment. By default, authorizationIssuer will be set to Stream owner and visibility will be set to Public.

Below table lists all possible fields that can be provided for environment creation.

27.3.1. Request fields

Path Type Description Constraints

name

String

The name of the environment

Must match the regular expression (?i)^[a-z0-9\.\-_ ]+$. Must not be empty. Size must be between 3 and 50 inclusive

shortName

String

The short name of the environment. Used in stream names internally. Must be lower-case.

Must match the regular expression (?i)^[a-z][a-z0-9]*$. Must not be empty. Size must be between 1 and 20 inclusive

owners

String

A valid URI of an existing group, must not be null.

Must not be null

viewers

Array

A valid list of URI of existing groups. It is used to give view authority on the StreamConfig and Application-configurationwhich are configured on this environment.

description

String

Human-readable text describing the environment

Size must be between 0 and 200 inclusive

properties

Object

A list of Tenant specific variables in Key,Value format.

color

String

A string color value assigned to this environment.

Size must be between 0 and 12 inclusive

authorizationIssuer

String

An entity that authorizes ApplicationAccess on this environment. Possible values are Stream owner and Automatic. Must be Automatic if visibility is Private. If not specified, default value is Stream owner

visibility

String

Defines the visibility of this environment. Possible values are Public and Private. If not specified, default value is Public

instance

String

A valid Instance URI where this environment should be deployed.

retentionTime

Number

The time in milliseconds after which the messages can be deleted from all streams. This is an optional field. If not specified, default value is 7 days (604800000).

partitions

Number

Defines the number of partitions configured for every stream of this tenant. This is an optional field. If not specified, default value is 12

settings

Object

A list of Environment specific settings in Key,Value format.

27.3.2. Curl request

$ curl 'http://api.example.com/environments' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "KAD Test",
  "shortName" : "kad",
  "description" : "This is KAD test environment",
  "retentionTime" : 90000,
  "partitions" : 8,
  "authorizationIssuer" : "Stream owner",
  "visibility" : "Public",
  "instance" : "http://api.example.com/instances/b9301e9144324928911f7d83ec40c478",
  "owners" : "http://api.example.com/groups/aac290536035440e9a85f193e4affeb3",
  "viewers" : [ "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775" ],
  "properties" : {
    "stream.integrity" : "2",
    "stream.confidentiality" : "3"
  },
  "settings" : {
    "enforceDataMasking" : "true"
  }
}'

27.3.3. HTTP request

POST /environments HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 606
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "KAD Test",
  "shortName" : "kad",
  "description" : "This is KAD test environment",
  "retentionTime" : 90000,
  "partitions" : 8,
  "authorizationIssuer" : "Stream owner",
  "visibility" : "Public",
  "instance" : "http://api.example.com/instances/b9301e9144324928911f7d83ec40c478",
  "owners" : "http://api.example.com/groups/aac290536035440e9a85f193e4affeb3",
  "viewers" : [ "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775" ],
  "properties" : {
    "stream.integrity" : "2",
    "stream.confidentiality" : "3"
  },
  "settings" : {
    "enforceDataMasking" : "true"
  }
}

27.3.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 06:14:54 GMT
Location: http://api.example.com/environments/01c0445fa29342c1b427755850336017
Content-Type: application/hal+json
Content-Length: 6355

{
  "name" : "KAD Test",
  "properties" : {
    "stream.integrity" : "2",
    "stream.confidentiality" : "3"
  },
  "private" : false,
  "settings" : {
    "enforceDataMasking" : "true"
  },
  "authorizationIssuer" : "Stream owner",
  "uid" : "01c0445fa29342c1b427755850336017",
  "shortName" : "kad",
  "color" : "#80affe",
  "retentionTime" : 90000,
  "partitions" : 8,
  "ksmlEnabled" : false,
  "description" : "This is KAD test environment",
  "autoApproved" : false,
  "created_at" : "2025-06-25T08:14:54.807859997",
  "modified_at" : "2025-06-25T08:14:54.807859997",
  "created_by" : "poweruser@tenanta.nl",
  "modified_by" : "poweruser@tenanta.nl",
  "visibility" : null,
  "_embedded" : {
    "instance" : {
      "name" : "TenantA OTA",
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "name" : "Zone2ClusterOTA",
          "tenant" : null,
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ],
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            }
          }
        },
        "schemaRegistryUrls" : "https://schema.local3"
      }, {
        "cluster" : {
          "name" : "Zone1ClusterOTA",
          "tenant" : null,
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            }
          }
        },
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2"
      } ],
      "shortName" : "ota",
      "description" : "TenantA OTA Instance",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "supportTier" : {
          "href" : "..."
        }
      },
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "owners" : {
      "name" : "Environment-tenAenv1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    },
    "viewers" : [ {
      "name" : "Application-tenAApplication1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    } ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "synchronize" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "environment" : {
      "href" : "...",
      "title" : "An environment"
    },
    "instance" : {
      "href" : "...",
      "title" : "An instance"
    },
    "viewers" : {
      "href" : "..."
    },
    "owners" : {
      "href" : "...",
      "title" : "The group responsible for this object"
    }
  }
}

27.3.5. Attempting to create environment on Instance with environmentMapping disabled

In case the Instance used by the Environment has environmentMapping=false, we return 400 Bad Request

HTTP response
HTTP/1.1 400 Bad Request
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 593

{
  "status" : "BAD_REQUEST",
  "message" : "Selected Instance has been restricted Environment mapping, please contact your Tenant Admin to create the Environment.",
  "errors" : [ "Selected Instance has been restricted Environment mapping, please contact your Tenant Admin to create the Environment." ],
  "subErrors" : [ {
    "field" : "errmsg.instance.environmentMapping.disabled",
    "rejectedValue" : null,
    "recommendedValues" : null,
    "errors" : [ "Selected Instance has been restricted Environment mapping, please contact your Tenant Admin to create the Environment." ]
  } ]
}

27.4. Retrieve an environment

The environments/{id} resource is used to retrieve, update and delete individual environments.

A GET request will retrieve the details of an environment.

27.4.1. Curl request

$ curl 'http://api.example.com/environments/46cfaf47d2d04d12923beefac3d0ba5a' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

27.4.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 5159

{
  "name" : "tenantaprivenv1",
  "properties" : { },
  "private" : true,
  "settings" : { },
  "authorizationIssuer" : "Auto",
  "uid" : "46cfaf47d2d04d12923beefac3d0ba5a",
  "shortName" : "tenantaprivenv1",
  "color" : "#80affe",
  "retentionTime" : 604800000,
  "partitions" : 12,
  "ksmlEnabled" : false,
  "description" : "environment",
  "autoApproved" : true,
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "visibility" : "private",
  "_embedded" : {
    "instance" : {
      "name" : "TenantA OTA",
      "settings" : {
        "environmentMapping" : "true",
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE",
        "topicOwnerBrowsePermission" : "true"
      },
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "name" : "Zone2ClusterOTA",
          "tenant" : null,
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ],
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            }
          }
        },
        "schemaRegistryUrls" : "https://schema.local3"
      }, {
        "cluster" : {
          "name" : "Zone1ClusterOTA",
          "tenant" : null,
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            }
          }
        },
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2"
      } ],
      "shortName" : "ota",
      "description" : "TenantA OTA Instance",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "supportTier" : {
          "href" : "..."
        }
      },
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "owners" : {
      "name" : "Environment-tenAenv1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    },
    "viewers" : [ ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "synchronize" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "environment" : {
      "href" : "...",
      "title" : "An environment"
    },
    "instance" : {
      "href" : "...",
      "title" : "An instance"
    },
    "viewers" : {
      "href" : "..."
    },
    "owners" : {
      "href" : "...",
      "title" : "The group responsible for this object"
    }
  }
}
Relation Description

instance

The Axual instance this environment is mapped to.

owners

The group of users allowed to access/update the environment.

edit

Existence of this link indicates that the currently authenticated user can edit this Environment

synchronize

Existence of this link indicates that currently authenticated user can synchronize this Environment.

27.5. Update an environment

Editing an Environment is a two-step process a GET request to check the constraints followed by the PATCH request. Some fields can only be updated if the constraints allow them. For example shortName, instance and visibility.

27.5.1. Get Edit environment constraints

A GET request is used to get the constraints for editing an environment.

$ curl 'http://api.example.com/environments/a5f2383ccce249459b24b7cb189b40bc/edit-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /environments/a5f2383ccce249459b24b7cb189b40bc/edit-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 117

{
  "canEditInstance" : true,
  "canEditShortName" : true,
  "canEditVisibility" : true,
  "streamConfigsCount" : 0
}

A PATCH request is used to update an environment. In the request, pass only the fields that need changing and ensure the fields can be updated in the constraints.

$ curl 'http://api.example.com/environments/46cfaf47d2d04d12923beefac3d0ba5a' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "description" : "Updated description"
}'
PATCH /environments/46cfaf47d2d04d12923beefac3d0ba5a HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 43
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "description" : "Updated description"
}
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 21:16:23 GMT
Location: http://api.example.com/environments/46cfaf47d2d04d12923beefac3d0ba5a
Content-Type: application/hal+json
Content-Length: 5176

{
  "name" : "tenantaprivenv1",
  "properties" : { },
  "private" : false,
  "settings" : { },
  "authorizationIssuer" : "Stream owner",
  "uid" : "46cfaf47d2d04d12923beefac3d0ba5a",
  "shortName" : "tenantaprivenv1",
  "color" : "#80affe",
  "retentionTime" : 604800000,
  "partitions" : 12,
  "ksmlEnabled" : false,
  "description" : "Updated description",
  "autoApproved" : false,
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "visibility" : "public",
  "_embedded" : {
    "instance" : {
      "name" : "TenantA OTA",
      "settings" : {
        "environmentMapping" : "true",
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE",
        "topicOwnerBrowsePermission" : "true"
      },
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "name" : "Zone2ClusterOTA",
          "tenant" : null,
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ],
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            }
          }
        },
        "schemaRegistryUrls" : "https://schema.local3"
      }, {
        "cluster" : {
          "name" : "Zone1ClusterOTA",
          "tenant" : null,
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            }
          }
        },
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2"
      } ],
      "shortName" : "ota",
      "description" : "TenantA OTA Instance",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "supportTier" : {
          "href" : "..."
        }
      },
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "owners" : {
      "name" : "Environment-tenAenv1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    },
    "viewers" : [ ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "synchronize" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "environment" : {
      "href" : "...",
      "title" : "An environment"
    },
    "instance" : {
      "href" : "...",
      "title" : "An instance"
    },
    "viewers" : {
      "href" : "..."
    },
    "owners" : {
      "href" : "...",
      "title" : "The group responsible for this object"
    }
  }
}

A PATCH request is used to update an environment to add/remove viewer groups. You can provide a valid list of URIs of the existing groups.

Curl request
$ curl 'http://api.example.com/environments/46cfaf47d2d04d12923beefac3d0ba5a' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "viewers" : [ "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775", "http://api.example.com/groups/88eb98e0eff34fde923c15687e6d75d5" ]
}'
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 21:16:23 GMT
Location: http://api.example.com/environments/46cfaf47d2d04d12923beefac3d0ba5a
Content-Type: application/hal+json
Content-Length: 6463

{
  "name" : "tenantaprivenv1",
  "properties" : { },
  "private" : false,
  "settings" : { },
  "authorizationIssuer" : "Stream owner",
  "uid" : "46cfaf47d2d04d12923beefac3d0ba5a",
  "shortName" : "tenantaprivenv1",
  "color" : "#80affe",
  "retentionTime" : 604800000,
  "partitions" : 12,
  "ksmlEnabled" : false,
  "description" : "environment",
  "autoApproved" : false,
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "visibility" : "public",
  "_embedded" : {
    "instance" : {
      "name" : "TenantA OTA",
      "settings" : {
        "environmentMapping" : "true",
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE",
        "topicOwnerBrowsePermission" : "true"
      },
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "name" : "Zone1ClusterOTA",
          "tenant" : null,
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            }
          }
        },
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2"
      }, {
        "cluster" : {
          "name" : "Zone2ClusterOTA",
          "tenant" : null,
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ],
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            }
          }
        },
        "schemaRegistryUrls" : "https://schema.local3"
      } ],
      "shortName" : "ota",
      "description" : "TenantA OTA Instance",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "supportTier" : {
          "href" : "..."
        }
      },
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "owners" : {
      "name" : "Environment-tenAenv1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    },
    "viewers" : [ {
      "name" : "Application-tenAApplication1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Stream-tenAApplication2",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "88eb98e0eff34fde923c15687e6d75d5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    } ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "environment" : {
      "href" : "...",
      "title" : "An environment"
    },
    "instance" : {
      "href" : "...",
      "title" : "An instance"
    },
    "viewers" : {
      "href" : "..."
    },
    "owners" : {
      "href" : "...",
      "title" : "The group responsible for this object"
    }
  }
}

A PATCH request is used to update an environment enforceDataMasking settings.

By default, enforceDataMasking for an environment is set to false.

When the enforceDataMasking=true on the environments, it allows viewing masked fields when browsing a topic in the environments.

Curl request
$ curl 'http://api.example.com/environments/46cfaf47d2d04d12923beefac3d0ba5a' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "settings" : {
    "enforceDataMasking" : "true"
  }
}'
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 21:16:23 GMT
Location: http://api.example.com/environments/46cfaf47d2d04d12923beefac3d0ba5a
Content-Type: application/hal+json
Content-Length: 4911

{
  "name" : "tenantaprivenv1",
  "properties" : { },
  "private" : false,
  "settings" : {
    "enforceDataMasking" : "true"
  },
  "authorizationIssuer" : "Stream owner",
  "uid" : "46cfaf47d2d04d12923beefac3d0ba5a",
  "shortName" : "tenantaprivenv1",
  "color" : "#80affe",
  "retentionTime" : 604800000,
  "partitions" : 12,
  "ksmlEnabled" : false,
  "description" : "environment",
  "autoApproved" : false,
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "visibility" : "public",
  "_embedded" : {
    "instance" : {
      "name" : "TenantA OTA",
      "settings" : {
        "environmentMapping" : "true",
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE",
        "topicOwnerBrowsePermission" : "true"
      },
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "instanceClusters" : [ {
        "cluster" : {
          "name" : "Zone2ClusterOTA",
          "tenant" : null,
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ ],
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            }
          }
        },
        "schemaRegistryUrls" : "https://schema.local3"
      }, {
        "cluster" : {
          "name" : "Zone1ClusterOTA",
          "tenant" : null,
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "tenant" : {
              "href" : "...",
              "title" : "A tenant"
            }
          }
        },
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2"
      } ],
      "shortName" : "ota",
      "description" : "TenantA OTA Instance",
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "supportTier" : {
          "href" : "..."
        }
      },
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "owners" : {
      "name" : "Environment-tenAenv1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    },
    "viewers" : [ ]
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "environment" : {
      "href" : "...",
      "title" : "An environment"
    },
    "instance" : {
      "href" : "...",
      "title" : "An instance"
    },
    "viewers" : {
      "href" : "..."
    },
    "owners" : {
      "href" : "...",
      "title" : "The group responsible for this object"
    }
  }
}

27.6. Delete environment endpoints

Deleting environment is a two-step process a GET request to check the constraints followed by the DELETE request.

27.6.1. Delete environment constraints

A GET request is used to get the constraints for deleting environments.

$ curl 'http://api.example.com/environments/61b1b34b0c6744dcadb85f4c188517e5/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /environments/61b1b34b0c6744dcadb85f4c188517e5/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 326

{
  "canDelete" : true,
  "activeGrantsCount" : 0,
  "appPrincipalsCount" : 0,
  "appCredentialsCount" : 0,
  "streamConfigsCount" : 0,
  "appDeploymentCount" : 0,
  "streamIds" : [ ],
  "applicationIds" : [ ],
  "activeApplicationCount" : 0,
  "activeApplications" : [ ],
  "activeStreamsCount" : 0,
  "activeStreams" : [ ]
}

27.6.2. Delete environment

A DELETE request is used to delete an environment.

For private environments only, executing this operation will result in the deletion of not only the private environment itself but also its associated entities, including application principals, credentials, deployments, stream configs, accesses and access grants.

$ curl 'http://api.example.com/environments/61b1b34b0c6744dcadb85f4c188517e5' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
DELETE /environments/61b1b34b0c6744dcadb85f4c188517e5 HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

27.7. Synchronize an environment

A synchronize operation is defined as the process of (re)-deploying all streams that are linked to this environment on the Kafka clusters. This effectively syncs the configuration stored in the database to every Kafka cluster that is part of this environment.

The operation is similar to instance synchronization except it is performed at environment level.

The process involves identifying streams that have valid configurations (StreamConfig) for this environment and deploying on the cluster.

This is a high-risk operation only allowed for certain roles. Check with your administrator for more details.

A POST request on /environments/uid/synchronize is used to synchronize an environment. When successful, a 204 No content response is returned. Depending on the number of streams that need to be synced, allow at least 30 seconds for the operation to complete.

27.7.1. Curl request

$ curl 'http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52/synchronize' -i -X POST \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'

27.7.2. HTTP request

POST /environments/047ab08009fe4da8be6905b55552ab52/synchronize HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
Content-Type: application/x-www-form-urlencoded

27.7.3. HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

27.8. Search endpoints

27.8.1. /environments/search/findByName

Search for an environment by exact name.

Parameter Description

name

Environment name to search for.

 
GET /environments/search/findByName?name=tenantaenv1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1992

{
  "_embedded" : {
    "environments" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

27.8.2. /environments/search/findByNameContaining

Search for an environment by name containing search term.

Parameter Description

name

Term to search for within environment name.

 
GET /environments/search/findByNameContaining?name=tenantaenv1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 4125

{
  "_embedded" : {
    "environments" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv10",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenantaenv22",
        "emailAddress" : null,
        "uid" : "66625b8c334d48ac88abff939e9cf453",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv10",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "3gr4e2046dad49468e0848571982a4b8",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

27.8.3. /environments/search/findByShortName

Search for an environment by exact short name.

Parameter Description

shortName

Environment short name to search for.

 
GET /environments/search/findByShortName?shortName=tenantaenv1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1992

{
  "_embedded" : {
    "environments" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

27.8.4. /environments/search/findByInstance

Search for environments that are deployed on this instance.

Parameter Description

instance

Find environments mapped to this instance. Must be a valid instance URI.

 
$ curl 'http://api.example.com/environments/search/findByInstance?instance=http%3A%2F%2Flocalhost%2Finstances%2Fb9301e9144324928911f7d83ec40c478' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 31869

{
  "_embedded" : {
    "environments" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv9_with_revoked_app_access_only",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv9",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with just revoked app_access configured",
      "uid" : "3b7963da58d7445bbf7a900782713069",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaprivenv1",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaprivenv1",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment",
      "uid" : "46cfaf47d2d04d12923beefac3d0ba5a",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv7_with_app_access_only",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv7",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with just app_access configured",
      "uid" : "48dd87236ec445138330adb1a8a79f7e",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv_with_viewer_groups",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv11",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with viewer groups",
      "uid" : "4c9863da58d7445bbf7a900782713069",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaprivenv3",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaprivenv3",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment",
      "uid" : "72c1b34b0c6744dcadb85f4c188518f6",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv8_with_app_credential_only",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv8",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with just app_credential configured",
      "uid" : "73f73e189c49430fbf1d8cc7494d24d4",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv_only_app_grant",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenvgrant",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment with just application_access_grant and no mapping to application_access",
      "uid" : "92b521d4411942ca82b33782ddf50edd",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaprivenv7",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaprivenv7",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "environment with application_access_grant and mapping to application_access",
      "uid" : "a5f2383420e249459b24b7cb189b40bc",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv_no_streams",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenvns",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "a5f2383ccce249459b24b7cb189b40bc",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv4",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication2",
        "emailAddress" : null,
        "uid" : "88eb98e0eff34fde923c15687e6d75d5",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv4",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "aa1ee2dd976647109ca904dd8adc050f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv5",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication2",
        "emailAddress" : null,
        "uid" : "88eb98e0eff34fde923c15687e6d75d5",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv5",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "bb5be2dd976647109ca904dd8adc050f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv_with_viewer_groups_2",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team with env viewer group",
        "emailAddress" : null,
        "uid" : "5c25a483f9af4275c6eb67123f6baa9b",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv12",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with viewer groups 2",
      "uid" : "c7031f7bd5a9782db8307460486945a9",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv2",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication2",
        "emailAddress" : null,
        "uid" : "88eb98e0eff34fde923c15687e6d75d5",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv2",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "e11ee2dd976647109ca904dd8adc050f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenv6_with_app_principal",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv6",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with just app_principal configured",
      "uid" : "e26e0006c5504351a58e3181066cf56a",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta_oublic_env_masking_enforced",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaMSK",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with settings",
      "uid" : "ENV-tenanta-public-masking_enforced",
      "created_at" : "2024-06-07T23:16:23",
      "modified_at" : "2024-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaenvresourcemanagers",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team with two resource managers",
        "emailAddress" : null,
        "uid" : "GroupWithTwoResourceManagers0000",
        "created_at" : "2025-06-07T23:16:23",
        "modified_at" : "2025-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenvresourcema",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "envOfResourceManagers00",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

27.8.5. /environments/search/findByApplication

Search for environments that are used by this application.

Parameter Description

application

Find environments with this application active. Must be a valid application URI.

 
$ curl 'http://api.example.com/environments/search/findByApplication?application=http%3A%2F%2Flocalhost%2Fapplications%2F5ffc4240fcdf4a479a16f2b0b12ab909' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 126385

{
  "_embedded" : {
    "environmentsWithStatuses" : [ {
      "active" : true,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv3",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv3",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "156ab08009fe4da8be6905b55552ab63",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "envdefault",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "envdefault",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "156ab08009fe4da96e6905b55552ab63",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv9_with_revoked_app_access_only",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv9",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just revoked app_access configured",
          "uid" : "3b7963da58d7445bbf7a900782713069",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv10",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenantaenv22",
            "emailAddress" : null,
            "uid" : "66625b8c334d48ac88abff939e9cf453",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv10",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "3gr4e2046dad49468e0848571982a4b8",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv1",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv1",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "46cfaf47d2d04d12923beefac3d0ba5a",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv7_with_app_access_only",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv7",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_access configured",
          "uid" : "48dd87236ec445138330adb1a8a79f7e",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_with_viewer_groups",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv11",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with viewer groups",
          "uid" : "4c9863da58d7445bbf7a900782713069",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_no_streams_2",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvns2",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "5e7e07b5e7784baf8dcebe1b03d5d410",
          "created_at" : "2022-10-31T23:16:23",
          "modified_at" : "2022-10-31T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv2",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv2",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "61b1b34b0c6744dcadb85f4c188517e5",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv5",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team Kad",
            "emailAddress" : null,
            "uid" : "514d4e9a834841869644c2ad8b439553",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv5",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "6u2577bclboz97ievex0fv5hvysemooh",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv3",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv3",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "72c1b34b0c6744dcadb85f4c188518f6",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv8_with_app_credential_only",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv8",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_credential configured",
          "uid" : "73f73e189c49430fbf1d8cc7494d24d4",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv9_with_app_principal_and_credential",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantapublicenv9",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with app access and grant configured",
          "uid" : "73f73e918d49430fbf1d8cc7494d24d4",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv4",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv4",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "83c1b34b0c6744dcadb85f4c188518g5",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv6",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team Kad",
            "emailAddress" : null,
            "uid" : "514d4e9a834841869644c2ad8b439553",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv6",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "8fe4bc6b01bc4ff39ac9769ffe1fb77f",
          "created_at" : "2022-09-06T10:00:00",
          "modified_at" : "2022-09-06T10:00:00",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_only_app_grant",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvgrant",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment with just application_access_grant and no mapping to application_access",
          "uid" : "92b521d4411942ca82b33782ddf50edd",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv7",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv7",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment with application_access_grant and mapping to application_access",
          "uid" : "a5f2383420e249459b24b7cb189b40bc",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_no_streams",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvns",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "a5f2383ccce249459b24b7cb189b40bc",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv4",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv4",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "aa1ee2dd976647109ca904dd8adc050f",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv5",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv5",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "bb5be2dd976647109ca904dd8adc050f",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_with_viewer_groups_2",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team with env viewer group",
            "emailAddress" : null,
            "uid" : "5c25a483f9af4275c6eb67123f6baa9b",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv12",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with viewer groups 2",
          "uid" : "c7031f7bd5a9782db8307460486945a9",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv2",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv2",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "e11ee2dd976647109ca904dd8adc050f",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv6_with_app_principal",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv6",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_principal configured",
          "uid" : "e26e0006c5504351a58e3181066cf56a",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_ksml_2",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tnt_a_ksml2",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "single cluster environment for ksml",
          "uid" : "ENV-tenanta-private-single-clstr",
          "created_at" : "2024-06-07T00:00:00",
          "modified_at" : "2024-06-07T00:00:00",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta_oublic_env_masking_enforced",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaMSK",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with settings",
          "uid" : "ENV-tenanta-public-masking_enforced",
          "created_at" : "2024-06-07T23:16:23",
          "modified_at" : "2024-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantamultienv_with_ksml",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantamulti",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "multi cluster environment for ksml",
          "uid" : "ENV-tenanta-public-multi-cluster",
          "created_at" : "2024-06-07T23:16:23",
          "modified_at" : "2024-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_with_ksml",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvks",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "single cluster environment for ksml",
          "uid" : "ENV-tenanta-public-single-clustr",
          "created_at" : "2024-06-07T23:16:23",
          "modified_at" : "2024-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenvresourcemanagers",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team with two resource managers",
            "emailAddress" : null,
            "uid" : "GroupWithTwoResourceManagers0000",
            "created_at" : "2025-06-07T23:16:23",
            "modified_at" : "2025-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvresourcema",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "envOfResourceManagers00",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "application" : {
              "href" : "...",
              "templated" : true,
              "title" : "An application"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "stream" : null
      },
      "connectorLoggingEnabled" : false
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

27.8.6. /environments/search/findByStream

Search for environments that are used by this stream.

Parameter Description

stream

Find environments with this stream active. Must be a valid stream URI.

 
$ curl 'http://api.example.com/environments/search/findByStream?stream=http%3A%2F%2Flocalhost%2Fstreams%2F066f5944d16344f88c9214d240d139dc' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 150803

{
  "_embedded" : {
    "environmentsWithStatuses" : [ {
      "active" : true,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv3",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv3",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "156ab08009fe4da8be6905b55552ab63",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "envdefault",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "envdefault",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "156ab08009fe4da96e6905b55552ab63",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : true,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv9_with_revoked_app_access_only",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv9",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just revoked app_access configured",
          "uid" : "3b7963da58d7445bbf7a900782713069",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : true,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv10",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenantaenv22",
            "emailAddress" : null,
            "uid" : "66625b8c334d48ac88abff939e9cf453",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv10",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "3gr4e2046dad49468e0848571982a4b8",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv1",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv1",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "46cfaf47d2d04d12923beefac3d0ba5a",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : true,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv7_with_app_access_only",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv7",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_access configured",
          "uid" : "48dd87236ec445138330adb1a8a79f7e",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_with_viewer_groups",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv11",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with viewer groups",
          "uid" : "4c9863da58d7445bbf7a900782713069",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_no_streams_2",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvns2",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "5e7e07b5e7784baf8dcebe1b03d5d410",
          "created_at" : "2022-10-31T23:16:23",
          "modified_at" : "2022-10-31T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv2",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv2",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "61b1b34b0c6744dcadb85f4c188517e5",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv5",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team Kad",
            "emailAddress" : null,
            "uid" : "514d4e9a834841869644c2ad8b439553",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv5",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "6u2577bclboz97ievex0fv5hvysemooh",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : true,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv3",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv3",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "72c1b34b0c6744dcadb85f4c188518f6",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv8_with_app_credential_only",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv8",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_credential configured",
          "uid" : "73f73e189c49430fbf1d8cc7494d24d4",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : true,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv9_with_app_principal_and_credential",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantapublicenv9",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with app access and grant configured",
          "uid" : "73f73e918d49430fbf1d8cc7494d24d4",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv4",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv4",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "83c1b34b0c6744dcadb85f4c188518g5",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv6",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team Kad",
            "emailAddress" : null,
            "uid" : "514d4e9a834841869644c2ad8b439553",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv6",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "8fe4bc6b01bc4ff39ac9769ffe1fb77f",
          "created_at" : "2022-09-06T10:00:00",
          "modified_at" : "2022-09-06T10:00:00",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_only_app_grant",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvgrant",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment with just application_access_grant and no mapping to application_access",
          "uid" : "92b521d4411942ca82b33782ddf50edd",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaprivenv7",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv7",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment with application_access_grant and mapping to application_access",
          "uid" : "a5f2383420e249459b24b7cb189b40bc",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_no_streams",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvns",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "a5f2383ccce249459b24b7cb189b40bc",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv4",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv4",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "aa1ee2dd976647109ca904dd8adc050f",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv5",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv5",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "bb5be2dd976647109ca904dd8adc050f",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_with_viewer_groups_2",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team with env viewer group",
            "emailAddress" : null,
            "uid" : "5c25a483f9af4275c6eb67123f6baa9b",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv12",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with viewer groups 2",
          "uid" : "c7031f7bd5a9782db8307460486945a9",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : true,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv2",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv2",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "e11ee2dd976647109ca904dd8adc050f",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : true,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv6_with_app_principal",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv6",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_principal configured",
          "uid" : "e26e0006c5504351a58e3181066cf56a",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_ksml_2",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tnt_a_ksml2",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "single cluster environment for ksml",
          "uid" : "ENV-tenanta-private-single-clstr",
          "created_at" : "2024-06-07T00:00:00",
          "modified_at" : "2024-06-07T00:00:00",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta_oublic_env_masking_enforced",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaMSK",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with settings",
          "uid" : "ENV-tenanta-public-masking_enforced",
          "created_at" : "2024-06-07T23:16:23",
          "modified_at" : "2024-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantamultienv_with_ksml",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantamulti",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "multi cluster environment for ksml",
          "uid" : "ENV-tenanta-public-multi-cluster",
          "created_at" : "2024-06-07T23:16:23",
          "modified_at" : "2024-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : true,
      "browsable" : true,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenv_with_ksml",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvks",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "single cluster environment for ksml",
          "uid" : "ENV-tenanta-public-single-clustr",
          "created_at" : "2024-06-07T23:16:23",
          "modified_at" : "2024-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    }, {
      "active" : false,
      "browsable" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "environment" : {
              "href" : "...",
              "templated" : true,
              "title" : "An environment"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenantaenvresourcemanagers",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team with two resource managers",
            "emailAddress" : null,
            "uid" : "GroupWithTwoResourceManagers0000",
            "created_at" : "2025-06-07T23:16:23",
            "modified_at" : "2025-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvresourcema",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "envOfResourceManagers00",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : null,
        "stream" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "title" : "URI pointing to current request"
            },
            "stream" : {
              "href" : "...",
              "templated" : true,
              "title" : "A stream"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "connectorLoggingEnabled" : false
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

27.8.7. /environments/search/findByPluginClass

Search for environments that are used by this plugin class.

Parameter Description

pluginClass

Connector plugin class name

 
$ curl 'http://api.example.com/environments/search/findByPluginClass?pluginClass=io.axual.test.sink.plugin' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 922

{
  "envPluginVersionMap" : {
    "tenantaenvresourcema" : "1.0.0",
    "tenantaenvgrant" : "1.0.0",
    "tenantaMSK" : "1.0.0",
    "tenantaenvns" : "1.0.0",
    "envdefault" : "1.0.2",
    "tenantaenv8" : "1.0.0",
    "tenantaenv9" : "1.0.0",
    "tenantapublicenv9" : "1.0.1",
    "tenantaenv6" : "1.0.0",
    "tenantaenv7" : "1.0.0",
    "tenantaenv1" : "1.0.0",
    "tenantaprivenv1" : "1.0.0",
    "tenantaprivenv2" : "1.0.2",
    "tenantaprivenv3" : "1.0.0",
    "tenantaenv4" : "1.0.0",
    "tenantaenv12" : "1.0.0",
    "tenantaenv11" : "1.0.0",
    "tenantaprivenv4" : "1.0.2",
    "tenantaenv5" : "1.0.0",
    "tenantaprivenv5" : "1.0.1",
    "tenantaenv2" : "1.0.0",
    "tenantaenv3" : "1.0.2",
    "tenantaprivenv6" : "1.0.2",
    "tenantaenvns2" : "1.0.2",
    "tenantaprivenv7" : "1.0.0"
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

27.8.8. /environments/search/findByAttributes

A GET request is used to retrieve all environments based on paging parameters.

Query parameters
Parameter Description

sort

Property to sort on and the direction.

page

Navigate through different pages.

size

Property to define the page size.
HTTP request
GET /environments/search/findByAttributes?sort=name%2Casc&page=0&size=5 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 9336

{
  "_embedded" : {
    "environments" : [ {
      "_links" : {
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "envdefault",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "envdefault",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "156ab08009fe4da96e6905b55552ab63",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_oublic_env_masking_enforced",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaMSK",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment with settings",
      "uid" : "ENV-tenanta-public-masking_enforced",
      "created_at" : "2024-06-07T23:16:23",
      "modified_at" : "2024-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv_ksml_2",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tnt_a_ksml2",
      "color" : "#80affe",
      "visibility" : "private",
      "description" : "single cluster environment for ksml",
      "uid" : "ENV-tenanta-private-single-clstr",
      "created_at" : "2024-06-07T00:00:00",
      "modified_at" : "2024-06-07T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv_no_streams",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenvns",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "a5f2383ccce249459b24b7cb189b40bc",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv_no_streams_2",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenvns2",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "5e7e07b5e7784baf8dcebe1b03d5d410",
      "created_at" : "2022-10-31T23:16:23",
      "modified_at" : "2022-10-31T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 5,
    "totalElements" : 29,
    "totalPages" : 6,
    "number" : 0
  }
}
Filter by name

A GET request will retrieve an environment by name. The parameter name is not case-sensitive.

Query parameters
Parameter Description

name

Environment name to search for.
HTTP request
GET /environments/search/findByAttributes?name=tenantaenv1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 3925

{
  "_embedded" : {
    "environments" : [ {
      "_links" : {
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv10",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenantaenv22",
        "emailAddress" : null,
        "uid" : "66625b8c334d48ac88abff939e9cf453",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv10",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "3gr4e2046dad49468e0848571982a4b8",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}
Filter by groupName

A GET request will retrieve an environment by groupName. The parameter groupName is not case-sensitive.

Query parameters
Parameter Description

groupName

Environment owner name to search for.
HTTP request
GET /environments/search/findByAttributes?groupName=aac290536035440e9a85f193e4affeb3 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 350

{
  "_embedded" : {
    "environments" : [ ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 0,
    "totalPages" : 0,
    "number" : 0
  }
}

27.9. Export Environments in CSV

A GET request is used to export a CSV containing information about the Environments.

$ curl 'http://api.example.com/export/environments' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /export/environments HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Disposition: attachment; filename="environments.csv"
Content-Length: 6597

"NAME","SHORT_NAME","DESCRIPTION","INSTANCE","OWNERS_GROUP_NAME","CREATED_BY","CREATED_AT","MODIFIED_BY","MODIFIED_AT","VISIBILITY","AUTHORIZATION_ISSUER","PARTITIONS","PROPERTIES","RETENTION_TIME"
"tenantaenv1","tenantaenv1","environment","TenantA OTA","Environment-tenAenv1","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PUBLIC","STREAM_OWNER","12","{}","604800000"
"tenantaenv3","tenantaenv3","environment","TenantA LST","Environment-tenAenv1","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PUBLIC","STREAM_OWNER","12","{}","604800000"
"envdefault","envdefault","environment","TenantA LST","Environment-tenAenv1","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PUBLIC","STREAM_OWNER","32","{replication.factor=1234, min.insync.replicas=123, segment.ms=696969}","1234"
"tenantaenv9_with_revoked_app_access_only","tenantaenv9","environment with just revoked app_access configured","TenantA OTA","Stream-tenAApplication1","","2021-06-07T23:16:23Z[Etc/UTC]","","2021-06-07T23:16:23Z[Etc/UTC]","PUBLIC","AUTO","12","{}","604800000"
"tenantaenv10","tenantaenv10","environment","TenantA OTA2","Environment-tenantaenv22","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PUBLIC","STREAM_OWNER","12","{}","604800000"
"tenantaprivenv1","tenantaprivenv1","environment","TenantA OTA","Environment-tenAenv1","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PRIVATE","AUTO","12","{}","604800000"
"tenantaenv7_with_app_access_only","tenantaenv7","environment with just app_access configured","TenantA OTA","Environment-tenAenv1","","2021-06-07T23:16:23Z[Etc/UTC]","","2021-06-07T23:16:23Z[Etc/UTC]","PUBLIC","AUTO","12","{}","604800000"
"tenantaenv_with_viewer_groups","tenantaenv11","environment with viewer groups","TenantA OTA","Stream-tenAApplication1","","2021-06-07T23:16:23Z[Etc/UTC]","","2021-06-07T23:16:23Z[Etc/UTC]","PUBLIC","AUTO","12","{}","604800000"
"tenantaenv_no_streams_2","tenantaenvns2","environment","TenantA LST","Environment-tenAenv1","","2022-10-31T23:16:23Z[Etc/UTC]","","2022-10-31T23:16:23Z[Etc/UTC]","PUBLIC","STREAM_OWNER","12","{}","604800000"
"tenantaprivenv2","tenantaprivenv2","environment","TenantA LST","Environment-tenAenv1","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PRIVATE","AUTO","12","{}","604800000"
"tenantaprivenv5","tenantaprivenv5","environment","TenantA Prod","Team Kad","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PRIVATE","AUTO","12","{}","604800000"
"tenantaprivenv3","tenantaprivenv3","environment","TenantA OTA","Environment-tenAenv1","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PRIVATE","AUTO","12","{}","604800000"
"tenantaenv8_with_app_credential_only","tenantaenv8","environment with just app_credential configured","TenantA OTA","Environment-tenAenv1","","2021-06-07T23:16:23Z[Etc/UTC]","","2021-06-07T23:16:23Z[Etc/UTC]","PUBLIC","AUTO","12","{}","604800000"
"tenantaenv9_with_app_principal_and_credential","tenantapublicenv9","environment with app access and grant configured","TenantA Prod","Environment-tenAenv1","","2021-06-07T23:16:23Z[Etc/UTC]","","2021-06-07T23:16:23Z[Etc/UTC]","PUBLIC","AUTO","12","{}","604800000"
"tenantaprivenv4","tenantaprivenv4","environment","TenantA LST","Environment-tenAenv1","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PRIVATE","AUTO","12","{}","604800000"
"tenantaprivenv6","tenantaprivenv6","environment","TenantA LST","Team Kad","","2022-09-06T10:00:00Z[Etc/UTC]","","2022-09-06T10:00:00Z[Etc/UTC]","PRIVATE","AUTO","12","{}","604800000"
"tenantaenv_only_app_grant","tenantaenvgrant","environment with just application_access_grant and no mapping to application_access","TenantA OTA","Environment-tenAenv1","","2021-06-07T23:16:23Z[Etc/UTC]","","2021-06-07T23:16:23Z[Etc/UTC]","PRIVATE","AUTO","12","{}","604800000"
"tenantaprivenv7","tenantaprivenv7","environment with application_access_grant and mapping to application_access","TenantA OTA","Environment-tenAenv1","","2021-06-07T23:16:23Z[Etc/UTC]","","2021-06-07T23:16:23Z[Etc/UTC]","PRIVATE","AUTO","12","{}","604800000"
"tenantaenv_no_streams","tenantaenvns","environment","TenantA OTA","Environment-tenAenv1","","2021-06-07T23:16:23Z[Etc/UTC]","","2021-06-07T23:16:23Z[Etc/UTC]","PUBLIC","STREAM_OWNER","12","{}","604800000"
"tenantaenv4","tenantaenv4","environment","TenantA OTA","Stream-tenAApplication2","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PUBLIC","STREAM_OWNER","12","{}","604800000"
"tenantaenv5","tenantaenv5","environment","TenantA OTA","Stream-tenAApplication2","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PUBLIC","STREAM_OWNER","12","{}","604800000"
"tenantaenv_with_viewer_groups_2","tenantaenv12","environment with viewer groups 2","TenantA OTA","Team with env viewer group","","2021-06-07T23:16:23Z[Etc/UTC]","","2021-06-07T23:16:23Z[Etc/UTC]","PUBLIC","AUTO","12","{}","604800000"
"tenantaenv2","tenantaenv2","environment","TenantA OTA","Stream-tenAApplication2","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PUBLIC","STREAM_OWNER","12","{}","604800000"
"tenantaenv6_with_app_principal","tenantaenv6","environment with just app_principal configured","TenantA OTA","Environment-tenAenv1","","2021-06-07T23:16:23Z[Etc/UTC]","","2021-06-07T23:16:23Z[Etc/UTC]","PUBLIC","AUTO","12","{}","604800000"
"tenantaenv_ksml_2","tnt_a_ksml2","single cluster environment for ksml","TenantA KSML","Stream-tenAApplication1","","2024-06-07T00:00:00Z[Etc/UTC]","","2024-06-07T00:00:00Z[Etc/UTC]","PRIVATE","AUTO","12","{}","604800000"
"tenanta_oublic_env_masking_enforced","tenantaMSK","environment with settings","TenantA OTA","Environment-tenAenv1","","2024-06-07T23:16:23Z[Etc/UTC]","","2024-06-07T23:16:23Z[Etc/UTC]","PUBLIC","AUTO","12","{}","604800000"
"tenantamultienv_with_ksml","tenantamulti","multi cluster environment for ksml","TenantA Multi KSML","Stream-tenAApplication1","","2024-06-07T23:16:23Z[Etc/UTC]","","2024-06-07T23:16:23Z[Etc/UTC]","PUBLIC","AUTO","12","{}","604800000"
"tenantaenv_with_ksml","tenantaenvks","single cluster environment for ksml","TenantA KSML","Stream-tenAApplication1","","2024-06-07T23:16:23Z[Etc/UTC]","","2024-06-07T23:16:23Z[Etc/UTC]","PUBLIC","AUTO","12","{}","604800000"
"tenantaenvresourcemanagers","tenantaenvresourcema","environment","TenantA OTA","Team with two resource managers","","2018-06-07T23:16:23Z[Etc/UTC]","","2018-06-07T23:16:23Z[Etc/UTC]","PUBLIC","STREAM_OWNER","12","{}","604800000"

28. Monitoring Information of an environment

The monitoring-information/{environmentShortName} resource is used to retrieve the TenantShortName, InstanceShortName, EnvironmentShortName, Cluster’s Topic and Group Pattern for this environment.

28.1. List All Monitoring Information

A GET request will retrieve the details of the monitoring information based on the provided environment’s short name.

28.1.1. Curl request

$ curl 'http://api.example.com/monitoring-information/tenantaenv1' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

28.1.2. HTTP request

GET /monitoring-information/tenantaenv1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

28.1.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 534

{
  "tenantShortName" : "tenanta",
  "instanceShortName" : "ota",
  "envShortName" : "tenantaenv1",
  "clusterMonitoringInfoList" : [ {
    "clusterName" : "Zone1ClusterOTA",
    "clusterPatterns" : {
      "group" : "{tenant}-{instance}-{environment}-{group}",
      "topic" : "{tenant}-{instance}-{environment}-{topic}"
    }
  }, {
    "clusterName" : "Zone2ClusterOTA",
    "clusterPatterns" : {
      "group" : "{tenant}-{instance}-{environment}-{group}",
      "topic" : "{tenant}-{instance}-{environment}-{topic}"
    }
  } ]
}

29. Monitoring Information in a Governance installation

The monitoring_information/{instanceShortName} resource is used to retrieve the Cluster’s Topic and Group Pattern for all clusters used by the Instance provided.

29.1. Get Monitoring Information for an Instance

A GET request will retrieve the cluster monitoring information details based on the provided InstanceShortName.

All clusters connected to the Instance will be returned.

29.1.1. Curl request

$ curl 'http://api.example.com/monitoring_information/ota' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

29.1.2. HTTP request

GET /monitoring_information/ota HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

29.1.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 432

{
  "clusterMonitoringInfo" : [ {
    "clusterName" : "Zone1ClusterOTA",
    "clusterPatterns" : {
      "group" : "{tenant}-{instance}-{environment}-{group}",
      "topic" : "{tenant}-{instance}-{environment}-{topic}"
    }
  }, {
    "clusterName" : "Zone2ClusterOTA",
    "clusterPatterns" : {
      "group" : "{tenant}-{instance}-{environment}-{group}",
      "topic" : "{tenant}-{instance}-{environment}-{topic}"
    }
  } ]
}

30. Applications

An Application is a piece of software that is capable of producing or consuming events from a data stream.

With release of 0.7.5, we have introduced a new field visibility that defines the concept of public and private application.

A public application is visible to every authenticated user within a tenant. A private application, on the other hand, is only visible to the team that owns it. Most applications that are created for test purposes and are not intended to be deployed in production are marked as private.

For now, this field is optional with a default value of public, so this field can be ignored while creating a new application.

The /applications resource is used to list and create applications.

30.1. Application schema

The applications resource uses the following json-schema:

30.1.1. HTTP request

GET /profile/applications HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com

30.1.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 5145

{
  "title" : "Application",
  "definitions" : {
    "emailAddress" : {
      "type" : "object",
      "properties" : {
        "email" : {
          "title" : "Email",
          "readOnly" : true,
          "type" : "string"
        }
      }
    },
    "group" : {
      "type" : "object",
      "properties" : {
        "uid" : {
          "title" : "Uid",
          "readOnly" : true,
          "type" : "string"
        },
        "emailAddress" : {
          "title" : "Email address",
          "readOnly" : false,
          "type" : "object",
          "$ref" : "#/definitions/emailAddress"
        },
        "phoneNumber" : {
          "title" : "Phone number",
          "readOnly" : false,
          "type" : "string"
        },
        "members" : {
          "title" : "Members",
          "readOnly" : false,
          "type" : "string",
          "format" : "uri"
        },
        "name" : {
          "title" : "Name",
          "readOnly" : false,
          "type" : "string"
        },
        "modified_by" : {
          "title" : "Modified by",
          "readOnly" : false,
          "type" : "string"
        },
        "created_at" : {
          "title" : "Created at",
          "readOnly" : true,
          "type" : "string",
          "format" : "date-time"
        },
        "modified_at" : {
          "title" : "Modified at",
          "readOnly" : false,
          "type" : "string",
          "format" : "date-time"
        },
        "resourceManagers" : {
          "title" : "Resource managers",
          "readOnly" : false,
          "type" : "string",
          "format" : "uri"
        },
        "created_by" : {
          "title" : "Created by",
          "readOnly" : true,
          "type" : "string"
        },
        "managers" : {
          "title" : "Managers",
          "readOnly" : false,
          "type" : "string",
          "format" : "uri"
        },
        "properties" : {
          "title" : "Properties",
          "readOnly" : true,
          "type" : "object"
        }
      }
    }
  },
  "properties" : {
    "applicationType" : {
      "title" : "Application type",
      "readOnly" : false,
      "type" : "string",
      "enum" : [ "Custom", "Connector", "Ksml" ]
    },
    "visibility" : {
      "title" : "Visibility",
      "readOnly" : false,
      "type" : "string",
      "enum" : [ "public", "private" ]
    },
    "description" : {
      "title" : "Description",
      "readOnly" : false,
      "type" : "string"
    },
    "kafkaStreams" : {
      "title" : "Kafka streams",
      "readOnly" : true,
      "type" : "boolean"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "owners" : {
      "title" : "Owners",
      "readOnly" : false,
      "type" : "object",
      "$ref" : "#/definitions/group"
    },
    "type" : {
      "title" : "Type",
      "readOnly" : false,
      "type" : "string"
    },
    "allApplicationIds" : {
      "title" : "All application ids",
      "readOnly" : true,
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "type" : "object"
      }
    },
    "customKsml" : {
      "title" : "Custom ksml",
      "readOnly" : true,
      "type" : "boolean"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "viewers" : {
      "title" : "Viewers",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "connector" : {
      "title" : "Connector",
      "readOnly" : true,
      "type" : "boolean"
    },
    "applicationClass" : {
      "title" : "Application class",
      "readOnly" : false,
      "type" : "string"
    },
    "ableToResetOffsets" : {
      "title" : "Able to reset offsets",
      "readOnly" : true,
      "type" : "boolean"
    },
    "axualManagedKsml" : {
      "title" : "Axual managed ksml",
      "readOnly" : true,
      "type" : "boolean"
    },
    "name" : {
      "title" : "Name",
      "readOnly" : false,
      "type" : "string"
    },
    "kafkaStreamsBased" : {
      "title" : "Kafka streams based",
      "readOnly" : true,
      "type" : "boolean"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "shortName" : {
      "title" : "Short name",
      "readOnly" : false,
      "type" : "string"
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "applicationId" : {
      "title" : "Application id",
      "readOnly" : false,
      "type" : "string"
    },
    "properties" : {
      "title" : "Properties",
      "readOnly" : true,
      "type" : "object"
    },
    "ableToGenerateSchemaRegistryPassword" : {
      "title" : "Able to generate schema registry password",
      "readOnly" : true,
      "type" : "boolean"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

30.2. List all applications

A GET request will list all the public applications and the applications owned by the currently logged-in user.

30.2.1. Curl request

$ curl 'http://api.example.com/applications' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

30.2.2. HTTP request

GET /applications HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

30.2.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 35325

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "testRevoke",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Kad",
        "emailAddress" : null,
        "uid" : "514d4e9a834841869644c2ad8b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app.revoke",
      "applicationType" : "Custom",
      "shortName" : "test_revoke",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app.revoke" ],
      "description" : "",
      "uid" : "39d82d7994484b53ae1de37ee8924512",
      "created_at" : "2020-11-01T23:16:23",
      "modified_at" : "2020-11-01T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaApplication2",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app2",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app2",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app2" ],
      "description" : "tenantaApplication2 description.",
      "uid" : "39d82d7f34484b53ae1dd47ee8924502",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaApplication3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app3",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app3",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app3" ],
      "description" : "tenantaApplication3 description.",
      "uid" : "39d82d7f34484b53ae1dd47ee8924512",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaApplication4",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app4",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "tenantaApplication4 description.",
      "uid" : "4180e2f2493944948e4df46ba36ba964",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaAutoApplication3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team App Admins",
        "emailAddress" : null,
        "uid" : "514d4oit834841869644c2ad8b439997",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.auto.app3",
      "applicationType" : "Custom",
      "shortName" : "tenanta_auto_app3",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.auto.app3" ],
      "description" : "",
      "uid" : "4cc380171afc4c898b6f6c02caccf451",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaKsmlApplication3",
      "type" : null,
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Ksml",
      "shortName" : "tenanta_ksml_app3",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "",
      "uid" : "5eab940d3d9042fb9dfb25fc4718ec92",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaApplication1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app1",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
      "description" : "tenantaApplication1 description.",
      "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "publicEnvRevoke",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Kad",
        "emailAddress" : null,
        "uid" : "514d4e9a834841869644c2ad8b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app.revoke.public.env",
      "applicationType" : "Custom",
      "shortName" : "tenanta_revoke_public",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app.revoke.public.env" ],
      "description" : "",
      "uid" : "68e4d4e2e3e54ddc836006655d42a995",
      "created_at" : "2020-11-01T23:16:23",
      "modified_at" : "2020-11-01T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaApplication25",
      "type" : null,
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app25",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "",
      "uid" : "707fe3234224b9fe9dd84292em0fe1fe",
      "created_at" : "2024-05-14T13:16:23",
      "modified_at" : "2024-05-14T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaKsmlApplication1",
      "type" : null,
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Ksml",
      "shortName" : "tenanta_ksml_app1",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "",
      "uid" : "70a2bd2842c7477da84f4769372d39bc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaAppWithViewers",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_with_viewers",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "tenantaApplication1 description.",
      "uid" : "8dc64240fcdf4a479a16f2b0b12ab909",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta_app_pagination10",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination10",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "a2e98e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaAutoApplication4",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team App Admins",
        "emailAddress" : null,
        "uid" : "514d4oit834841869644c2ad8b439997",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.auto.app4",
      "applicationType" : "Custom",
      "shortName" : "tenanta_auto_app4",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.auto.app4" ],
      "description" : "",
      "uid" : "aec9e4570f1c4866bef77722e2830d4b",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantAappWithManagers",
      "type" : null,
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team with two resource managers",
        "emailAddress" : null,
        "uid" : "GroupWithTwoResourceManagers0000",
        "created_at" : "2025-06-07T23:16:23",
        "modified_at" : "2025-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Connector",
      "shortName" : "tenantA_withManagers",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "tenantA managed Ksml description.",
      "uid" : "appIdOfApplicationWithManagers00",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaApplication14",
      "type" : "SOURCE",
      "applicationClass" : "io.axual.test.source.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app14",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app14",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app14" ],
      "description" : "",
      "uid" : "bb3234224b974292a607fe9dd80fe1ae",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaApplication16",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app16",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "",
      "uid" : "bur6h4670h1c4866deg78722e2930d2g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta_app_pagination1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination1",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "c2e98e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenantaCustomKsmlApp20",
      "type" : "KSML",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl-tenanta-customKsml-app20",
      "applicationType" : "Custom",
      "shortName" : "tenanta_customksml_20",
      "visibility" : "public",
      "applicationIds" : [ "nl-tenanta-customKsml-app20" ],
      "description" : "A Custom KSML Application",
      "uid" : "CustomKSML-app20-ID-000000000000",
      "created_at" : "2024-05-14T00:00:00",
      "modified_at" : "2024-05-14T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta_app_pagination5",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination5",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e92e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta_app_pagination3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination3",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831a74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 50,
    "totalPages" : 3,
    "number" : 0
  }
}
Relation Description

create

Existence of this link indicates that the currently authenticated user can create a new Application

30.3. Create Custom application

A POST request is used to create a new application.

30.3.1. Request fields

Path Type Description Constraints

name

String

The name of the Application. Must be unique per tenant.

Must match the regular expression (?i)^[a-z0-9\.\-_ ]+$. Must not be empty. Size must be between 3 and 100 inclusive

applicationId

String

The applicationId of the Application, usually a fully qualified class name and underscores _ are allowed. Must be unique.

shortName

String

Unique human-readable name for the application. Only Alphanumeric and underscore allowed. Must be unique per tenant.

Must match the regular expression (?i)^[a-z0-9_]+$. Must not be empty. Size must be between 3 and 60 inclusive

owners

String

A valid URI of an existing group, must not be null.

Must not be null

viewers

Array

A valid list of URI of existing groups. It is used to give view authority on configured ApplicationPrincipals and ApplicationCredentials for this application.

description

String

A short summary describing the application

Size must be between 0 and 200 inclusive

visibility

String

Defines the visibility of this application. Possible values are Public and Private

properties

Object

A list of Application specific variables in Key,Value format.

applicationType

String

Application Axual type. Possible values are Custom, Connector and KSML.

Must not be null

type

String

Application software. Possible values: Java, Kafka Streams, Pega, SAP, DotNet, Bridge, Python

30.3.2. Curl request

$ curl 'http://api.example.com/applications' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "applicationId" : "nl.tenanta.test.application,nl.tenanta.test.application2",
  "name" : "Test Application",
  "shortName" : "test_app",
  "description" : "This is a test application",
  "applicationType" : "CUSTOM",
  "type" : "Java",
  "visibility" : "PRIVATE",
  "owners" : "http://api.example.com/groups/514d4oit834841869644c2ad8b439997",
  "viewers" : [ "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775" ],
  "properties" : {
    "app.property1" : "value1",
    "app.property2" : "value2",
    "app.property3" : "value3",
    "app.property4" : "value4",
    "app.property5" : "value5"
  }
}'

30.3.3. HTTP request

POST /applications HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 614
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "nl.tenanta.test.application,nl.tenanta.test.application2",
  "name" : "Test Application",
  "shortName" : "test_app",
  "description" : "This is a test application",
  "applicationType" : "CUSTOM",
  "type" : "Java",
  "visibility" : "PRIVATE",
  "owners" : "http://api.example.com/groups/514d4oit834841869644c2ad8b439997",
  "viewers" : [ "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775" ],
  "properties" : {
    "app.property1" : "value1",
    "app.property2" : "value2",
    "app.property3" : "value3",
    "app.property4" : "value4",
    "app.property5" : "value5"
  }
}

30.3.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 08:08:13 GMT
Location: http://api.example.com/applications/f220612de63445f2a3976fba6cbf1ce9
Content-Type: application/hal+json
Content-Length: 8133

{
  "name" : "Test Application",
  "shortName" : "test_app",
  "description" : "This is a test application",
  "applicationType" : "Custom",
  "type" : "Java",
  "applicationClass" : null,
  "visibility" : "private",
  "owners" : {
    "name" : "Team App Admins",
    "emailAddress" : null,
    "phoneNumber" : null,
    "properties" : { },
    "uid" : "514d4oit834841869644c2ad8b439997",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "_embedded" : {
      "members" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "firstNameTest",
        "lastName" : "lastNameTest",
        "middleName" : "van der",
        "emailAddress" : {
          "email" : "testuser@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "avcdfr5c6d9e424ab1a9d9f767fc7cfd"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "caa51002633244ffbe36f4ccf8a8f501"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "e235c8fe4264431bbdb3b40a2e5f8f62"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "tenAdmin",
        "lastName" : "TenantActive",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "s39sef147df84179a151bdc21f5bb813"
      } ],
      "resourceManagers" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "avcdfr5c6d9e424ab1a9d9f767fc7cfd"
      } ],
      "managers" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "firstNameTest",
        "lastName" : "lastNameTest",
        "middleName" : "van der",
        "emailAddress" : {
          "email" : "testuser@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
      } ]
    },
    "_links" : {
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      },
      "delete" : {
        "href" : "...",
        "title" : "Indication that this entity can be deleted"
      },
      "self" : {
        "href" : "...",
        "title" : "URI pointing to current request"
      },
      "members" : [ {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      } ],
      "resourceManagers" : {
        "href" : "...",
        "templated" : true
      },
      "managers" : {
        "href" : "...",
        "templated" : true
      }
    }
  },
  "properties" : {
    "app.property1" : "value1",
    "app.property2" : "value2",
    "app.property3" : "value3",
    "app.property4" : "value4",
    "app.property5" : "value5"
  },
  "kafkaStreamsBased" : false,
  "connector" : false,
  "axualManagedKsml" : false,
  "kafkaStreams" : false,
  "customKsml" : false,
  "allApplicationIds" : [ "nl.tenanta.test.application", "nl.tenanta.test.application2" ],
  "ableToGenerateSchemaRegistryPassword" : false,
  "ableToResetOffsets" : true,
  "uid" : "f220612de63445f2a3976fba6cbf1ce9",
  "created_at" : "2025-06-25T08:08:13.872935746",
  "modified_at" : "2025-06-25T08:08:13.872935746",
  "created_by" : "poweruser@tenanta.nl",
  "modified_by" : "poweruser@tenanta.nl",
  "applicationId" : "nl.tenanta.test.application,nl.tenanta.test.application2",
  "_embedded" : {
    "viewers" : [ {
      "_links" : {
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ],
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "Application-tenAApplication1",
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "createApplicationPrincipal" : {
      "href" : "..."
    },
    "createApplicationAccess" : {
      "href" : "..."
    },
    "resetOffset" : {
      "href" : "..."
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}

30.4. Create Connector application

A POST request is used to create a new connector application.

30.4.1. Request fields

Path Type Description Constraints

name

String

The name of the Application. Must be unique per tenant.

Must match the regular expression (?i)^[a-z0-9\.\-_ ]+$. Must not be empty. Size must be between 3 and 100 inclusive

applicationId

String

The applicationId of the Application, usually a fully qualified class name. Must be unique.

shortName

String

Unique human-readable name for the application. Only Alphanumeric and underscore allowed. Must be unique per tenant.

Must match the regular expression (?i)^[a-z0-9_]+$. Must not be empty. Size must be between 3 and 60 inclusive

owners

String

The group id that describes the group details and must not be null.

Must not be null

description

String

A short summary describing the application

Size must be between 0 and 200 inclusive

visibility

String

Defines the visibility of this application. Possible values are Public and Private

properties

Object

A list of Application specific variables in Key,Value format.

applicationType

String

Application Axual type. Possible values are Custom and Connector.

Must not be null

applicationClass

String

Meaningful only when applicationType=CONNECTOR. Specify the connector used in Axual Connect.

applicationClassVersion

String

Meaningful only when applicationType=CONNECTOR. Specify the connector version used in Axual Connect.

type

String

When applicationType=CUSTOM possible values are Java, Kafka Streams, Pega, SAP, DotNet, Bridge, Python. When applicationType=CONNECTOR possible values are SINK, SOURCE. When applicationType=KSML the value is null.

30.4.2. Curl request

$ curl 'http://api.example.com/applications' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "applicationId" : "com.axual.turbulence.connector.application1",
  "name" : "Test Connector Application",
  "shortName" : "test_cnnt_app",
  "description" : "This is a connector test application",
  "applicationType" : "CONNECTOR",
  "type" : "sink",
  "applicationClass" : "io.axual.distributor.logger.MessageLogger",
  "applicationClassVersion" : "1.0.0",
  "visibility" : "PRIVATE",
  "owners" : "http://api.example.com/groups/514d4oit834841869644c2ad8b439997"
}'

30.4.3. HTTP request

POST /applications HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 469
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "com.axual.turbulence.connector.application1",
  "name" : "Test Connector Application",
  "shortName" : "test_cnnt_app",
  "description" : "This is a connector test application",
  "applicationType" : "CONNECTOR",
  "type" : "sink",
  "applicationClass" : "io.axual.distributor.logger.MessageLogger",
  "applicationClassVersion" : "1.0.0",
  "visibility" : "PRIVATE",
  "owners" : "http://api.example.com/groups/514d4oit834841869644c2ad8b439997"
}

30.4.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 08:08:13 GMT
Location: http://api.example.com/applications/ddd8b06b841843d5aa84f52c19540073
Content-Type: application/hal+json
Content-Length: 7229

{
  "name" : "Test Connector Application",
  "shortName" : "test_cnnt_app",
  "description" : "This is a connector test application",
  "applicationType" : "Connector",
  "type" : "sink",
  "applicationClass" : "io.axual.distributor.logger.MessageLogger",
  "visibility" : "private",
  "owners" : {
    "name" : "Team App Admins",
    "emailAddress" : null,
    "phoneNumber" : null,
    "properties" : { },
    "uid" : "514d4oit834841869644c2ad8b439997",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "_embedded" : {
      "members" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "firstNameTest",
        "lastName" : "lastNameTest",
        "middleName" : "van der",
        "emailAddress" : {
          "email" : "testuser@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "avcdfr5c6d9e424ab1a9d9f767fc7cfd"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "caa51002633244ffbe36f4ccf8a8f501"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "e235c8fe4264431bbdb3b40a2e5f8f62"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "tenAdmin",
        "lastName" : "TenantActive",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "s39sef147df84179a151bdc21f5bb813"
      } ],
      "resourceManagers" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "avcdfr5c6d9e424ab1a9d9f767fc7cfd"
      } ],
      "managers" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "firstNameTest",
        "lastName" : "lastNameTest",
        "middleName" : "van der",
        "emailAddress" : {
          "email" : "testuser@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
      } ]
    },
    "_links" : {
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      },
      "delete" : {
        "href" : "...",
        "title" : "Indication that this entity can be deleted"
      },
      "self" : {
        "href" : "...",
        "title" : "URI pointing to current request"
      },
      "members" : [ {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      } ],
      "resourceManagers" : {
        "href" : "...",
        "templated" : true
      },
      "managers" : {
        "href" : "...",
        "templated" : true
      }
    }
  },
  "properties" : { },
  "kafkaStreamsBased" : false,
  "connector" : true,
  "axualManagedKsml" : false,
  "kafkaStreams" : false,
  "customKsml" : false,
  "allApplicationIds" : [ "com.axual.turbulence.connector.application1" ],
  "ableToGenerateSchemaRegistryPassword" : false,
  "ableToResetOffsets" : true,
  "uid" : "ddd8b06b841843d5aa84f52c19540073",
  "created_at" : "2025-06-25T08:08:13.701182275",
  "modified_at" : "2025-06-25T08:08:13.701182275",
  "created_by" : "poweruser@tenanta.nl",
  "modified_by" : "poweruser@tenanta.nl",
  "applicationId" : "com.axual.turbulence.connector.application1",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "createApplicationPrincipal" : {
      "href" : "..."
    },
    "createApplicationAccess" : {
      "href" : "..."
    },
    "createApplicationDeployment" : {
      "href" : "..."
    },
    "resetOffset" : {
      "href" : "..."
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}

30.5. Create Ksml application

A POST request is used to create a new KSML application.

30.5.1. Request fields

Path Type Description Constraints

name

String

The name of the Application. Must be unique per tenant.

Must match the regular expression (?i)^[a-z0-9\.\-_ ]+$. Must not be empty. Size must be between 3 and 100 inclusive

applicationId

String

The applicationId of the Application, usually a fully qualified class name and underscores _ are allowed. Must be unique.

shortName

String

Unique human-readable name for the application. Only Alphanumeric and underscore allowed. Must be unique per tenant.

Must match the regular expression (?i)^[a-z0-9_]+$. Must not be empty. Size must be between 3 and 60 inclusive

owners

String

A valid URI of an existing group, must not be null.

Must not be null

description

String

A short summary describing the application

Size must be between 0 and 200 inclusive

visibility

String

Defines the visibility of this application. Possible values are Public and Private

properties

Object

A list of Application specific variables in Key,Value format.

applicationType

String

Application Axual type. Possible values are Custom, Connector and KSML.

Must not be null

30.5.2. Curl request

$ curl 'http://api.example.com/applications' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "applicationId" : "com.axual.turbulence.connector.application1",
  "name" : "Test Connector Application",
  "shortName" : "test_cnnt_app",
  "description" : "This is a connector test application",
  "applicationType" : "CONNECTOR",
  "type" : "sink",
  "applicationClass" : "io.axual.distributor.logger.MessageLogger",
  "applicationClassVersion" : "1.0.0",
  "visibility" : "PRIVATE",
  "owners" : "http://api.example.com/groups/514d4oit834841869644c2ad8b439997"
}'

30.5.3. HTTP request

POST /applications HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 469
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "com.axual.turbulence.connector.application1",
  "name" : "Test Connector Application",
  "shortName" : "test_cnnt_app",
  "description" : "This is a connector test application",
  "applicationType" : "CONNECTOR",
  "type" : "sink",
  "applicationClass" : "io.axual.distributor.logger.MessageLogger",
  "applicationClassVersion" : "1.0.0",
  "visibility" : "PRIVATE",
  "owners" : "http://api.example.com/groups/514d4oit834841869644c2ad8b439997"
}

30.5.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 08:08:14 GMT
Location: http://api.example.com/applications/b74d9b5899304509973feedf0d4594b5
Content-Type: application/hal+json
Content-Length: 7229

{
  "name" : "Test Connector Application",
  "shortName" : "test_cnnt_app",
  "description" : "This is a connector test application",
  "applicationType" : "Connector",
  "type" : "sink",
  "applicationClass" : "io.axual.distributor.logger.MessageLogger",
  "visibility" : "private",
  "owners" : {
    "name" : "Team App Admins",
    "emailAddress" : null,
    "phoneNumber" : null,
    "properties" : { },
    "uid" : "514d4oit834841869644c2ad8b439997",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "_embedded" : {
      "members" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "firstNameTest",
        "lastName" : "lastNameTest",
        "middleName" : "van der",
        "emailAddress" : {
          "email" : "testuser@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "avcdfr5c6d9e424ab1a9d9f767fc7cfd"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "caa51002633244ffbe36f4ccf8a8f501"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "e235c8fe4264431bbdb3b40a2e5f8f62"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "tenAdmin",
        "lastName" : "TenantActive",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "s39sef147df84179a151bdc21f5bb813"
      } ],
      "resourceManagers" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "avcdfr5c6d9e424ab1a9d9f767fc7cfd"
      } ],
      "managers" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "firstNameTest",
        "lastName" : "lastNameTest",
        "middleName" : "van der",
        "emailAddress" : {
          "email" : "testuser@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
      } ]
    },
    "_links" : {
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      },
      "delete" : {
        "href" : "...",
        "title" : "Indication that this entity can be deleted"
      },
      "self" : {
        "href" : "...",
        "title" : "URI pointing to current request"
      },
      "members" : [ {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      } ],
      "resourceManagers" : {
        "href" : "...",
        "templated" : true
      },
      "managers" : {
        "href" : "...",
        "templated" : true
      }
    }
  },
  "properties" : { },
  "kafkaStreamsBased" : false,
  "connector" : true,
  "axualManagedKsml" : false,
  "kafkaStreams" : false,
  "customKsml" : false,
  "allApplicationIds" : [ "com.axual.turbulence.connector.application1" ],
  "ableToGenerateSchemaRegistryPassword" : false,
  "ableToResetOffsets" : true,
  "uid" : "b74d9b5899304509973feedf0d4594b5",
  "created_at" : "2025-06-25T08:08:14.229787226",
  "modified_at" : "2025-06-25T08:08:14.229787226",
  "created_by" : "poweruser@tenanta.nl",
  "modified_by" : "poweruser@tenanta.nl",
  "applicationId" : "com.axual.turbulence.connector.application1",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "createApplicationPrincipal" : {
      "href" : "..."
    },
    "createApplicationAccess" : {
      "href" : "..."
    },
    "createApplicationDeployment" : {
      "href" : "..."
    },
    "resetOffset" : {
      "href" : "..."
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}

30.6. Create Kafka Streams application

A POST request is used to create a new Kafka Streams application.

30.6.1. Request fields

Path Type Description Constraints

name

String

The name of the Application. Must be unique per tenant.

Must match the regular expression (?i)^[a-z0-9\.\-_ ]+$. Must not be empty. Size must be between 3 and 100 inclusive

applicationId

String

The applicationId of the Application, usually a fully qualified class name and underscores _ are allowed. Must be unique. Should not collide with existing topic names. Should not contain ,.

shortName

String

Unique human-readable name for the application. Only Alphanumeric and underscore allowed. Must be unique per tenant.

Must match the regular expression (?i)^[a-z0-9_]+$. Must not be empty. Size must be between 3 and 60 inclusive

owners

String

A valid URI of an existing group, must not be null.

Must not be null

description

String

A short summary describing the application

Size must be between 0 and 200 inclusive

visibility

String

Defines the visibility of this application. Possible values are Public and Private

properties

Object

A list of Application specific variables in Key,Value format.

applicationType

String

Application Axual type. Possible values are Custom, Connector and KSML.

Must not be null

30.6.2. Curl request

$ curl 'http://api.example.com/applications' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "applicationId" : "com.axual.kameleon.streamsApplication1",
  "name" : "Test Kafka Streams Application",
  "shortName" : "test_streams_app",
  "description" : "This is a kafka streams test application",
  "applicationType" : "CUSTOM",
  "type" : "Kafka Streams",
  "visibility" : "PRIVATE",
  "owners" : "http://api.example.com/groups/514d4oit834841869644c2ad8b439997"
}'

30.6.3. HTTP request

POST /applications HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 374
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "com.axual.kameleon.streamsApplication1",
  "name" : "Test Kafka Streams Application",
  "shortName" : "test_streams_app",
  "description" : "This is a kafka streams test application",
  "applicationType" : "CUSTOM",
  "type" : "Kafka Streams",
  "visibility" : "PRIVATE",
  "owners" : "http://api.example.com/groups/514d4oit834841869644c2ad8b439997"
}

30.6.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 08:08:14 GMT
Location: http://api.example.com/applications/4458f6e655fd481b968681e85410b782
Content-Type: application/hal+json
Content-Length: 7124

{
  "name" : "Test Kafka Streams Application",
  "shortName" : "test_streams_app",
  "description" : "This is a kafka streams test application",
  "applicationType" : "Custom",
  "type" : "Kafka Streams",
  "applicationClass" : null,
  "visibility" : "private",
  "owners" : {
    "name" : "Team App Admins",
    "emailAddress" : null,
    "phoneNumber" : null,
    "properties" : { },
    "uid" : "514d4oit834841869644c2ad8b439997",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "_embedded" : {
      "members" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "firstNameTest",
        "lastName" : "lastNameTest",
        "middleName" : "van der",
        "emailAddress" : {
          "email" : "testuser@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "avcdfr5c6d9e424ab1a9d9f767fc7cfd"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "caa51002633244ffbe36f4ccf8a8f501"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "e235c8fe4264431bbdb3b40a2e5f8f62"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "tenAdmin",
        "lastName" : "TenantActive",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "s39sef147df84179a151bdc21f5bb813"
      } ],
      "resourceManagers" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenantactive.nl"
        },
        "phoneNumber" : null,
        "uid" : "avcdfr5c6d9e424ab1a9d9f767fc7cfd"
      } ],
      "managers" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "firstNameTest",
        "lastName" : "lastNameTest",
        "middleName" : "van der",
        "emailAddress" : {
          "email" : "testuser@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
      } ]
    },
    "_links" : {
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      },
      "delete" : {
        "href" : "...",
        "title" : "Indication that this entity can be deleted"
      },
      "self" : {
        "href" : "...",
        "title" : "URI pointing to current request"
      },
      "members" : [ {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      } ],
      "resourceManagers" : {
        "href" : "...",
        "templated" : true
      },
      "managers" : {
        "href" : "...",
        "templated" : true
      }
    }
  },
  "properties" : { },
  "kafkaStreamsBased" : true,
  "connector" : false,
  "axualManagedKsml" : false,
  "kafkaStreams" : true,
  "customKsml" : false,
  "allApplicationIds" : [ "com.axual.kameleon.streamsApplication1" ],
  "ableToGenerateSchemaRegistryPassword" : true,
  "ableToResetOffsets" : false,
  "uid" : "4458f6e655fd481b968681e85410b782",
  "created_at" : "2025-06-25T08:08:14.576715958",
  "modified_at" : "2025-06-25T08:08:14.576715958",
  "created_by" : "poweruser@tenanta.nl",
  "modified_by" : "poweruser@tenanta.nl",
  "applicationId" : "com.axual.kameleon.streamsApplication1",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "createApplicationPrincipal" : {
      "href" : "..."
    },
    "createApplicationAccess" : {
      "href" : "..."
    },
    "reset" : {
      "href" : "..."
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}

30.7. Retrieve an application

The applications/{id} resource is used to retrieve, update and delete individual application.

A GET request will retrieve the details of an application.

30.7.1. HTTP request

GET /applications/5ffc4240fcdf4a479a16f2b0b12ab909 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

30.7.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 2883

{
  "name" : "tenantaApplication1",
  "shortName" : "tenanta_app1",
  "description" : "tenantaApplication1 description.",
  "applicationType" : "Custom",
  "type" : "Java",
  "applicationClass" : null,
  "visibility" : "public",
  "owners" : {
    "name" : "Application-tenAApplication1",
    "emailAddress" : null,
    "phoneNumber" : null,
    "properties" : { },
    "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "_embedded" : {
      "members" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "51234a7a81994d1ca35ca7894cde08c6"
      } ]
    },
    "_links" : {
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      },
      "delete" : {
        "href" : "...",
        "title" : "Indication that this entity can be deleted"
      },
      "self" : {
        "href" : "...",
        "title" : "URI pointing to current request"
      },
      "members" : [ {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      } ]
    }
  },
  "properties" : { },
  "kafkaStreamsBased" : false,
  "connector" : false,
  "axualManagedKsml" : false,
  "kafkaStreams" : false,
  "customKsml" : false,
  "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
  "ableToGenerateSchemaRegistryPassword" : false,
  "ableToResetOffsets" : true,
  "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "createApplicationPrincipal" : {
      "href" : "..."
    },
    "createApplicationAccess" : {
      "href" : "..."
    },
    "resetOffset" : {
      "href" : "..."
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}
Relation Description

edit

Existence of this link indicates that the currently authenticated user can edit this Application

delete

Existence of this link indicates that the currently authenticated user can cascade delete this Application

createApplicationPrincipal

Existence of this link indicates that the currently authenticated user can create the ApplicationPrincipal for this Application

createApplicationAccess

Existence of this link indicates that the currently authenticated user can request consuming or producing streams for this Application

resetOffset

Existence of this link indicates that the currently authenticated user can request offset manipulation operations for this Application

30.7.4. HTTP request

GET /applications/KafkaStreams-app19-ID-0000000000 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

30.7.5. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Mon, 04 Nov 2024 00:00:00 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 2868

{
  "name" : "KafkaStreamsApplication19",
  "shortName" : "tenenta_kstreams_19",
  "description" : "A KSML Application",
  "applicationType" : "Custom",
  "type" : "Kafka Streams",
  "applicationClass" : null,
  "visibility" : "public",
  "owners" : {
    "name" : "Application-tenAApplication1",
    "emailAddress" : null,
    "phoneNumber" : null,
    "properties" : { },
    "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "_embedded" : {
      "members" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "51234a7a81994d1ca35ca7894cde08c6"
      } ]
    },
    "_links" : {
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      },
      "delete" : {
        "href" : "...",
        "title" : "Indication that this entity can be deleted"
      },
      "self" : {
        "href" : "...",
        "title" : "URI pointing to current request"
      },
      "members" : [ {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      } ]
    }
  },
  "properties" : { },
  "kafkaStreamsBased" : true,
  "connector" : false,
  "axualManagedKsml" : false,
  "kafkaStreams" : true,
  "customKsml" : false,
  "allApplicationIds" : [ "nl-tenanta-kafkaStreams-app19" ],
  "ableToGenerateSchemaRegistryPassword" : true,
  "ableToResetOffsets" : false,
  "uid" : "KafkaStreams-app19-ID-0000000000",
  "created_at" : "2024-11-04T00:00:00",
  "modified_at" : "2024-11-04T00:00:00",
  "created_by" : null,
  "modified_by" : null,
  "applicationId" : "nl-tenanta-kafkaStreams-app19",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "createApplicationPrincipal" : {
      "href" : "..."
    },
    "createApplicationAccess" : {
      "href" : "..."
    },
    "reset" : {
      "href" : "..."
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}
Relation Description

edit

Existence of this link indicates that the currently authenticated user can edit this Application

delete

Existence of this link indicates that the currently authenticated user can cascade delete this Application

createApplicationPrincipal

Existence of this link indicates that the currently authenticated user can create the ApplicationPrincipal for this Application

createApplicationAccess

Existence of this link indicates that the currently authenticated user can request consuming or producing streams for this Application

reset

Existence of this link indicates that the currently authenticated user can request reset for this Kafka Streams based Application

30.8. Retrieve a connector/plugin config

The applications/{id}/config resource is used to retrieve default connector config define in the plugin class for a specific environment.

A GET request will retrieve the details of a connector/plugin config using a specific Environment resource.

If the environment has not configured this plugin class, the response will be empty.

30.8.1. Query parameters

Parameter Description

environment

A valid URI of an existing Environment

30.8.2. HTTP request

GET /applications/dbc9e4670h1c4866deg78722e2930d2g/config?environment=http%3A%2F%2Flocalhost%2Fenvironments%2F047ab08009fe4da8be6905b55552ab52 HTTP/1.1
Content-Type: application/json
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

30.8.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 2155

{
  "pluginConfigs" : [ {
    "name" : "connector.class",
    "type" : "STRING",
    "required" : true,
    "defaultValue" : null,
    "providedValue" : null,
    "importance" : "HIGH",
    "documentation" : "Name or alias of the class for this connector. Must be a subclass of org.apache.kafka.connect.connector.Connector. If the connector is org.apache.kafka.connect.file.FileStreamSinkConnector, you can either specify this full name,  or use \"FileStreamSink\" or \"FileStreamSinkConnector\" to make the configuration a bit shorter",
    "pluginConfigState" : null,
    "group" : "group1"
  }, {
    "name" : "key.converter",
    "type" : "CLASS",
    "required" : true,
    "defaultValue" : null,
    "providedValue" : null,
    "importance" : "LOW",
    "documentation" : null,
    "pluginConfigState" : null,
    "group" : "group1"
  }, {
    "name" : "logger.name",
    "type" : "STRING",
    "required" : true,
    "defaultValue" : null,
    "providedValue" : null,
    "importance" : "HIGH",
    "documentation" : "The name of the SLF4J Logger to write the messages",
    "pluginConfigState" : null,
    "group" : "group2"
  }, {
    "name" : "name",
    "type" : "STRING",
    "required" : true,
    "defaultValue" : null,
    "providedValue" : null,
    "importance" : "HIGH",
    "documentation" : "Globally unique name to use for this connector.",
    "pluginConfigState" : null,
    "group" : "group2"
  }, {
    "name" : "tasks.max",
    "type" : "INT",
    "required" : true,
    "defaultValue" : null,
    "providedValue" : null,
    "importance" : "LOW",
    "documentation" : null,
    "pluginConfigState" : null,
    "group" : "group3"
  }, {
    "name" : "transforms",
    "type" : "LIST",
    "required" : true,
    "defaultValue" : "",
    "providedValue" : "",
    "importance" : "LOW",
    "documentation" : "Aliases for the transformations to be applied to records.",
    "pluginConfigState" : null,
    "group" : "group1"
  } ],
  "unsupportedPluginConfigFound" : false,
  "newMandatoryPluginConfigFound" : false,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}
Relation Description

self

URI pointing to current request

If the environment is not passed, the first instance will be used for searching the plugin config.

30.8.5. HTTP request

GET /applications/dbc9e4670h1c4866deg78722e2930d2g/config HTTP/1.1
Content-Type: application/json
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

30.8.6. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 225

{
  "pluginConfigs" : [ ],
  "unsupportedPluginConfigFound" : false,
  "newMandatoryPluginConfigFound" : false,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}
Relation Description

self

URI pointing to current request

30.9. Update an application

A PATCH request is used to update an application. In the request, pass only the field that needs changing.

30.9.1. Curl request

$ curl 'http://api.example.com/applications/39d82d7994484b53ae1de37ee8924512' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "updated_name"
}'

30.9.2. HTTP request

PATCH /applications/39d82d7994484b53ae1de37ee8924512 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 29
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "updated_name"
}

30.9.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Sun, 01 Nov 2020 23:16:23 GMT
Content-Type: application/hal+json
Content-Length: 5525

{
  "name" : "updated_name",
  "shortName" : "test_revoke",
  "description" : "",
  "applicationType" : "Custom",
  "type" : "Java",
  "applicationClass" : null,
  "visibility" : "private",
  "owners" : {
    "name" : "Team Kad",
    "emailAddress" : null,
    "phoneNumber" : null,
    "properties" : { },
    "uid" : "514d4e9a834841869644c2ad8b439553",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "_embedded" : {
      "members" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "kad",
        "lastName" : "member",
        "middleName" : null,
        "emailAddress" : {
          "email" : "kadmember@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "007b994a6ab34165a93fd4c7a8db1388"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "strAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "stradmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "a0018341100c431d8a8117be2ad12d8a"
      }, {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "group",
        "lastName" : "manager",
        "middleName" : null,
        "emailAddress" : {
          "email" : "groupmanager@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "465a7a8db09a6ab3419913883fd4c07b"
      } ],
      "resourceManagers" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "group",
        "lastName" : "manager",
        "middleName" : null,
        "emailAddress" : {
          "email" : "groupmanager@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "465a7a8db09a6ab3419913883fd4c07b"
      } ],
      "managers" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "group",
        "lastName" : "manager",
        "middleName" : null,
        "emailAddress" : {
          "email" : "groupmanager@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "465a7a8db09a6ab3419913883fd4c07b"
      } ]
    },
    "_links" : {
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      },
      "delete" : {
        "href" : "...",
        "title" : "Indication that this entity can be deleted"
      },
      "self" : {
        "href" : "...",
        "title" : "URI pointing to current request"
      },
      "members" : [ {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      }, {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      } ],
      "resourceManagers" : {
        "href" : "...",
        "templated" : true
      },
      "managers" : {
        "href" : "...",
        "templated" : true
      }
    }
  },
  "properties" : { },
  "kafkaStreamsBased" : false,
  "connector" : false,
  "axualManagedKsml" : false,
  "kafkaStreams" : false,
  "customKsml" : false,
  "allApplicationIds" : [ "nl.tenanta.app.revoke" ],
  "ableToGenerateSchemaRegistryPassword" : false,
  "ableToResetOffsets" : true,
  "uid" : "39d82d7994484b53ae1de37ee8924512",
  "created_at" : "2020-11-01T23:16:23",
  "modified_at" : "2020-11-01T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "applicationId" : "nl.tenanta.app.revoke",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "createApplicationPrincipal" : {
      "href" : "..."
    },
    "createApplicationAccess" : {
      "href" : "..."
    },
    "resetOffset" : {
      "href" : "..."
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}

30.9.4. Update an application Shortname

Changing the application shortname is not allowed when one of the below conditions is matched.

  • application has deployment configured (either started or stopped)

  • application has credential configured

  • application has principal configured

Curl request
$ curl 'http://api.example.com/applications/5ffc4240fcdf4a479a16f2b0b12ab909' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "shortName" : "updated_name"
}'
HTTP request
PATCH /applications/5ffc4240fcdf4a479a16f2b0b12ab909 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 34
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "shortName" : "updated_name"
}
HTTP response
HTTP/1.1 400 Bad Request
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 482

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Application ShortName cannot be edited as there are existing Credentials, Deployments, or Principals for this application." ],
  "subErrors" : [ {
    "field" : "Application.shortName",
    "rejectedValue" : "updated_name",
    "recommendedValues" : null,
    "errors" : [ "Application ShortName cannot be edited as there are existing Credentials, Deployments, or Principals for this application." ]
  } ]
}

30.9.5. Update an application id

When updating the applicationId you should consider the following risks:

  • existing consumers will stop reading since the applicationId has changed

  • the new applicationID will make the new consumer read from the earliest offset available on the stream

Curl request
$ curl 'http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924502' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "applicationId" : "updated_applicationId"
}'
HTTP request
PATCH /applications/39d82d7f34484b53ae1dd47ee8924502 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 47
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "updated_applicationId"
}
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "1"
Last-Modified: Wed, 25 Jun 2025 08:08:13 GMT
Content-Type: application/hal+json
Content-Length: 2880

{
  "name" : "tenantaApplication2",
  "shortName" : "tenanta_app2",
  "description" : "tenantaApplication2 description.",
  "applicationType" : "Custom",
  "type" : "Java",
  "applicationClass" : null,
  "visibility" : "public",
  "owners" : {
    "name" : "Application-tenAApplication1",
    "emailAddress" : null,
    "phoneNumber" : null,
    "properties" : { },
    "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "_embedded" : {
      "members" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "51234a7a81994d1ca35ca7894cde08c6"
      } ]
    },
    "_links" : {
      "edit" : {
        "href" : "...",
        "title" : "Indication that this entity can be edited"
      },
      "delete" : {
        "href" : "...",
        "title" : "Indication that this entity can be deleted"
      },
      "self" : {
        "href" : "...",
        "title" : "URI pointing to current request"
      },
      "members" : [ {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      } ]
    }
  },
  "properties" : { },
  "kafkaStreamsBased" : false,
  "connector" : false,
  "axualManagedKsml" : false,
  "kafkaStreams" : false,
  "customKsml" : false,
  "allApplicationIds" : [ "updated_applicationId" ],
  "ableToGenerateSchemaRegistryPassword" : false,
  "ableToResetOffsets" : true,
  "uid" : "39d82d7f34484b53ae1dd47ee8924502",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2025-06-25T08:08:13.430041813",
  "created_by" : null,
  "modified_by" : "poweruser@tenanta.nl",
  "applicationId" : "updated_applicationId",
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "createApplicationPrincipal" : {
      "href" : "..."
    },
    "createApplicationAccess" : {
      "href" : "..."
    },
    "resetOffset" : {
      "href" : "..."
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}

30.9.6. Update viewer groups

A PATCH request is used to update an application to add/remove viewer groups. You can provide a valid list of URIs of the existing groups.

Curl request
$ curl 'http://api.example.com/applications/5ffc4240fcdf4a479a16f2b0b12ab909' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "viewers" : [ "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775", "http://api.example.com/groups/88eb98e0eff34fde923c15687e6d75d5" ]
}'
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
Content-Type: application/hal+json
Content-Length: 4301

{
  "name" : "tenantaApplication1",
  "shortName" : "tenanta_app1",
  "description" : "tenantaApplication1 description.",
  "applicationType" : "Custom",
  "type" : "Java",
  "applicationClass" : null,
  "visibility" : "public",
  "owners" : {
    "name" : "Application-tenAApplication1",
    "emailAddress" : null,
    "phoneNumber" : null,
    "properties" : { },
    "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "_embedded" : {
      "members" : [ {
        "_links" : {
          "tenant" : {
            "href" : "...",
            "title" : "A tenant"
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "settings" : { },
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "uid" : "51234a7a81994d1ca35ca7894cde08c6"
      } ]
    },
    "_links" : {
      "self" : {
        "href" : "...",
        "title" : "URI pointing to current request"
      },
      "members" : [ {
        "href" : "...",
        "templated" : true,
        "title" : "Users belonging to this group"
      } ]
    }
  },
  "properties" : { },
  "kafkaStreamsBased" : false,
  "connector" : false,
  "axualManagedKsml" : false,
  "kafkaStreams" : false,
  "customKsml" : false,
  "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
  "ableToGenerateSchemaRegistryPassword" : false,
  "ableToResetOffsets" : true,
  "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
  "_embedded" : {
    "viewers" : [ {
      "_links" : {
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ],
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "Stream-tenAApplication2",
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "88eb98e0eff34fde923c15687e6d75d5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ],
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "Application-tenAApplication1",
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "createApplicationPrincipal" : {
      "href" : "..."
    },
    "createApplicationAccess" : {
      "href" : "..."
    },
    "resetOffset" : {
      "href" : "..."
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}

30.10. Search endpoints

30.10.1. /applications/search/findByAttributes

A GET request is used to retrieve all applications based on paging parameters.

Query parameters
Parameter Description

sort

Property to sort on and the direction.

page

Navigate through different pages.

size

Property to define the page size.
HTTP request
GET /applications/search/findByAttributes?sort=name%2Casc&page=0&size=5 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 8910

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "KafkaStreamsApplication19",
      "type" : "Kafka Streams",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl-tenanta-kafkaStreams-app19",
      "applicationType" : "Custom",
      "shortName" : "tenenta_kstreams_19",
      "visibility" : "public",
      "applicationIds" : [ "nl-tenanta-kafkaStreams-app19" ],
      "description" : "A KSML Application",
      "uid" : "KafkaStreams-app19-ID-0000000000",
      "created_at" : "2024-11-04T00:00:00",
      "modified_at" : "2024-11-04T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "KafkaStreamsApplication20",
      "type" : "Kafka Streams",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl-tenanta-kafkaStreams-app20",
      "applicationType" : "Custom",
      "shortName" : "tenenta_kstreams_20",
      "visibility" : "public",
      "applicationIds" : [ "nl-tenanta-kafkaStreams-app20" ],
      "description" : "A KSML Application",
      "uid" : "KafkaStreams-app20-ID-0000000000",
      "created_at" : "2024-11-04T00:00:00",
      "modified_at" : "2024-11-04T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "KafkaStreamsApplication21",
      "type" : "Kafka Streams",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team with two resource managers",
        "emailAddress" : null,
        "uid" : "GroupWithTwoResourceManagers0000",
        "created_at" : "2025-06-07T23:16:23",
        "modified_at" : "2025-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl-tenanta-kafkaStreams-app21",
      "applicationType" : "Custom",
      "shortName" : "tenenta_kstreams_21",
      "visibility" : "public",
      "applicationIds" : [ "nl-tenanta-kafkaStreams-app21" ],
      "description" : "A Kafka Streams Application",
      "uid" : "KafkaStreams-app21-ID-0000000000",
      "created_at" : "2024-11-04T00:00:00",
      "modified_at" : "2024-11-04T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "publicEnvRevoke",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Kad",
        "emailAddress" : null,
        "uid" : "514d4e9a834841869644c2ad8b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app.revoke.public.env",
      "applicationType" : "Custom",
      "shortName" : "tenanta_revoke_public",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app.revoke.public.env" ],
      "description" : "",
      "uid" : "68e4d4e2e3e54ddc836006655d42a995",
      "created_at" : "2020-11-01T23:16:23",
      "modified_at" : "2020-11-01T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination1",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "c2e98e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 5,
    "totalElements" : 50,
    "totalPages" : 10,
    "number" : 0
  }
}
Filter by name

A GET request will retrieve an application by name. The parameter name is not case-sensitive.

This endpoint replaces the /applications/search/findByName.
Query parameters
Parameter Description

name

Application name to search for.
HTTP request
GET /applications/search/findByAttributes?name=tenantaApplication1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 16909

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app1",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
      "description" : "tenantaApplication1 description.",
      "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication14",
      "type" : "SOURCE",
      "applicationClass" : "io.axual.test.source.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app14",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app14",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app14" ],
      "description" : "",
      "uid" : "bb3234224b974292a607fe9dd80fe1ae",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication16",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app16",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "",
      "uid" : "bur6h4670h1c4866deg78722e2930d2g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication12",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app12",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app12",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app12" ],
      "description" : "",
      "uid" : "dhi9f4200h1c4230deg74322e2931e49",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication15",
      "type" : "SOURCE",
      "applicationClass" : "io.axual.test.source.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app15",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "",
      "uid" : "e2c4ef3de653462683a8a865879fd24d",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication13",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app13",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app13",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app13" ],
      "description" : "",
      "uid" : "ebd8f4670h1c4866deg78722e2930e3f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication17",
      "type" : null,
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app17",
      "applicationType" : "Ksml",
      "shortName" : "tenanta_app17",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app17" ],
      "description" : "",
      "uid" : "fe3234224b974292em07fe9dd80fe1fe",
      "created_at" : "2024-05-14T13:16:23",
      "modified_at" : "2024-05-14T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication11",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app11",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app11",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app11" ],
      "description" : "",
      "uid" : "ioi9f4670h1c4866deg78722e2921f5g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication18",
      "type" : null,
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.ksml.app18",
      "applicationType" : "Ksml",
      "shortName" : "tenanta_app18_ksml",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.ksml.app18" ],
      "description" : "A KSML Application",
      "uid" : "KSML-app18-ID-000000000000000000",
      "created_at" : "2024-05-14T00:00:00",
      "modified_at" : "2024-05-14T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication10",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app10",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app10",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app10" ],
      "description" : "",
      "uid" : "lmk9f4670h1c4866deg78722e2931e5g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 10,
    "totalPages" : 1,
    "number" : 0
  }
}
Filter by shortName

A GET request will retrieve an application by shortName. The parameter shortName is not case-sensitive.

This endpoint replaces the /applications/search/findByShortName.
Query parameters
Parameter Description

shortName

Application short name to search for.
HTTP request
GET /applications/search/findByAttributes?shortName=tenanta_app3 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2112

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app3",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app3",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app3" ],
      "description" : "tenantaApplication3 description.",
      "uid" : "39d82d7f34484b53ae1dd47ee8924512",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}
Filter by applicationType

A GET request will retrieve an application by applicationType. The parameter applicationType is not case-sensitive.

This endpoint replaces the /applications/search/findByApplicationType.
Query parameters
Parameter Description

applicationType

Application type to search for.
HTTP request
GET /applications/search/findByAttributes?applicationType=CUSTOM HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 33039

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "testRevoke",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Kad",
        "emailAddress" : null,
        "uid" : "514d4e9a834841869644c2ad8b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app.revoke",
      "applicationType" : "Custom",
      "shortName" : "test_revoke",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app.revoke" ],
      "description" : "",
      "uid" : "39d82d7994484b53ae1de37ee8924512",
      "created_at" : "2020-11-01T23:16:23",
      "modified_at" : "2020-11-01T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication2",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app2",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app2",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app2" ],
      "description" : "tenantaApplication2 description.",
      "uid" : "39d82d7f34484b53ae1dd47ee8924502",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app3",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app3",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app3" ],
      "description" : "tenantaApplication3 description.",
      "uid" : "39d82d7f34484b53ae1dd47ee8924512",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication4",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app4",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "tenantaApplication4 description.",
      "uid" : "4180e2f2493944948e4df46ba36ba964",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaAutoApplication3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team App Admins",
        "emailAddress" : null,
        "uid" : "514d4oit834841869644c2ad8b439997",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.auto.app3",
      "applicationType" : "Custom",
      "shortName" : "tenanta_auto_app3",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.auto.app3" ],
      "description" : "",
      "uid" : "4cc380171afc4c898b6f6c02caccf451",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app1",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
      "description" : "tenantaApplication1 description.",
      "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "publicEnvRevoke",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Kad",
        "emailAddress" : null,
        "uid" : "514d4e9a834841869644c2ad8b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app.revoke.public.env",
      "applicationType" : "Custom",
      "shortName" : "tenanta_revoke_public",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app.revoke.public.env" ],
      "description" : "",
      "uid" : "68e4d4e2e3e54ddc836006655d42a995",
      "created_at" : "2020-11-01T23:16:23",
      "modified_at" : "2020-11-01T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaAppWithViewers",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_with_viewers",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "tenantaApplication1 description.",
      "uid" : "8dc64240fcdf4a479a16f2b0b12ab909",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination10",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination10",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "a2e98e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaAutoApplication4",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team App Admins",
        "emailAddress" : null,
        "uid" : "514d4oit834841869644c2ad8b439997",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.auto.app4",
      "applicationType" : "Custom",
      "shortName" : "tenanta_auto_app4",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.auto.app4" ],
      "description" : "",
      "uid" : "aec9e4570f1c4866bef77722e2830d4b",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination1",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "c2e98e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaCustomKsmlApp20",
      "type" : "KSML",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl-tenanta-customKsml-app20",
      "applicationType" : "Custom",
      "shortName" : "tenanta_customksml_20",
      "visibility" : "public",
      "applicationIds" : [ "nl-tenanta-customKsml-app20" ],
      "description" : "A Custom KSML Application",
      "uid" : "CustomKSML-app20-ID-000000000000",
      "created_at" : "2024-05-14T00:00:00",
      "modified_at" : "2024-05-14T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination5",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination5",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e92e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination3",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831a74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination9",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination9",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831c74cf1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination7",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination7",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831c74ff1beb09510d0bf7377",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination6",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination6",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831c74ff1beb09510d0bf7e17",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantbApplication2",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenantb_app2",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination11",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination11",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831c74ff6beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination4",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination4",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831cc4ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 32,
    "totalPages" : 2,
    "number" : 0
  }
}
Filter by visibility

A GET request will retrieve an application by visibility.

Query parameters
Parameter Description

visibility

Application visibility to search for.
HTTP request
GET /applications/search/findByAttributes?visibility=PRIVATE HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 8612

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "testRevoke",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Kad",
        "emailAddress" : null,
        "uid" : "514d4e9a834841869644c2ad8b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app.revoke",
      "applicationType" : "Custom",
      "shortName" : "test_revoke",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app.revoke" ],
      "description" : "",
      "uid" : "39d82d7994484b53ae1de37ee8924512",
      "created_at" : "2020-11-01T23:16:23",
      "modified_at" : "2020-11-01T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app3",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app3",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app3" ],
      "description" : "tenantaApplication3 description.",
      "uid" : "39d82d7f34484b53ae1dd47ee8924512",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "publicEnvRevoke",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Kad",
        "emailAddress" : null,
        "uid" : "514d4e9a834841869644c2ad8b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app.revoke.public.env",
      "applicationType" : "Custom",
      "shortName" : "tenanta_revoke_public",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app.revoke.public.env" ],
      "description" : "",
      "uid" : "68e4d4e2e3e54ddc836006655d42a995",
      "created_at" : "2020-11-01T23:16:23",
      "modified_at" : "2020-11-01T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaPrivApp3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team App Admins",
        "emailAddress" : null,
        "uid" : "514d4oit834841869644c2ad8b439997",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_priv_app3_2",
      "visibility" : "private",
      "applicationIds" : [ ],
      "description" : "tenantaPrivApp3 description.",
      "uid" : "f692ca5191764258b7257a6b2a7fb188",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication10",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app10",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app10",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app10" ],
      "description" : "",
      "uid" : "lmk9f4670h1c4866deg78722e2931e5g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}
Filter by applicationId

A GET request will retrieve an application by applicationId. The parameter applicationId is not case-sensitive.

This endpoint replaces /applications/search/findByApplicationId.
Query parameters
Parameter Description

applicationId

Application Id to search for.
HTTP request
GET /applications/search/findByAttributes?applicationId=nl.tenanta.app1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 12029

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app1",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
      "description" : "tenantaApplication1 description.",
      "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication14",
      "type" : "SOURCE",
      "applicationClass" : "io.axual.test.source.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app14",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app14",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app14" ],
      "description" : "",
      "uid" : "bb3234224b974292a607fe9dd80fe1ae",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication12",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app12",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app12",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app12" ],
      "description" : "",
      "uid" : "dhi9f4200h1c4230deg74322e2931e49",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication13",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app13",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app13",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app13" ],
      "description" : "",
      "uid" : "ebd8f4670h1c4866deg78722e2930e3f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication17",
      "type" : null,
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app17",
      "applicationType" : "Ksml",
      "shortName" : "tenanta_app17",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app17" ],
      "description" : "",
      "uid" : "fe3234224b974292em07fe9dd80fe1fe",
      "created_at" : "2024-05-14T13:16:23",
      "modified_at" : "2024-05-14T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication11",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app11",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app11",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app11" ],
      "description" : "",
      "uid" : "ioi9f4670h1c4866deg78722e2921f5g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication10",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app10",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app10",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app10" ],
      "description" : "",
      "uid" : "lmk9f4670h1c4866deg78722e2931e5g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 7,
    "totalPages" : 1,
    "number" : 0
  }
}
Filter by groupName

A GET request will retrieve an application by groupName. The parameter groupName is not case-sensitive.

Query parameters
Parameter Description

groupName

Application owner name to search for.
HTTP request
GET /applications/search/findByAttributes?groupName=Team+App+Admins HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 8553

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaAutoApplication3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team App Admins",
        "emailAddress" : null,
        "uid" : "514d4oit834841869644c2ad8b439997",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.auto.app3",
      "applicationType" : "Custom",
      "shortName" : "tenanta_auto_app3",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.auto.app3" ],
      "description" : "",
      "uid" : "4cc380171afc4c898b6f6c02caccf451",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaAutoApplication4",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team App Admins",
        "emailAddress" : null,
        "uid" : "514d4oit834841869644c2ad8b439997",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.auto.app4",
      "applicationType" : "Custom",
      "shortName" : "tenanta_auto_app4",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.auto.app4" ],
      "description" : "",
      "uid" : "aec9e4570f1c4866bef77722e2830d4b",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaAutoApplication5",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team App Admins",
        "emailAddress" : null,
        "uid" : "514d4oit834841869644c2ad8b439997",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.auto.app5",
      "applicationType" : "Custom",
      "shortName" : "tenanta_auto_app_5",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.auto.app5" ],
      "description" : null,
      "uid" : "f2effe1852b74ff6beb09510d0bf7e77",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaPrivApp3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team App Admins",
        "emailAddress" : null,
        "uid" : "514d4oit834841869644c2ad8b439997",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_priv_app3_2",
      "visibility" : "private",
      "applicationIds" : [ ],
      "description" : "tenantaPrivApp3 description.",
      "uid" : "f692ca5191764258b7257a6b2a7fb188",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication5",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team App Admins",
        "emailAddress" : null,
        "uid" : "514d4oit834841869644c2ad8b439997",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app5",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app5",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app5" ],
      "description" : "",
      "uid" : "fdc9e4570f1c4866bef77722e2830d5g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}
Filter by applicationClass

A GET request will retrieve an application by applicationClass. The parameter applicationClass is not case-sensitive.

Query parameters
Parameter Description

applicationClass

Application Class to search for.
HTTP request
GET /applications/search/findByAttributes?applicationClass=io.axual.test.sink.plugin HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 15259

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication16",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app16",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "",
      "uid" : "bur6h4670h1c4866deg78722e2930d2g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication6",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app6",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app6",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app6" ],
      "description" : "",
      "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication12",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app12",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app12",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app12" ],
      "description" : "",
      "uid" : "dhi9f4200h1c4230deg74322e2931e49",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication7",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app7",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app7",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app7" ],
      "description" : "",
      "uid" : "ead8f4670h1c4866deg78722e2930e3f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication13",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app13",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app13",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app13" ],
      "description" : "",
      "uid" : "ebd8f4670h1c4866deg78722e2930e3f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication8",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app8",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app8",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app8" ],
      "description" : "",
      "uid" : "fbe9f4670h1c4866deg78722e2931e4g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication9",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app9",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app9",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app9" ],
      "description" : "",
      "uid" : "ghi9f4670h1c4866deg78722e2931e4g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication11",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app11",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app11",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app11" ],
      "description" : "",
      "uid" : "ioi9f4670h1c4866deg78722e2921f5g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication10",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app10",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app10",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app10" ],
      "description" : "",
      "uid" : "lmk9f4670h1c4866deg78722e2931e5g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 9,
    "totalPages" : 1,
    "number" : 0
  }
}
Filter by myApplications

A GET request will retrieve an application owned by the user if the parameter myApplications is set to true.

Query parameters
Parameter Description

myApplications

My Applications to search for owned applications.
HTTP request
GET /applications/search/findByAttributes?myApplications=true HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 3681

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication4",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app4",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "tenantaApplication4 description.",
      "uid" : "4180e2f2493944948e4df46ba36ba964",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication15",
      "type" : "SOURCE",
      "applicationClass" : "io.axual.test.source.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app15",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "",
      "uid" : "e2c4ef3de653462683a8a865879fd24d",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}
Filter by multiple attributes

A GET request can be used to search an application based on multiple params. name, shortName, applicationType, applicationClass, applicationId and visibility are optional parameters.

Query parameters
Parameter Description

name

Application name to search for.

applicationId

Application id list to search for.

shortName

Application short name to search for.

groupName

Application owner name to search for.

applicationType

Application type to search for.

applicationClass

Application Class to search for.

visibility

Application visibility to search for.
HTTP request
GET /applications/search/findByAttributes?name=tenantaApplication14&applicationId=nl.tenanta.app14&shortName=tenanta_app14&groupName=Application-tenAApplication1&applicationType=CONNECTOR&applicationClass=io.axual.test.source.plugin&visibility=PUBLIC HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2113

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication14",
      "type" : "SOURCE",
      "applicationClass" : "io.axual.test.source.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app14",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app14",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app14" ],
      "description" : "",
      "uid" : "bb3234224b974292a607fe9dd80fe1ae",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

30.10.2. /applications/search/findByNameContaining

Search for an application by name containing search term and order by a nested property.

Query parameters
Parameter Description

name

Term to search within application name.

sort

Property to sort on and the direction.
HTTP request
GET /applications/search/findByNameContaining?name=app&sort=owners.name%2Casc HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 33179

{
  "_embedded" : {
    "applications" : [ {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "KafkaStreamsApplication19",
      "type" : "Kafka Streams",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl-tenanta-kafkaStreams-app19",
      "applicationType" : "Custom",
      "shortName" : "tenenta_kstreams_19",
      "visibility" : "public",
      "applicationIds" : [ "nl-tenanta-kafkaStreams-app19" ],
      "description" : "A KSML Application",
      "uid" : "KafkaStreams-app19-ID-0000000000",
      "created_at" : "2024-11-04T00:00:00",
      "modified_at" : "2024-11-04T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "KafkaStreamsApplication20",
      "type" : "Kafka Streams",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl-tenanta-kafkaStreams-app20",
      "applicationType" : "Custom",
      "shortName" : "tenenta_kstreams_20",
      "visibility" : "public",
      "applicationIds" : [ "nl-tenanta-kafkaStreams-app20" ],
      "description" : "A KSML Application",
      "uid" : "KafkaStreams-app20-ID-0000000000",
      "created_at" : "2024-11-04T00:00:00",
      "modified_at" : "2024-11-04T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination1",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "c2e98e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination10",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination10",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "a2e98e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination11",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination11",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831c74ff6beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination2",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination2",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2f98e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination3",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination3",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831a74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination4",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination4",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831cc4ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination5",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination5",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e92e1831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination6",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination6",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831c74ff1beb09510d0bf7e17",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination7",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination7",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831c74ff1beb09510d0bf7377",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination8",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination8",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98ef831c74ff1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_app_pagination9",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app_pagination9",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : null,
      "uid" : "d2e98e1831c74cf1beb09510d0bf7e77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app1",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
      "description" : "tenantaApplication1 description.",
      "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication10",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app10",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app10",
      "visibility" : "private",
      "applicationIds" : [ "nl.tenanta.app10" ],
      "description" : "",
      "uid" : "lmk9f4670h1c4866deg78722e2931e5g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication11",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app11",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app11",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app11" ],
      "description" : "",
      "uid" : "ioi9f4670h1c4866deg78722e2921f5g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication12",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app12",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app12",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app12" ],
      "description" : "",
      "uid" : "dhi9f4200h1c4230deg74322e2931e49",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication13",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app13",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app13",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app13" ],
      "description" : "",
      "uid" : "ebd8f4670h1c4866deg78722e2930e3f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication14",
      "type" : "SOURCE",
      "applicationClass" : "io.axual.test.source.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app14",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app14",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app14" ],
      "description" : "",
      "uid" : "bb3234224b974292a607fe9dd80fe1ae",
      "created_at" : "2021-02-02T13:16:23",
      "modified_at" : "2021-02-02T13:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication16",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app16",
      "visibility" : "public",
      "applicationIds" : [ ],
      "description" : "",
      "uid" : "bur6h4670h1c4866deg78722e2930d2g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 48,
    "totalPages" : 3,
    "number" : 0
  }
}

30.11. Get Connectivity Information

A GET request is employed to retrieve Kafka and SchemaRegistry information associated with the requested environment, streamlining the configuration process for applications.

30.11.1. Curl request

$ curl 'http://api.example.com/applications/5ffc4240fcdf4a479a16f2b0b12ab909/connectivityInfo?environmentId=e11ee2dd976647109ca904dd8adc050f' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

30.11.2. HTTP request

GET /applications/5ffc4240fcdf4a479a16f2b0b12ab909/connectivityInfo?environmentId=e11ee2dd976647109ca904dd8adc050f HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

30.11.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 988

{
  "clusters" : [ {
    "clusterName" : "Zone1ClusterOTA",
    "kafkaVersion" : "3.5.1",
    "kafkaListeners" : {
      "MUTUAL_TLS" : "broker:9090"
    },
    "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
    "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
    "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
    "schemaRegistryVersion" : "2.8.0",
    "schemaRegistryListeners" : {
      "NO_AUTH" : "sr-url:25000",
      "TLS" : "sr-url:24000"
    }
  }, {
    "clusterName" : "Zone2ClusterOTA",
    "kafkaVersion" : "3.4.0",
    "kafkaListeners" : { },
    "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
    "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
    "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
    "schemaRegistryVersion" : "2.8.0",
    "schemaRegistryListeners" : {
      "TLS" : "sr-url:24000"
    }
  } ],
  "topics" : [ "tenanta-stream1" ]
}

30.12. Delete endpoints

Deleting application is a two-step process a GET request to check the constraints followed by the DELETE request

30.12.1. Delete application constraints

A GET request is used to get the constraints for deleting Application.

Curl request
$ curl 'http://api.example.com/applications/5ffc4240fcdf4a479a16f2b0b12ab909/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /applications/5ffc4240fcdf4a479a16f2b0b12ab909/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 523

{
  "canDelete" : false,
  "activeDeploymentsCount" : 0,
  "activeDeployments" : [ ],
  "activeAuthenticationsCount" : 2,
  "activeAuthentications" : [ {
    "environmentName" : "tenantaenv1"
  }, {
    "environmentName" : "tenantaenv1"
  } ],
  "activeGrantsCount" : 2,
  "activeGrants" : [ {
    "streamName" : "tenanta-stream1",
    "environmentName" : "tenantaenv2",
    "accessType" : "PRODUCER"
  }, {
    "streamName" : "tenanta-stream1",
    "environmentName" : "tenantaenv10",
    "accessType" : "PRODUCER"
  } ]
}

30.12.2. Delete application

A DELETE request is used to delete an Application.

It is important to know that executing this operation will result in the deletion of not only the application itself but also its associated entities, including application principals, credentials, deployments, accesses and access grants.

Curl request
$ curl 'http://api.example.com/applications/fdc9e4570f1c4866bef77722e2830d5g' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
HTTP request
DELETE /applications/fdc9e4570f1c4866bef77722e2830d5g HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

30.13. External Provider Specific

If the provided environment is configured on a multi-cluster instance, the credential creation will be done for all the connected clusters.

30.13.1. Create Authentication on any Providers

Create User on Aiven

A POST request will create a user on Aiven provider.

Request fields
Path Type Description Constraints

applicationId

String

The applicationId of the Application.

Must not be null

environmentId

String

The environmentId of the Environment.

Must not be null
HTTP request
POST /application_authentications HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 136
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "8180e2f2493944948e4df46ba36ba953",
  "environmentId" : "84d93e918d49430fbf1d8cc7494d24d4",
  "target" : "KAFKA"
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 7288

[ {
  "authData" : {
    "privateKey" : "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDBXcezkUjIzQrI\nZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9KhpJdWXUFhijSFzLDHHl3\nGwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk5OGIRyvNOj8EXazh+z6Y\n2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvTWDl3H2NpfZUcHhZ6+6U0\nX1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG6gJcw9Ns8z8GoDdQ+NYN\nP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQar8kSu5PpHFMXLYH8U/Ty\nYs9UjLXTAgMBAAECggEBAJMfj3qI6CAgIjwngrff+N5+E8EbfD9CMkDkNoKipVWB\njFJfE4uO2+i9AjZp/aMZFXiGgziWfgEGAUUmPho1HsmLDFOAanF86FIKzrPY0DPh\nUOqfj1scg0q1eexqWU8fF6ymzJu9ynSGfTJAANLHh7UbgzYsT61U5IiT7136uJOa\nUGK6bK79ZYZaDamNr/+QqtpgEsCxI8db6rfvvyXWXuSdMW090NMhduZc0WDgxxnS\nz3N3ywkSeGZpkzn1wVjkFRK70a9z9eGZN9s50B1pt6geNS8yaY3ieJ5nbCQGHy9t\nYgTDLgvTxdzzYsH7HDxiS2Regd6/frjfXKe3P8D2HwECgYEA3eEPniANpRES+32v\nX3mwGsolkaRwRmLvTEcfDmKeMZEAGsq0fp1ZYvcJxyJ/yD/6GE6HnvD/owpMM04k\nBW8o/F9juiSFK6QOiPKcphrhafbwdCAU7o+u+IuSivMQmtYJrYsN21TtkuhRrUgF\nEBoHRg6m9qfEY9Et0Yj8mRp2H3ECgYEA3xo59w6gcYoX/x6wPIj+M2nvgDLIHewa\nYhtnL9LFHDerTdf2cS6sfPB0zxv/SXR5V9pdRL4nr2nQzI/xbMX73KUR0SL4UAgE\nVUurLsttYZA/KhBS1sH814hQHNHCoPgNOAntdplkhS2Lydw/XsfWJfrFqlI+IPWk\nclCx82bzD4MCgYEAmTMj+HeDVF0ksTdIFvFL0kOPiy9yQndfaViWLfWT6v+Ghfk+\nhUoaBQYz3yaH+nmKMqxOYkVfDXE3yhkDMClfsFog3s8GkGp3isGRvfNDf0n9HwFj\n0pCtLHoalgxcg7yT9BrWV4Idg9kbRD09GbAPI6VMTXTrWkx9iXc/imtF8lECgYEA\ns5pyZZCR2zV3gfsbl3AVbCBxHTxEW8pRpv82f4pnAgNS1bTxAUa4t1AASSbZyjGI\n6g+xnACVBCLkY3nRumZcDtGYWUuUqSD7FAt5gI9lu/Aa2WsQtTCvsndbPwgibeGj\nCqT7VMnB4XC8I0I6hbvMiwCpliblOzVlMF4EE9WiAK8CgYAfbdwcDUA0bC5NbwD1\n9+6KF01Ib7M9DL+Hrfe+ZUGd0V4FRckHCGnnDFU4vMR+LqBWjIuVSUQhmayH5KGT\nqHXkVQ61+HLTV3mEdSwRd66VzVhaEAj2TZjgGohvL9J8ubjV31WDlZUAs1SktwMp\nLe5QuxBs1CmFW6mlX6AvOfypJQ==\n-----END PRIVATE KEY-----\n",
    "password" : "PasswordForAiven",
    "provider" : "aiven",
    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
    "clusters" : "BYOKClusterForAiven",
    "username" : "UserNameForAiven"
  }
} ]
Create Credential on Confluent Cloud

A POST request will create a credential on Confluent Cloud provider.

Request fields
Path Type Description Constraints

applicationId

String

The applicationId of the Application.

Must not be null

environmentId

String

The environmentId of the Environment.

Must not be null
HTTP request
POST /application_authentications HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 136
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "8180e2f2493944948e4df46ba36ba953",
  "environmentId" : "12w33e918d49430fbf1d8cc7494d22e3",
  "target" : "KAFKA"
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 375

[ {
  "authData" : {
    "APPLICATION_CREDENTIAL_ID" : "666b80d9fa1049d78d17566b4a0e4436",
    "resourceId" : "resourceId",
    "SCHEMA_REGISTRY_API_KEY" : "schema-registry-api-key",
    "SCHEMA_REGISTRY_API_SECRET" : "schema-registry-secret",
    "CLUSTER_API_KEY" : "cluster-api-key",
    "CLUSTER_API_SECRET" : "cluster-secret",
    "clusters" : "BYOKClusterForCC"
  }
} ]
Create Credential on Apache Kafka

A POST request will create a credential on Apache Kafka provider.

In case the provided environment is configured on a multi-cluster instance, the created username and password will be identical among all the clusters.
Request fields
Path Type Description Constraints

applicationId

String

The applicationId of the Application.

Must not be null

environmentId

String

The environmentId of the Environment.

Must not be null
HTTP request
POST /application_authentications HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 136
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "8180e2f2493944948e4df46ba36ba953",
  "environmentId" : "65f24r918d49430fbf1d8cc7494d22e3",
  "target" : "KAFKA"
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 223

[ {
  "authData" : {
    "password" : "weR6wX0CsU",
    "provider" : "apache-kafka",
    "clusters" : "BYOKReplica1ForApacheKafka,BYOKReplica2ForApacheKafka",
    "username" : "tenant_byok_app1homogeneous-585157606"
  }
} ]

30.13.2. Delete User on any Providers

Aiven Provider

A DELETE request will delete a user on Aiven provider.

Request fields
Path Type Description Constraints

applicationId

String

The applicationId of the Application.

Must not be null

environmentId

String

The environmentId of the Environment.

Must not be null

configs

Object

Optional parameters that are provider specific. username is mandatory for aiven provider.
HTTP request
DELETE /application_authentications HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 229
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "8180e2f2493944948e4df46ba36ba953",
  "environmentId" : "84d93e918d49430fbf1d8cc7494d24d4",
  "applicationCredentialId" : null,
  "configs" : {
    "username" : "tenantbyok-app-1"
  },
  "target" : "KAFKA"
}
HTTP response
HTTP/1.1 204 No Content
Confluent Cloud provider

A DELETE request will delete a user on ConfluentCloud provider.

Request fields
Path Type Description Constraints

applicationId

String

The applicationId of the Application.

Must not be null

environmentId

String

The environmentId of the Application.

Must not be null

configs

Object

Optional parameters that are provider specific. clusterApiKey is mandatory and srApiKey is optional for confluent-cloud provider.
HTTP request
DELETE /application_authentications HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 271
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "1a38e26ef9e140439ea41235127e6fd5",
  "environmentId" : "48c53e918d49430fbf1d8cc7494d24d4",
  "applicationCredentialId" : null,
  "configs" : {
    "srApiKey" : "QXVKSM5M773JD7MV",
    "clusterApiKey" : "65PHUTPE4B6PXHIN"
  },
  "target" : "KAFKA"
}
HTTP response
HTTP/1.1 204 No Content
Apache Kafka provider

A DELETE request will delete a credential on Apache Kafka provider.

Request fields
Path Type Description Constraints

applicationId

String

The applicationId of the Application.

Must not be null

environmentId

String

The environmentId of the Environment.

Must not be null

configs

Object

Optional parameters that are provider specific. username is mandatory for Apache Kafka provider.
HTTP request
DELETE /application_authentications HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 229
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "8180e2f2493944948e4df46ba36ba953",
  "environmentId" : "84d93e918d49430fbf1d8cc7494d24d4",
  "applicationCredentialId" : null,
  "configs" : {
    "username" : "tenantbyok-app-1"
  },
  "target" : "KAFKA"
}
HTTP response
HTTP/1.1 204 No Content

30.13.3. Export Applications in CSV

A GET request is used to export a CSV containing information about the Applications.

$ curl 'http://api.example.com/export/applications' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /export/applications HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Disposition: attachment; filename="applications.csv"
Content-Length: 11291

"NAME","SHORT_NAME","APPLICATION_CLASS","DESCRIPTION","APPLICATION_ID","APPLICATION_IDS","VISIBILITY","APPLICATION_TYPE","TYPE","CREATED_BY","MODIFIED_BY","OWNERS_GROUP_NAME","CREATED_AT","MODIFIED_AT"
"testRevoke","test_revoke","","","nl.tenanta.app.revoke","nl.tenanta.app.revoke","PRIVATE","CUSTOM","Java","","","Team Kad","2020-11-01T23:16:23Z[Etc/UTC]","2020-11-01T23:16:23Z[Etc/UTC]"
"tenantaApplication2","tenanta_app2","","tenantaApplication2 description.","nl.tenanta.app2","nl.tenanta.app2","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication3","tenanta_app3","","tenantaApplication3 description.","nl.tenanta.app3","nl.tenanta.app3","PRIVATE","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication4","tenanta_app4","","tenantaApplication4 description.","","","PUBLIC","CUSTOM","Java","","","Environment-tenAenv1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaAutoApplication3","tenanta_auto_app3","","","nl.tenanta.auto.app3","nl.tenanta.auto.app3","PUBLIC","CUSTOM","Java","","","Team App Admins","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaKsmlApplication3","tenanta_ksml_app3","","","","","PUBLIC","KSML","","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication1","tenanta_app1","","tenantaApplication1 description.","nl.tenanta.app1,nl.tenanta.new.app1","nl.tenanta.new.app1","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"publicEnvRevoke","tenanta_revoke_public","","","nl.tenanta.app.revoke.public.env","nl.tenanta.app.revoke.public.env","PRIVATE","CUSTOM","Java","","","Team Kad","2020-11-01T23:16:23Z[Etc/UTC]","2020-11-01T23:16:23Z[Etc/UTC]"
"tenantaApplication25","tenanta_app25","","","","","PUBLIC","CONNECTOR","","","","Application-tenAApplication1","2024-05-14T13:16:23Z[Etc/UTC]","2024-05-14T13:16:23Z[Etc/UTC]"
"tenantaKsmlApplication1","tenanta_ksml_app1","","","","","PUBLIC","KSML","","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaAppWithViewers","tenanta_app_with_viewers","","tenantaApplication1 description.","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_app_pagination10","tenanta_app_pagination10","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaAutoApplication4","tenanta_auto_app4","","","nl.tenanta.auto.app4","nl.tenanta.auto.app4","PUBLIC","CUSTOM","Java","","","Team App Admins","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantAappWithManagers","tenantA_withManagers","","tenantA managed Ksml description.","","","PUBLIC","CONNECTOR","","","","Team with two resource managers","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication14","tenanta_app14","io.axual.test.source.plugin","","nl.tenanta.app14","nl.tenanta.app14","PUBLIC","CONNECTOR","SOURCE","","","Application-tenAApplication1","2021-02-02T13:16:23Z[Etc/UTC]","2021-02-02T13:16:23Z[Etc/UTC]"
"tenantaApplication16","tenanta_app16","io.axual.test.sink.plugin","","","","PUBLIC","CONNECTOR","SINK","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_app_pagination1","tenanta_app_pagination1","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaCustomKsmlApp20","tenanta_customksml_20","","A Custom KSML Application","nl-tenanta-customKsml-app20","nl-tenanta-customKsml-app20","PUBLIC","CUSTOM","KSML","","","Application-tenAApplication1","2024-05-14T00:00:00Z[Etc/UTC]","2024-05-14T00:00:00Z[Etc/UTC]"
"tenanta_app_pagination5","tenanta_app_pagination5","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_app_pagination3","tenanta_app_pagination3","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_app_pagination9","tenanta_app_pagination9","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_app_pagination7","tenanta_app_pagination7","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_app_pagination6","tenanta_app_pagination6","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantbApplication2","tenantb_app2","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_app_pagination11","tenanta_app_pagination11","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_app_pagination4","tenanta_app_pagination4","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_app_pagination8","tenanta_app_pagination8","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_app_pagination2","tenanta_app_pagination2","","","","","PUBLIC","CUSTOM","Java","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication6","tenanta_app6","io.axual.test.sink.plugin","","nl.tenanta.app6","nl.tenanta.app6","PUBLIC","CONNECTOR","SINK","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication12","tenanta_app12","io.axual.test.sink.plugin","","nl.tenanta.app12","nl.tenanta.app12","PUBLIC","CONNECTOR","SINK","","","Application-tenAApplication1","2021-02-02T13:16:23Z[Etc/UTC]","2021-02-02T13:16:23Z[Etc/UTC]"
"tenantaApplication15","tenanta_app15","io.axual.test.source.plugin","","","","PUBLIC","CONNECTOR","SOURCE","","","Environment-tenAenv1","2021-02-02T13:16:23Z[Etc/UTC]","2021-02-02T13:16:23Z[Etc/UTC]"
"tenantaApplication7","tenanta_app7","io.axual.test.sink.plugin","","nl.tenanta.app7","nl.tenanta.app7","PUBLIC","CONNECTOR","SINK","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication13","tenanta_app13","io.axual.test.sink.plugin","","nl.tenanta.app13","nl.tenanta.app13","PUBLIC","CONNECTOR","SINK","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaKsmlApplication2","tenanta_ksml_app2","","","tenantaKsmlApplication2","tenantaKsmlApplication2","PUBLIC","KSML","","","","Application-tenAApplication1","2024-05-16T23:16:23Z[Etc/UTC]","2042-05-16T23:16:23Z[Etc/UTC]"
"tenantaAutoApplication5","tenanta_auto_app_5","","","nl.tenanta.auto.app5","nl.tenanta.auto.app5","PUBLIC","CUSTOM","Java","","","Team App Admins","2021-06-07T23:16:23Z[Etc/UTC]","2021-06-07T23:16:23Z[Etc/UTC]"
"tenantaPrivApp3","tenanta_priv_app3_2","","tenantaPrivApp3 description.","","","PRIVATE","CUSTOM","Java","","","Team App Admins","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication8","tenanta_app8","io.axual.test.sink.plugin","","nl.tenanta.app8","nl.tenanta.app8","PUBLIC","CONNECTOR","SINK","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication5","tenanta_app5","","","nl.tenanta.app5","nl.tenanta.app5","PUBLIC","CUSTOM","Java","","","Team App Admins","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication17","tenanta_app17","","","nl.tenanta.app17","nl.tenanta.app17","PUBLIC","KSML","","","","Application-tenAApplication1","2024-05-14T13:16:23Z[Etc/UTC]","2024-05-14T13:16:23Z[Etc/UTC]"
"tenantaApplication9","tenanta_app9","io.axual.test.sink.plugin","","nl.tenanta.app9","nl.tenanta.app9","PUBLIC","CONNECTOR","SINK","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"tenantaApplication11","tenanta_app11","io.axual.test.sink.plugin","","nl.tenanta.app11","nl.tenanta.app11","PUBLIC","CONNECTOR","SINK","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"
"KafkaStreamsApplication19","tenenta_kstreams_19","","A KSML Application","nl-tenanta-kafkaStreams-app19","nl-tenanta-kafkaStreams-app19","PUBLIC","CUSTOM","Kafka Streams","","","Application-tenAApplication1","2024-11-04T00:00:00Z[Etc/UTC]","2024-11-04T00:00:00Z[Etc/UTC]"
"KafkaStreamsApplication20","tenenta_kstreams_20","","A KSML Application","nl-tenanta-kafkaStreams-app20","nl-tenanta-kafkaStreams-app20","PUBLIC","CUSTOM","Kafka Streams","","","Application-tenAApplication1","2024-11-04T00:00:00Z[Etc/UTC]","2024-11-04T00:00:00Z[Etc/UTC]"
"KafkaStreamsApplication21","tenenta_kstreams_21","","A Kafka Streams Application","nl-tenanta-kafkaStreams-app21","nl-tenanta-kafkaStreams-app21","PUBLIC","CUSTOM","Kafka Streams","","","Team with two resource managers","2024-11-04T00:00:00Z[Etc/UTC]","2024-11-04T00:00:00Z[Etc/UTC]"
"tenantaApplication18","tenanta_app18_ksml","","A KSML Application","nl.tenanta.ksml.app18","nl.tenanta.ksml.app18","PUBLIC","KSML","","","","Application-tenAApplication1","2024-05-14T00:00:00Z[Etc/UTC]","2024-05-14T00:00:00Z[Etc/UTC]"
"tenantaCollisionApp23","tenanta_collision_23","","A Custom Kafka Streams Application for application id collision testing","collision-base","collision-base","PUBLIC","CUSTOM","Kafka Streams","","","Application-tenAApplication1","2024-05-14T00:00:00Z[Etc/UTC]","2024-05-14T00:00:00Z[Etc/UTC]"
"tenantaCollisionApp24","tenanta_collision_24","","A Custom Kafka Streams Application for application id collision testing","collision-base-2","collision-base-2","PUBLIC","CUSTOM","Kafka Streams","","","Application-tenAApplication1","2024-05-14T00:00:00Z[Etc/UTC]","2024-05-14T00:00:00Z[Etc/UTC]"
"tenantaCollisionApp21","tenanta_collision_21","","A Custom Kafka Streams Application for topic name collision testing","tenanta-stream-avro","tenanta-stream-avro","PUBLIC","CUSTOM","Kafka Streams","","","Application-tenAApplication1","2024-05-14T00:00:00Z[Etc/UTC]","2024-05-14T00:00:00Z[Etc/UTC]"
"tenantaCollisionApp22","tenanta_collision_22","","A Custom Kafka Streams Application for topic name collision testing","collision-topic-name","collision-topic-name","PUBLIC","CUSTOM","Kafka Streams","","","Application-tenAApplication1","2024-05-14T00:00:00Z[Etc/UTC]","2024-05-14T00:00:00Z[Etc/UTC]"
"tenantaApplication10","tenanta_app10","io.axual.test.sink.plugin","","nl.tenanta.app10","nl.tenanta.app10","PRIVATE","CONNECTOR","SINK","","","Application-tenAApplication1","2018-06-07T23:16:23Z[Etc/UTC]","2018-06-07T23:16:23Z[Etc/UTC]"

30.13.4. Reset consumer offsets

A POST request will reset offsets of the Application which is NOT a KSML or Kafka Streams. resetOffsetStrategy can be EARLIEST or LATEST.

$ curl 'http://api.example.com/applications/8180e2f2493944948e4df46ba36ba953/environments/1f9d5864fa394d96b20e8460dca4fcbd/reset-offset' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "topicName" : "tenantbyok-topic2",
  "offsetResetStrategy" : "EARLIEST",
  "applicationId" : "nl.tenantbyok.app1"
}'
POST /applications/8180e2f2493944948e4df46ba36ba953/environments/1f9d5864fa394d96b20e8460dca4fcbd/reset-offset HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 119
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "topicName" : "tenantbyok-topic2",
  "offsetResetStrategy" : "EARLIEST",
  "applicationId" : "nl.tenantbyok.app1"
}
HTTP/1.1 200 OK

30.13.5. Reset Kafka Streams based application

A POST request will reset a a KSML or Kafka Streams Application.

$ curl 'http://api.example.com/applications/KafkaStreams-app19-ID-0000000000/environments/ENV-tenanta-public-multi-cluster/reset' -i -X POST \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
POST /applications/KafkaStreams-app19-ID-0000000000/environments/ENV-tenanta-public-multi-cluster/reset HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
Content-Type: application/x-www-form-urlencoded
HTTP/1.1 200 OK

31. ApplicationCredentials

An ApplicationCredential is an additional authentication mechanism to the platform which authenticates an Application on an Environment.

The /application_credentials resource is used to create and list application credentials.

31.1. ApplicationCredentials Schema

The /application_credentials resource uses the following json-schema:

31.1.1. HTTP request

GET /profile/application_credentials HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com

31.1.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 1948

{
  "title" : "Application credential",
  "definitions" : {
    "applicationCredentialTypes" : {
      "type" : "object",
      "properties" : {
        "type" : {
          "title" : "Type",
          "readOnly" : false,
          "type" : "string",
          "enum" : [ "SCRAM_SHA_256", "SCRAM_SHA_512", "PLAIN", "SCHEMA_REGISTRY" ]
        }
      }
    }
  },
  "properties" : {
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "metadata" : {
      "title" : "Metadata",
      "readOnly" : true,
      "type" : "object"
    },
    "environment" : {
      "title" : "Environment",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "types" : {
      "title" : "Types",
      "readOnly" : false,
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "$ref" : "#/definitions/applicationCredentialTypes"
      }
    },
    "application" : {
      "title" : "Application",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "description" : {
      "title" : "Description",
      "readOnly" : false,
      "type" : "string"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "tenant" : {
      "title" : "Tenant",
      "readOnly" : true,
      "type" : "object"
    },
    "username" : {
      "title" : "Username",
      "readOnly" : false,
      "type" : "string"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

31.2. List all application credentials

HTTP method GET is disabled for /application_credentials. Refer to search endpoints to find one or more ApplicationCredential for an Application or an Environment.

31.3. Retrieve application credential endpoints

The application_credentials/{id} resource is used to retrieve a single credential of an application for an environment.

A GET request will retrieve the details of a ApplicationCredential.

31.3.1. Curl request

$ curl 'http://api.example.com/application_credentials/1e9ee6ce053c46b0932358c7403a56fd' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

31.3.2. HTTP request

GET /application_credentials/1e9ee6ce053c46b0932358c7403a56fd HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

31.3.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 15836

{
  "id" : "1e9ee6ce053c46b0932358c7403a56fd",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv1 - 1336640963",
  "types" : [ {
    "type" : "SCRAM_SHA_512"
  }, {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "1e9ee6ce053c46b0932358c7403a56fd",
  "created_at" : "2021-09-05T13:16:00",
  "modified_at" : "2021-09-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
}

The application_credentials/ resource is used to retrieve a all Application credentials for given Application and Environment.

Parameter Description

applicationId

A valid Application Id

environmentId

A valid Environment Id

type

A valid type of application credentials. Possible types are SCRAM_SHA_256, SCRAM_SHA_512, PLAIN. Type is an optional parameter

 
GET /application_credentials/search/findByApplicationIdAndEnvironmentId?applicationId=5ffc4240fcdf4a479a16f2b0b12ab909&environmentId=047ab08009fe4da8be6905b55552ab52&type=SCRAM_SHA_256 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 31642

[ {
  "id" : "1e9ee6ce053c46b0932358c7403a56fd",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv1 - 1336640963",
  "types" : [ {
    "type" : "SCRAM_SHA_512"
  }, {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "1e9ee6ce053c46b0932358c7403a56fd",
  "created_at" : "2021-09-05T13:16:00",
  "modified_at" : "2021-09-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
}, {
  "id" : "2f8ff6de053c46b0932358c7403a57ge",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv2 - 1336640583",
  "types" : [ {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "2f8ff6de053c46b0932358c7403a57ge",
  "created_at" : "2021-08-05T13:16:00",
  "modified_at" : "2021-08-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
} ]

31.4. ApplicationCredentials search endpoints

31.4.1. /application_credentials/search/findByApplicationId

Returns all application credentials for given Application and SASL mechanism/type.

Query parameters
Parameter Description

applicationId

A valid Application Id

type

A valid type of application credentials. Possible types are SCRAM_SHA_256, SCRAM_SHA_512, PLAIN. Type is an optional parameter
Curl request
$ curl 'http://api.example.com/application_credentials/search/findByApplicationId?applicationId=5ffc4240fcdf4a479a16f2b0b12ab909&type=SCRAM_SHA_256' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'
HTTP request
GET /application_credentials/search/findByApplicationId?applicationId=5ffc4240fcdf4a479a16f2b0b12ab909&type=SCRAM_SHA_256 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 31642

[ {
  "id" : "1e9ee6ce053c46b0932358c7403a56fd",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv1 - 1336640963",
  "types" : [ {
    "type" : "SCRAM_SHA_512"
  }, {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "1e9ee6ce053c46b0932358c7403a56fd",
  "created_at" : "2021-09-05T13:16:00",
  "modified_at" : "2021-09-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
}, {
  "id" : "2f8ff6de053c46b0932358c7403a57ge",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv2 - 1336640583",
  "types" : [ {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "2f8ff6de053c46b0932358c7403a57ge",
  "created_at" : "2021-08-05T13:16:00",
  "modified_at" : "2021-08-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
} ]

SASL mechanism/type is an optional field.

Curl request
$ curl 'http://api.example.com/application_credentials/search/findByApplicationId?applicationId=5ffc4240fcdf4a479a16f2b0b12ab909' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 31642

[ {
  "id" : "1e9ee6ce053c46b0932358c7403a56fd",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv1 - 1336640963",
  "types" : [ {
    "type" : "SCRAM_SHA_512"
  }, {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "1e9ee6ce053c46b0932358c7403a56fd",
  "created_at" : "2021-09-05T13:16:00",
  "modified_at" : "2021-09-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
}, {
  "id" : "2f8ff6de053c46b0932358c7403a57ge",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv2 - 1336640583",
  "types" : [ {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "2f8ff6de053c46b0932358c7403a57ge",
  "created_at" : "2021-08-05T13:16:00",
  "modified_at" : "2021-08-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
} ]

31.4.2. /application_credentials/search/findByApplicationIdAndEnvironmentId

Returns all application credentials for given Application, Environment and SASL mechanism/type.

Query parameters
Parameter Description

applicationId

A valid Application Id

environmentId

A valid Environment Id

type

A valid type of application credentials. Possible types are SCRAM_SHA_256, SCRAM_SHA_512, PLAIN. Type is an optional parameter
Curl request
$ curl 'http://api.example.com/application_credentials/search/findByApplicationIdAndEnvironmentId?applicationId=5ffc4240fcdf4a479a16f2b0b12ab909&environmentId=047ab08009fe4da8be6905b55552ab52&type=SCRAM_SHA_256' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'
HTTP request
GET /application_credentials/search/findByApplicationIdAndEnvironmentId?applicationId=5ffc4240fcdf4a479a16f2b0b12ab909&environmentId=047ab08009fe4da8be6905b55552ab52&type=SCRAM_SHA_256 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 31642

[ {
  "id" : "1e9ee6ce053c46b0932358c7403a56fd",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv1 - 1336640963",
  "types" : [ {
    "type" : "SCRAM_SHA_512"
  }, {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "1e9ee6ce053c46b0932358c7403a56fd",
  "created_at" : "2021-09-05T13:16:00",
  "modified_at" : "2021-09-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
}, {
  "id" : "2f8ff6de053c46b0932358c7403a57ge",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv2 - 1336640583",
  "types" : [ {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "2f8ff6de053c46b0932358c7403a57ge",
  "created_at" : "2021-08-05T13:16:00",
  "modified_at" : "2021-08-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
} ]

SASL mechanism/type is an optional field

Curl request
$ curl 'http://api.example.com/application_credentials/search/findByApplicationIdAndEnvironmentId?applicationId=5ffc4240fcdf4a479a16f2b0b12ab909&environmentId=047ab08009fe4da8be6905b55552ab52' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 31642

[ {
  "id" : "1e9ee6ce053c46b0932358c7403a56fd",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv1 - 1336640963",
  "types" : [ {
    "type" : "SCRAM_SHA_512"
  }, {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "1e9ee6ce053c46b0932358c7403a56fd",
  "created_at" : "2021-09-05T13:16:00",
  "modified_at" : "2021-09-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
}, {
  "id" : "2f8ff6de053c46b0932358c7403a57ge",
  "optLock" : 0,
  "metadata" : { },
  "application" : {
    "id" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "optLock" : 0,
    "name" : "tenantaApplication1",
    "shortName" : "tenanta_app1",
    "description" : "tenantaApplication1 description.",
    "applicationType" : "Custom",
    "type" : "Java",
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "optLock" : 0,
      "name" : "Application-tenAApplication1",
      "members" : [ {
        "id" : "51234a7a81994d1ca35ca7894cde08c6",
        "optLock" : 0,
        "firstName" : "appOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "appowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "appOwner TenantA",
        "uid" : "51234a7a81994d1ca35ca7894cde08c6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
  },
  "environment" : {
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "instance" : {
      "id" : "b9301e9144324928911f7d83ec40c478",
      "optLock" : 0,
      "properties" : {
        "min.insync.replicas" : "1",
        "create-stream.disable-time" : "1",
        "retention.ms" : "172800000",
        "num.partitions" : "3",
        "segment.ms" : "172800000",
        "replication.factor" : "2"
      },
      "name" : "TenantA OTA",
      "description" : "TenantA OTA Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000002",
        "optLock" : 0,
        "cluster" : {
          "id" : "66c12e25ab06458eac988f0d700fbe81",
          "optLock" : 0,
          "name" : "Zone1ClusterOTA",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ {
            "bootstrapServer" : "bootstrapserver1:9093"
          } ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : {
            "MUTUAL_TLS" : "broker:9090"
          },
          "kafkaVersion" : "3.5.1",
          "uid" : "66c12e25ab06458eac988f0d700fbe81",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : "bootstrapserver1:9093"
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local1,https://schema.local2",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000002"
      }, {
        "id" : "IC-0000000003",
        "optLock" : 0,
        "cluster" : {
          "id" : "543c3b7d55634eba83b1472775c131c4",
          "optLock" : 0,
          "name" : "Zone2ClusterOTA",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : true,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "apache-kafka",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : "3.4.0",
          "uid" : "543c3b7d55634eba83b1472775c131c4",
          "multiTenant" : true,
          "kafkaCluster" : true,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : "https://schema.local3",
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : {
          "TLS" : "sr-url:24000"
        },
        "srProperties" : { },
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000003"
      } ],
      "caCerts" : [ {
        "pem" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=-----END CERTIFICATE-----\n",
        "expiresOn" : null
      } ],
      "connectCerts" : [ ],
      "shortName" : "ota",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      }, {
        "rank" : 1,
        "protocol" : "SASL",
        "mechanism" : "SCRAM_SHA_256"
      }, {
        "rank" : 2,
        "protocol" : "SASL",
        "mechanism" : "OAUTH_BEARER"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : true,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : "https://connect1.url,https://connect2.url",
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "connectEnabled" : "true",
        "granularBrowsePermission" : "true",
        "environmentMapping" : "true",
        "topicOwnerBrowsePermission" : "true",
        "connectLoggingSupportEnabled" : "false",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "b9301e9144324928911f7d83ec40c478",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "aac290536035440e9a85f193e4affeb3",
      "optLock" : 0,
      "name" : "Environment-tenAenv1",
      "members" : [ {
        "id" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "optLock" : 0,
        "firstName" : "envAuthor",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envauthor@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "envAuthor TenantA",
        "uid" : "9e66c8d7cd5c4e509ec0fe840ef37c62",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ea0e7f147df84179a151bdc21f5bb813",
        "optLock" : 0,
        "firstName" : "tenAdmin",
        "lastName" : "TenantA",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "tenadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "TENANT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "tenAdmin middleName TenantA",
        "uid" : "ea0e7f147df84179a151bdc21f5bb813",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "optLock" : 0,
        "firstName" : "envOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "envOwner TenantA",
        "uid" : "1759cc36cacd4dc28ed1b0336e22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "optLock" : 0,
        "firstName" : "powerUser",
        "lastName" : "powerUser",
        "middleName" : null,
        "emailAddress" : {
          "email" : "poweruser@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "SCHEMA_ADMIN"
        }, {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "APPLICATION_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        }, {
          "name" : "SUPER_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "powerUser powerUser",
        "uid" : "cedccd5c6d9e424ab1a9d9f767fc7cfd",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "optLock" : 0,
        "firstName" : "schemaOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "schemaowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "schemaOwner TenantA",
        "uid" : "28ed1b01759cd4dc336ecc36ca22e06d",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "7cb463240b8049578b298c214c28512a",
        "optLock" : 0,
        "firstName" : "envAdmin",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "envadmin@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "envAdmin TenantA",
        "uid" : "7cb463240b8049578b298c214c28512a",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "aac290536035440e9a85f193e4affeb3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : false,
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : true,
    "ksmlEnabled" : false,
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenanta_app1tenantaenv2 - 1336640583",
  "types" : [ {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "test_application_credential",
  "tenant" : {
    "id" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "optLock" : 0,
    "properties" : {
      "replication.factor" : "1",
      "min.insync.replicas" : "1",
      "cleanup.policy" : "delete"
    },
    "name" : "TenantA",
    "shortName" : "tenanta",
    "uniqueConsumerGroup" : true,
    "logo" : "tenanta.png",
    "issuerUrl" : "http://api.example.com/auth/realms/tenanta",
    "dataClassificationEnabled" : false,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : true,
    "customerId" : null,
    "settings" : {
      "notificationsEnabled" : "true",
      "schemaRolesEnforced" : "true",
      "onlyResourceManagerCanUpdateAndDeploy" : "false"
    },
    "uid" : "55ef719629a94a07b9bf8ac0f3c495e5",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "2f8ff6de053c46b0932358c7403a57ge",
  "created_at" : "2021-08-05T13:16:00",
  "modified_at" : "2021-08-06T13:16:00",
  "created_by" : null,
  "modified_by" : null
} ]

Returns application credentials available for multiple Apache-Kafka clusters.

Note the comma-separated list of clusters' names present in the metadata field to identify on which cluster the application credentials is available.

Curl request
$ curl 'http://api.example.com/application_credentials/search/findByApplicationIdAndEnvironmentId?applicationId=8180e2f2493944948e4df46ba36ba953&environmentId=65f24r918d49430fbf1d8cc7494d22e3' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 14241

[ {
  "id" : "22c4439c661740e884fb74990514495d",
  "optLock" : 0,
  "metadata" : {
    "clusters" : "BYOKReplica1ForApacheKafka,BYOKReplica2ForApacheKafka"
  },
  "application" : {
    "id" : "8180e2f2493944948e4df46ba36ba953",
    "optLock" : 0,
    "name" : "tenantBYOKApplication1",
    "shortName" : "tenant_byok_app1",
    "description" : "tenantBYOKApplication1 description.",
    "applicationType" : "Custom",
    "type" : null,
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "optLock" : 0,
      "name" : "Admins",
      "members" : [ {
        "id" : "tenantbyok-appauthor",
        "optLock" : 0,
        "firstName" : "byok",
        "lastName" : "appauthor",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "appauthor@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "APPLICATION_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "byok middleName appauthor",
        "uid" : "tenantbyok-appauthor",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ses78f8a9916441d89f19aad7c4541af",
        "optLock" : 0,
        "firstName" : "BYOKtenantAdmin",
        "lastName" : "BYOKlastname",
        "middleName" : null,
        "emailAddress" : {
          "email" : "BYOKtenantadmin@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "BYOKtenantAdmin BYOKlastname",
        "uid" : "ses78f8a9916441d89f19aad7c4541af",
        "created_at" : "2022-06-07T23:16:23",
        "modified_at" : "2022-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "created_at" : "2023-02-16T12:00:00",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenantbyok.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "uid" : "8180e2f2493944948e4df46ba36ba953",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenantbyok.app1"
  },
  "environment" : {
    "id" : "65f24r918d49430fbf1d8cc7494d22e3",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantbyok - homogeneous clusters",
    "shortName" : "homogeneous",
    "description" : "environment configured on multi-cluster instance",
    "color" : "#80affe",
    "instance" : {
      "id" : "sh708e9144324928911f7d83ec40f345",
      "optLock" : 0,
      "properties" : { },
      "name" : "BYOKTenant replica APACHE-KAFKA",
      "description" : "BYOKTenant Apache-Kafka replica Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000015",
        "optLock" : 0,
        "cluster" : {
          "id" : "8br817181cd44798ab70322830800dbc",
          "optLock" : 0,
          "name" : "BYOKReplica1ForApacheKafka",
          "description" : "",
          "location" : "Zone1",
          "billingCloudEnabled" : false,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : {
            "id" : "1149c97f04c42had8d9c97faa5a375ac",
            "optLock" : 0,
            "properties" : null,
            "name" : "BYOK Tenant",
            "shortName" : "BYOKtenant",
            "uniqueConsumerGroup" : true,
            "logo" : "BYOKtenant.png",
            "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
            "dataClassificationEnabled" : true,
            "contact" : null,
            "supportedAuthenticationMethods" : [ {
              "rank" : 0,
              "protocol" : "SSL",
              "mechanism" : "MUTUAL_TLS"
            }, {
              "rank" : 1,
              "protocol" : "SASL",
              "mechanism" : "SCRAM_SHA_256"
            }, {
              "rank" : 2,
              "protocol" : "SASL",
              "mechanism" : "OAUTH_BEARER"
            } ],
            "wizardCompleted" : false,
            "customerId" : null,
            "settings" : { },
            "uid" : "1149c97f04c42had8d9c97faa5a375ac",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "providerType" : "apache-kafka",
          "topicPattern" : "{topic}",
          "groupPattern" : "{group}",
          "transactionalPattern" : "{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : null,
          "uid" : "8br817181cd44798ab70322830800dbc",
          "multiTenant" : false,
          "kafkaCluster" : true,
          "multiEnvironment" : false,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : null,
        "schemaRegistryType" : "Confluent",
        "distributionConfig" : {
          "distributionUrl" : "http://localhost:62226",
          "kafkaCredentials" : {
            "authenticationType" : "MTLS",
            "certificate" : "certificate"
          },
          "connectCredentials" : {
            "authenticationType" : "basic_auth",
            "username" : "test"
          },
          "properties" : {
            "description" : "Nice"
          }
        },
        "schemaRegistryVersion" : null,
        "instanceClusterSrListener" : {
          "NO_AUTH" : "sr-url:25000",
          "TLS" : "sr-url:24000"
        },
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000015"
      }, {
        "id" : "IC-0000000016",
        "optLock" : 0,
        "cluster" : {
          "id" : "9ab917181cd44798ab70322830800dbc",
          "optLock" : 0,
          "name" : "BYOKReplica2ForApacheKafka",
          "description" : "",
          "location" : "Zone2",
          "billingCloudEnabled" : false,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : {
            "id" : "1149c97f04c42had8d9c97faa5a375ac",
            "optLock" : 0,
            "properties" : null,
            "name" : "BYOK Tenant",
            "shortName" : "BYOKtenant",
            "uniqueConsumerGroup" : true,
            "logo" : "BYOKtenant.png",
            "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
            "dataClassificationEnabled" : true,
            "contact" : null,
            "supportedAuthenticationMethods" : [ {
              "rank" : 0,
              "protocol" : "SSL",
              "mechanism" : "MUTUAL_TLS"
            }, {
              "rank" : 1,
              "protocol" : "SASL",
              "mechanism" : "SCRAM_SHA_256"
            }, {
              "rank" : 2,
              "protocol" : "SASL",
              "mechanism" : "OAUTH_BEARER"
            } ],
            "wizardCompleted" : false,
            "customerId" : null,
            "settings" : { },
            "uid" : "1149c97f04c42had8d9c97faa5a375ac",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "providerType" : "apache-kafka",
          "topicPattern" : "{topic}",
          "groupPattern" : "{group}",
          "transactionalPattern" : "{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : null,
          "uid" : "9ab917181cd44798ab70322830800dbc",
          "multiTenant" : false,
          "kafkaCluster" : true,
          "multiEnvironment" : false,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : null,
        "schemaRegistryType" : "Apicurio",
        "distributionConfig" : {
          "distributionUrl" : "http://localhost:62226",
          "kafkaCredentials" : {
            "authenticationType" : "MTLS",
            "certificate" : "certificate"
          },
          "connectCredentials" : {
            "authenticationType" : "basic_auth",
            "username" : "test"
          },
          "properties" : {
            "description" : "Nice"
          }
        },
        "schemaRegistryVersion" : null,
        "instanceClusterSrListener" : null,
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000016"
      } ],
      "caCerts" : [ ],
      "connectCerts" : [ ],
      "shortName" : "BYOKReplica",
      "enabledAuthenticationMethods" : [ {
        "rank" : 0,
        "protocol" : "SSL",
        "mechanism" : "MUTUAL_TLS"
      } ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : false,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : null,
      "granularBrowsePermission" : true,
      "environmentMapping" : true,
      "settings" : {
        "environmentMapping" : "true",
        "connectLoggingSupportEnabled" : "false",
        "connectEnabled" : "false",
        "granularBrowsePermission" : "true",
        "certificateReusePrevention" : "NONE"
      },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "sh708e9144324928911f7d83ec40f345",
      "created_at" : "2022-06-07T23:16:23",
      "modified_at" : "2022-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Auto",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "optLock" : 0,
      "name" : "Admins",
      "members" : [ {
        "id" : "tenantbyok-appauthor",
        "optLock" : 0,
        "firstName" : "byok",
        "lastName" : "appauthor",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "appauthor@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "APPLICATION_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "byok middleName appauthor",
        "uid" : "tenantbyok-appauthor",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ses78f8a9916441d89f19aad7c4541af",
        "optLock" : 0,
        "firstName" : "BYOKtenantAdmin",
        "lastName" : "BYOKlastname",
        "middleName" : null,
        "emailAddress" : {
          "email" : "BYOKtenantadmin@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "BYOKtenantAdmin BYOKlastname",
        "uid" : "ses78f8a9916441d89f19aad7c4541af",
        "created_at" : "2022-06-07T23:16:23",
        "modified_at" : "2022-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "created_at" : "2023-02-16T12:00:00",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : true,
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : false,
    "ksmlEnabled" : false,
    "uid" : "65f24r918d49430fbf1d8cc7494d22e3",
    "created_at" : "2021-06-07T23:16:23",
    "modified_at" : "2021-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenant_byok_app1homogeneous390298580",
  "types" : [ {
    "type" : "SCRAM_SHA_512"
  } ],
  "description" : "Created via Self Service UI on:2025-06-25",
  "tenant" : {
    "id" : "1149c97f04c42had8d9c97faa5a375ac",
    "optLock" : 0,
    "properties" : null,
    "name" : "BYOK Tenant",
    "shortName" : "BYOKtenant",
    "uniqueConsumerGroup" : true,
    "logo" : "BYOKtenant.png",
    "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
    "dataClassificationEnabled" : true,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : false,
    "customerId" : null,
    "settings" : { },
    "uid" : "1149c97f04c42had8d9c97faa5a375ac",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "22c4439c661740e884fb74990514495d",
  "created_at" : "2025-06-25T08:08:53.878821457",
  "modified_at" : "2025-06-25T08:08:53.878821457",
  "created_by" : "BYOKtenantadmin@tenant.nl",
  "modified_by" : "BYOKtenantadmin@tenant.nl"
} ]

Returns application credentials available for multiple heterogeneous clusters.

Note the comma-separated list of clusters' names present in the metadata field to identify on which cluster the application credentials is available.

Curl request
$ curl 'http://api.example.com/application_credentials/search/findByApplicationIdAndEnvironmentId?applicationId=8180e2f2493944948e4df46ba36ba953&environmentId=87c48c0938d941548a5282f106d27ff1' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 24015

[ {
  "id" : "12740d0de976459e86660f57ced2e1a5",
  "optLock" : 0,
  "metadata" : {
    "resourceId" : "resourceId",
    "SCHEMA_REGISTRY_API_KEY" : "schema-registry-api-key",
    "CLUSTER_API_KEY" : "cluster-api-key",
    "clusters" : "BYOKClusterForCC"
  },
  "application" : {
    "id" : "8180e2f2493944948e4df46ba36ba953",
    "optLock" : 0,
    "name" : "tenantBYOKApplication1",
    "shortName" : "tenant_byok_app1",
    "description" : "tenantBYOKApplication1 description.",
    "applicationType" : "Custom",
    "type" : null,
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "optLock" : 0,
      "name" : "Admins",
      "members" : [ {
        "id" : "tenantbyok-appauthor",
        "optLock" : 0,
        "firstName" : "byok",
        "lastName" : "appauthor",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "appauthor@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "APPLICATION_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "byok middleName appauthor",
        "uid" : "tenantbyok-appauthor",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ses78f8a9916441d89f19aad7c4541af",
        "optLock" : 0,
        "firstName" : "BYOKtenantAdmin",
        "lastName" : "BYOKlastname",
        "middleName" : null,
        "emailAddress" : {
          "email" : "BYOKtenantadmin@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "BYOKtenantAdmin BYOKlastname",
        "uid" : "ses78f8a9916441d89f19aad7c4541af",
        "created_at" : "2022-06-07T23:16:23",
        "modified_at" : "2022-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "created_at" : "2023-02-16T12:00:00",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenantbyok.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "uid" : "8180e2f2493944948e4df46ba36ba953",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenantbyok.app1"
  },
  "environment" : {
    "id" : "87c48c0938d941548a5282f106d27ff1",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantbyok - heterogeneous clusters",
    "shortName" : "heterogeneous",
    "description" : "environment configured on multi-cluster instance",
    "color" : "#80affe",
    "instance" : {
      "id" : "96g4770e77b142a48f55f04ca5554807",
      "optLock" : 0,
      "properties" : { },
      "name" : "BYOKTenant  multi-cluster",
      "description" : "BYOKTenant multi-cluster Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000021",
        "optLock" : 0,
        "cluster" : {
          "id" : "8ddf2473543443cebe67d704470197f1",
          "optLock" : 0,
          "name" : "BYOKClusterForAiven",
          "description" : "",
          "location" : "BYOK",
          "billingCloudEnabled" : false,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "aiven",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : null,
          "uid" : "8ddf2473543443cebe67d704470197f1",
          "multiTenant" : true,
          "kafkaCluster" : false,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : null,
        "schemaRegistryType" : null,
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : null,
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000021"
      }, {
        "id" : "IC-0000000022",
        "optLock" : 0,
        "cluster" : {
          "id" : "9gr818181cd44798ab70322830800dbc",
          "optLock" : 0,
          "name" : "BYOKClusterForCC",
          "description" : "",
          "location" : "BYOK",
          "billingCloudEnabled" : false,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : {
            "id" : "1149c97f04c42had8d9c97faa5a375ac",
            "optLock" : 0,
            "properties" : null,
            "name" : "BYOK Tenant",
            "shortName" : "BYOKtenant",
            "uniqueConsumerGroup" : true,
            "logo" : "BYOKtenant.png",
            "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
            "dataClassificationEnabled" : true,
            "contact" : null,
            "supportedAuthenticationMethods" : [ {
              "rank" : 0,
              "protocol" : "SSL",
              "mechanism" : "MUTUAL_TLS"
            }, {
              "rank" : 1,
              "protocol" : "SASL",
              "mechanism" : "SCRAM_SHA_256"
            }, {
              "rank" : 2,
              "protocol" : "SASL",
              "mechanism" : "OAUTH_BEARER"
            } ],
            "wizardCompleted" : false,
            "customerId" : null,
            "settings" : { },
            "uid" : "1149c97f04c42had8d9c97faa5a375ac",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "providerType" : "confluent-cloud",
          "topicPattern" : null,
          "groupPattern" : null,
          "transactionalPattern" : null,
          "kafkaListeners" : { },
          "kafkaVersion" : null,
          "uid" : "9gr818181cd44798ab70322830800dbc",
          "multiTenant" : false,
          "kafkaCluster" : false,
          "multiEnvironment" : false,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : null,
        "schemaRegistryType" : "Apicurio",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : null,
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000022"
      } ],
      "caCerts" : [ ],
      "connectCerts" : [ ],
      "shortName" : "BYOKMULTI",
      "enabledAuthenticationMethods" : [ ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : false,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : null,
      "granularBrowsePermission" : false,
      "environmentMapping" : true,
      "settings" : { },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "96g4770e77b142a48f55f04ca5554807",
      "created_at" : "2022-06-07T23:16:23",
      "modified_at" : "2022-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Auto",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "optLock" : 0,
      "name" : "Admins",
      "members" : [ {
        "id" : "tenantbyok-appauthor",
        "optLock" : 0,
        "firstName" : "byok",
        "lastName" : "appauthor",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "appauthor@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "APPLICATION_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "byok middleName appauthor",
        "uid" : "tenantbyok-appauthor",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ses78f8a9916441d89f19aad7c4541af",
        "optLock" : 0,
        "firstName" : "BYOKtenantAdmin",
        "lastName" : "BYOKlastname",
        "middleName" : null,
        "emailAddress" : {
          "email" : "BYOKtenantadmin@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "BYOKtenantAdmin BYOKlastname",
        "uid" : "ses78f8a9916441d89f19aad7c4541af",
        "created_at" : "2022-06-07T23:16:23",
        "modified_at" : "2022-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "created_at" : "2023-02-16T12:00:00",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : true,
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : false,
    "ksmlEnabled" : false,
    "uid" : "87c48c0938d941548a5282f106d27ff1",
    "created_at" : "2021-06-07T23:16:23",
    "modified_at" : "2021-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "resourceId",
  "types" : [ {
    "type" : "SCRAM_SHA_512"
  }, {
    "type" : "PLAIN"
  }, {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "Created via Self Service UI on:2025-06-25",
  "tenant" : {
    "id" : "1149c97f04c42had8d9c97faa5a375ac",
    "optLock" : 0,
    "properties" : null,
    "name" : "BYOK Tenant",
    "shortName" : "BYOKtenant",
    "uniqueConsumerGroup" : true,
    "logo" : "BYOKtenant.png",
    "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
    "dataClassificationEnabled" : true,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : false,
    "customerId" : null,
    "settings" : { },
    "uid" : "1149c97f04c42had8d9c97faa5a375ac",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "12740d0de976459e86660f57ced2e1a5",
  "created_at" : "2025-06-25T08:08:54.03864096",
  "modified_at" : "2025-06-25T08:08:54.03864096",
  "created_by" : "BYOKtenantadmin@tenant.nl",
  "modified_by" : "BYOKtenantadmin@tenant.nl"
}, {
  "id" : "720ec17d716e4ce996657acfb829167d",
  "optLock" : 0,
  "metadata" : {
    "clusters" : "BYOKClusterForAiven"
  },
  "application" : {
    "id" : "8180e2f2493944948e4df46ba36ba953",
    "optLock" : 0,
    "name" : "tenantBYOKApplication1",
    "shortName" : "tenant_byok_app1",
    "description" : "tenantBYOKApplication1 description.",
    "applicationType" : "Custom",
    "type" : null,
    "applicationClass" : null,
    "visibility" : "public",
    "owners" : {
      "id" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "optLock" : 0,
      "name" : "Admins",
      "members" : [ {
        "id" : "tenantbyok-appauthor",
        "optLock" : 0,
        "firstName" : "byok",
        "lastName" : "appauthor",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "appauthor@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "APPLICATION_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "byok middleName appauthor",
        "uid" : "tenantbyok-appauthor",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ses78f8a9916441d89f19aad7c4541af",
        "optLock" : 0,
        "firstName" : "BYOKtenantAdmin",
        "lastName" : "BYOKlastname",
        "middleName" : null,
        "emailAddress" : {
          "email" : "BYOKtenantadmin@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "BYOKtenantAdmin BYOKlastname",
        "uid" : "ses78f8a9916441d89f19aad7c4541af",
        "created_at" : "2022-06-07T23:16:23",
        "modified_at" : "2022-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "created_at" : "2023-02-16T12:00:00",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "properties" : { },
    "viewers" : [ ],
    "kafkaStreamsBased" : false,
    "connector" : false,
    "axualManagedKsml" : false,
    "kafkaStreams" : false,
    "customKsml" : false,
    "allApplicationIds" : [ "nl.tenantbyok.app1" ],
    "ableToGenerateSchemaRegistryPassword" : false,
    "ableToResetOffsets" : true,
    "uid" : "8180e2f2493944948e4df46ba36ba953",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null,
    "applicationId" : "nl.tenantbyok.app1"
  },
  "environment" : {
    "id" : "87c48c0938d941548a5282f106d27ff1",
    "optLock" : 0,
    "properties" : { },
    "name" : "tenantbyok - heterogeneous clusters",
    "shortName" : "heterogeneous",
    "description" : "environment configured on multi-cluster instance",
    "color" : "#80affe",
    "instance" : {
      "id" : "96g4770e77b142a48f55f04ca5554807",
      "optLock" : 0,
      "properties" : { },
      "name" : "BYOKTenant  multi-cluster",
      "description" : "BYOKTenant multi-cluster Instance",
      "instanceClusters" : [ {
        "id" : "IC-0000000021",
        "optLock" : 0,
        "cluster" : {
          "id" : "8ddf2473543443cebe67d704470197f1",
          "optLock" : 0,
          "name" : "BYOKClusterForAiven",
          "description" : "",
          "location" : "BYOK",
          "billingCloudEnabled" : false,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : null,
          "providerType" : "aiven",
          "topicPattern" : "{tenant}-{instance}-{environment}-{topic}",
          "groupPattern" : "{tenant}-{instance}-{environment}-{group}",
          "transactionalPattern" : "{tenant}-{instance}-{environment}-{transactional.id}",
          "kafkaListeners" : { },
          "kafkaVersion" : null,
          "uid" : "8ddf2473543443cebe67d704470197f1",
          "multiTenant" : true,
          "kafkaCluster" : false,
          "multiEnvironment" : true,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : null,
        "schemaRegistryType" : null,
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : null,
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000021"
      }, {
        "id" : "IC-0000000022",
        "optLock" : 0,
        "cluster" : {
          "id" : "9gr818181cd44798ab70322830800dbc",
          "optLock" : 0,
          "name" : "BYOKClusterForCC",
          "description" : "",
          "location" : "BYOK",
          "billingCloudEnabled" : false,
          "bootstrapServers" : [ ],
          "settings" : { },
          "tenant" : {
            "id" : "1149c97f04c42had8d9c97faa5a375ac",
            "optLock" : 0,
            "properties" : null,
            "name" : "BYOK Tenant",
            "shortName" : "BYOKtenant",
            "uniqueConsumerGroup" : true,
            "logo" : "BYOKtenant.png",
            "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
            "dataClassificationEnabled" : true,
            "contact" : null,
            "supportedAuthenticationMethods" : [ {
              "rank" : 0,
              "protocol" : "SSL",
              "mechanism" : "MUTUAL_TLS"
            }, {
              "rank" : 1,
              "protocol" : "SASL",
              "mechanism" : "SCRAM_SHA_256"
            }, {
              "rank" : 2,
              "protocol" : "SASL",
              "mechanism" : "OAUTH_BEARER"
            } ],
            "wizardCompleted" : false,
            "customerId" : null,
            "settings" : { },
            "uid" : "1149c97f04c42had8d9c97faa5a375ac",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "providerType" : "confluent-cloud",
          "topicPattern" : null,
          "groupPattern" : null,
          "transactionalPattern" : null,
          "kafkaListeners" : { },
          "kafkaVersion" : null,
          "uid" : "9gr818181cd44798ab70322830800dbc",
          "multiTenant" : false,
          "kafkaCluster" : false,
          "multiEnvironment" : false,
          "bootstrapUrls" : ""
        },
        "ksmlProvisioners" : [ ],
        "schemaRegistryUrls" : null,
        "schemaRegistryType" : "Apicurio",
        "distributionConfig" : null,
        "schemaRegistryVersion" : "2.8.0",
        "instanceClusterSrListener" : null,
        "srProperties" : null,
        "srKeycloakDetails" : null,
        "ksmlUrl" : null,
        "singleKsmlProvisioner" : null,
        "uid" : "IC-0000000022"
      } ],
      "caCerts" : [ ],
      "connectCerts" : [ ],
      "shortName" : "BYOKMULTI",
      "enabledAuthenticationMethods" : [ ],
      "supportTier" : {
        "id" : "14cadc6238fc4695916a8053302743f5",
        "optLock" : 0,
        "name" : "GOLD",
        "description" : "This is gold",
        "uid" : "14cadc6238fc4695916a8053302743f5",
        "created_at" : "2018-09-20T00:00:00",
        "modified_at" : null,
        "created_by" : null,
        "modified_by" : null
      },
      "connectEnabled" : false,
      "connectLoggingSupportEnabled" : false,
      "connectUrls" : null,
      "granularBrowsePermission" : false,
      "environmentMapping" : true,
      "settings" : { },
      "ksmlEnabled" : false,
      "selfApprovalEnabled" : true,
      "ksmlProvisioner" : null,
      "ksmlUrl" : null,
      "uid" : "96g4770e77b142a48f55f04ca5554807",
      "created_at" : "2022-06-07T23:16:23",
      "modified_at" : "2022-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "authorizationIssuer" : "Auto",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "owners" : {
      "id" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "optLock" : 0,
      "name" : "Admins",
      "members" : [ {
        "id" : "tenantbyok-appauthor",
        "optLock" : 0,
        "firstName" : "byok",
        "lastName" : "appauthor",
        "middleName" : "middleName",
        "emailAddress" : {
          "email" : "appauthor@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "APPLICATION_AUTHOR"
        } ],
        "settings" : { },
        "fullName" : "byok middleName appauthor",
        "uid" : "tenantbyok-appauthor",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      }, {
        "id" : "ses78f8a9916441d89f19aad7c4541af",
        "optLock" : 0,
        "firstName" : "BYOKtenantAdmin",
        "lastName" : "BYOKlastname",
        "middleName" : null,
        "emailAddress" : {
          "email" : "BYOKtenantadmin@tenant.nl"
        },
        "phoneNumber" : null,
        "roles" : [ {
          "name" : "STREAM_ADMIN"
        }, {
          "name" : "TENANT_ADMIN"
        }, {
          "name" : "ENVIRONMENT_ADMIN"
        } ],
        "settings" : { },
        "fullName" : "BYOKtenantAdmin BYOKlastname",
        "uid" : "ses78f8a9916441d89f19aad7c4541af",
        "created_at" : "2022-06-07T23:16:23",
        "modified_at" : "2022-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      } ],
      "managers" : [ ],
      "resourceManagers" : [ ],
      "emailAddress" : null,
      "phoneNumber" : null,
      "properties" : { },
      "uid" : "g6wc3907c5b414c9ea97e60258e4cfbf",
      "created_at" : "2023-02-16T12:00:00",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ ],
    "settings" : { },
    "private" : false,
    "autoApproved" : true,
    "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
    "streamOwnerAuthorizer" : false,
    "ksmlEnabled" : false,
    "uid" : "87c48c0938d941548a5282f106d27ff1",
    "created_at" : "2021-06-07T23:16:23",
    "modified_at" : "2021-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "username" : "tenant_byok_app1heterogeneous-972425539",
  "types" : [ {
    "type" : "SCRAM_SHA_512"
  }, {
    "type" : "PLAIN"
  }, {
    "type" : "SCRAM_SHA_256"
  } ],
  "description" : "Created via Self Service UI on:2025-06-25",
  "tenant" : {
    "id" : "1149c97f04c42had8d9c97faa5a375ac",
    "optLock" : 0,
    "properties" : null,
    "name" : "BYOK Tenant",
    "shortName" : "BYOKtenant",
    "uniqueConsumerGroup" : true,
    "logo" : "BYOKtenant.png",
    "issuerUrl" : "http://api.example.com/auth/realms/BYOKtenant",
    "dataClassificationEnabled" : true,
    "contact" : null,
    "supportedAuthenticationMethods" : [ {
      "rank" : 0,
      "protocol" : "SSL",
      "mechanism" : "MUTUAL_TLS"
    }, {
      "rank" : 1,
      "protocol" : "SASL",
      "mechanism" : "SCRAM_SHA_256"
    }, {
      "rank" : 2,
      "protocol" : "SASL",
      "mechanism" : "OAUTH_BEARER"
    } ],
    "wizardCompleted" : false,
    "customerId" : null,
    "settings" : { },
    "uid" : "1149c97f04c42had8d9c97faa5a375ac",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "uid" : "720ec17d716e4ce996657acfb829167d",
  "created_at" : "2025-06-25T08:08:54.055489464",
  "modified_at" : "2025-06-25T08:08:54.055489464",
  "created_by" : "BYOKtenantadmin@tenant.nl",
  "modified_by" : "BYOKtenantadmin@tenant.nl"
} ]

32. ApplicationPrincipals

An ApplicationPrincipal is a security principal (certificate or comparable) that uniquely authenticates an Application on an Environment.

The /application_principals resource is used to create and list application principals.

32.1. ApplicationPrincipals Schema

The /application_principals resource uses the following json-schema:

GET /profile/application_principals HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 1736

{
  "title" : "Application principal",
  "definitions" : { },
  "properties" : {
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "privateKeyUploaded" : {
      "title" : "Private key uploaded",
      "readOnly" : true,
      "type" : "boolean"
    },
    "applicationPem" : {
      "title" : "Application pem",
      "readOnly" : false,
      "type" : "string"
    },
    "principal" : {
      "title" : "Principal",
      "readOnly" : false,
      "type" : "string"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "environment" : {
      "title" : "Environment",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "principalChain" : {
      "title" : "Principal chain",
      "readOnly" : false,
      "type" : "string"
    },
    "application" : {
      "title" : "Application",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "privateKeyPem" : {
      "title" : "Private key pem",
      "readOnly" : true,
      "type" : "string"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "expiresOn" : {
      "title" : "Expires on",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

32.2. List all application principals

HTTP method GET is disabled for /application_principals. Refer to search endpoints to find one or more ApplicationPrincipal for an Application or an Environment.

32.3. Create Application Principal

A POST request is used to create a new ApplicationPrincipal. The request should include reference to a valid existing application and environment.

32.3.1. Request fields

Path Type Description Constraints

[].principal

String

The principal of an Application for an Environment

[].application

String

A valid URI of an existing application

[].environment

String

A valid URI of an existing environment

32.3.2. Curl request

$ curl 'http://api.example.com/application_principals' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '[ {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924512",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
} ]'

32.3.3. HTTP request

POST /application_principals HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 5544
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

[ {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924512",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
} ]

32.3.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 80

"http://api.example.com/application_principals/8c2e52a59caf4a4594a7793f1be4763d"

32.4. Create Application Principal with Private key

A POST request is used to create a new ApplicationPrincipal with a private key. This is used for connector and KSML type of applications. The request should include reference to a valid existing application and environment.

32.4.1. Request fields

Path Type Description Constraints

[].principal

String

The principal of an Application for an Environment

[].privateKey

String

The private key of an Application for an Environment

[].application

String

A valid URI of an existing application

[].environment

String

A valid URI of an existing environment

32.4.2. Curl request

$ curl 'http://api.example.com/application_principals' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '[ {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/dbc9e4670h1c4866deg78722e2930d2g",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52",
  "privateKey" : "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDBXcezkUjIzQrI\nZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9KhpJdWXUFhijSFzLDHHl3\nGwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk5OGIRyvNOj8EXazh+z6Y\n2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvTWDl3H2NpfZUcHhZ6+6U0\nX1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG6gJcw9Ns8z8GoDdQ+NYN\nP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQar8kSu5PpHFMXLYH8U/Ty\nYs9UjLXTAgMBAAECggEBAJMfj3qI6CAgIjwngrff+N5+E8EbfD9CMkDkNoKipVWB\njFJfE4uO2+i9AjZp/aMZFXiGgziWfgEGAUUmPho1HsmLDFOAanF86FIKzrPY0DPh\nUOqfj1scg0q1eexqWU8fF6ymzJu9ynSGfTJAANLHh7UbgzYsT61U5IiT7136uJOa\nUGK6bK79ZYZaDamNr/+QqtpgEsCxI8db6rfvvyXWXuSdMW090NMhduZc0WDgxxnS\nz3N3ywkSeGZpkzn1wVjkFRK70a9z9eGZN9s50B1pt6geNS8yaY3ieJ5nbCQGHy9t\nYgTDLgvTxdzzYsH7HDxiS2Regd6/frjfXKe3P8D2HwECgYEA3eEPniANpRES+32v\nX3mwGsolkaRwRmLvTEcfDmKeMZEAGsq0fp1ZYvcJxyJ/yD/6GE6HnvD/owpMM04k\nBW8o/F9juiSFK6QOiPKcphrhafbwdCAU7o+u+IuSivMQmtYJrYsN21TtkuhRrUgF\nEBoHRg6m9qfEY9Et0Yj8mRp2H3ECgYEA3xo59w6gcYoX/x6wPIj+M2nvgDLIHewa\nYhtnL9LFHDerTdf2cS6sfPB0zxv/SXR5V9pdRL4nr2nQzI/xbMX73KUR0SL4UAgE\nVUurLsttYZA/KhBS1sH814hQHNHCoPgNOAntdplkhS2Lydw/XsfWJfrFqlI+IPWk\nclCx82bzD4MCgYEAmTMj+HeDVF0ksTdIFvFL0kOPiy9yQndfaViWLfWT6v+Ghfk+\nhUoaBQYz3yaH+nmKMqxOYkVfDXE3yhkDMClfsFog3s8GkGp3isGRvfNDf0n9HwFj\n0pCtLHoalgxcg7yT9BrWV4Idg9kbRD09GbAPI6VMTXTrWkx9iXc/imtF8lECgYEA\ns5pyZZCR2zV3gfsbl3AVbCBxHTxEW8pRpv82f4pnAgNS1bTxAUa4t1AASSbZyjGI\n6g+xnACVBCLkY3nRumZcDtGYWUuUqSD7FAt5gI9lu/Aa2WsQtTCvsndbPwgibeGj\nCqT7VMnB4XC8I0I6hbvMiwCpliblOzVlMF4EE9WiAK8CgYAfbdwcDUA0bC5NbwD1\n9+6KF01Ib7M9DL+Hrfe+ZUGd0V4FRckHCGnnDFU4vMR+LqBWjIuVSUQhmayH5KGT\nqHXkVQ61+HLTV3mEdSwRd66VzVhaEAj2TZjgGohvL9J8ubjV31WDlZUAs1SktwMp\nLe5QuxBs1CmFW6mlX6AvOfypJQ==\n-----END PRIVATE KEY-----\n"
} ]'

32.4.3. HTTP request

POST /application_principals HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 7301
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

[ {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/dbc9e4670h1c4866deg78722e2930d2g",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52",
  "privateKey" : "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDBXcezkUjIzQrI\nZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9KhpJdWXUFhijSFzLDHHl3\nGwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk5OGIRyvNOj8EXazh+z6Y\n2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvTWDl3H2NpfZUcHhZ6+6U0\nX1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG6gJcw9Ns8z8GoDdQ+NYN\nP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQar8kSu5PpHFMXLYH8U/Ty\nYs9UjLXTAgMBAAECggEBAJMfj3qI6CAgIjwngrff+N5+E8EbfD9CMkDkNoKipVWB\njFJfE4uO2+i9AjZp/aMZFXiGgziWfgEGAUUmPho1HsmLDFOAanF86FIKzrPY0DPh\nUOqfj1scg0q1eexqWU8fF6ymzJu9ynSGfTJAANLHh7UbgzYsT61U5IiT7136uJOa\nUGK6bK79ZYZaDamNr/+QqtpgEsCxI8db6rfvvyXWXuSdMW090NMhduZc0WDgxxnS\nz3N3ywkSeGZpkzn1wVjkFRK70a9z9eGZN9s50B1pt6geNS8yaY3ieJ5nbCQGHy9t\nYgTDLgvTxdzzYsH7HDxiS2Regd6/frjfXKe3P8D2HwECgYEA3eEPniANpRES+32v\nX3mwGsolkaRwRmLvTEcfDmKeMZEAGsq0fp1ZYvcJxyJ/yD/6GE6HnvD/owpMM04k\nBW8o/F9juiSFK6QOiPKcphrhafbwdCAU7o+u+IuSivMQmtYJrYsN21TtkuhRrUgF\nEBoHRg6m9qfEY9Et0Yj8mRp2H3ECgYEA3xo59w6gcYoX/x6wPIj+M2nvgDLIHewa\nYhtnL9LFHDerTdf2cS6sfPB0zxv/SXR5V9pdRL4nr2nQzI/xbMX73KUR0SL4UAgE\nVUurLsttYZA/KhBS1sH814hQHNHCoPgNOAntdplkhS2Lydw/XsfWJfrFqlI+IPWk\nclCx82bzD4MCgYEAmTMj+HeDVF0ksTdIFvFL0kOPiy9yQndfaViWLfWT6v+Ghfk+\nhUoaBQYz3yaH+nmKMqxOYkVfDXE3yhkDMClfsFog3s8GkGp3isGRvfNDf0n9HwFj\n0pCtLHoalgxcg7yT9BrWV4Idg9kbRD09GbAPI6VMTXTrWkx9iXc/imtF8lECgYEA\ns5pyZZCR2zV3gfsbl3AVbCBxHTxEW8pRpv82f4pnAgNS1bTxAUa4t1AASSbZyjGI\n6g+xnACVBCLkY3nRumZcDtGYWUuUqSD7FAt5gI9lu/Aa2WsQtTCvsndbPwgibeGj\nCqT7VMnB4XC8I0I6hbvMiwCpliblOzVlMF4EE9WiAK8CgYAfbdwcDUA0bC5NbwD1\n9+6KF01Ib7M9DL+Hrfe+ZUGd0V4FRckHCGnnDFU4vMR+LqBWjIuVSUQhmayH5KGT\nqHXkVQ61+HLTV3mEdSwRd66VzVhaEAj2TZjgGohvL9J8ubjV31WDlZUAs1SktwMp\nLe5QuxBs1CmFW6mlX6AvOfypJQ==\n-----END PRIVATE KEY-----\n"
} ]

32.4.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 80

"http://api.example.com/application_principals/8a1be26796854d37abd5d76f2c4bcf0c"

32.5. Create Multiple Application Principals

A POST request is used to create multiple ApplicationPrincipal. The request should include references to a valid existing application and environment. This request can be used to renew an expired certificate. After creating a new ApplicationPrincipal, you can DELETE the expired one using Delete application principal.

32.5.1. Request fields

Path Type Description Constraints

[].principal

String

The principal of an Application for an Environment

[].application

String

A valid URI of an existing application

[].environment

String

A valid URI of an existing environment

32.5.2. Curl request

$ curl 'http://api.example.com/application_principals' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '[ {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924512",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
}, {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIERTCCAi2gAwIBAgIQLr/CWF5yW4ohcZEWjQtyiTANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNTU1NDFaFw0yNjA0MDMyMTU1NDFaME8xCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMRkwFwYDVQQDExBFeGFt\ncGxlIENvbnN1bWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzrSE\n2HFGibL+G5i2Fp4YgYBKvXLT8w5gU4d7zXv4EYl5VdyO6mOJb0ixFZqOCqYLLSPk\nCPDgl/jj20cgTRTe5wt5+1yvlwsPxngAceE2WJ6FHi4KGFMg6nSeQROhRTjQGx2R\nLlUr1ehhzV+qevxrknNR75X0kTtphcPgxOgNeEGowne/PBg709B/ffsTlc3/Y9Dp\nZGl/vsUQXJkzBoaxIpO7z3xsY+m5w1/qSEBXexZsArl0E/zVW2TGV8rByngPk43W\nEuUqG2ISNtu1kj9wbFOrjzKuuK2L+ihIo2nih14NWDdd0lDm4ZG1RP7mMi0oOgTH\nzim0MUielYC4mN9YIQIDAQABo0EwPzAOBgNVHQ8BAf8EBAMCBaAwDAYDVR0TAQH/\nBAIwADAfBgNVHSMEGDAWgBRr0ilXi1I2LAUKxle5GnR4rBMfZjANBgkqhkiG9w0B\nAQ0FAAOCAgEAuSSO67qhMdpTJQHabrP52gL0TdAhATu1ksv7FC7U/0lXxJw0YFuq\nFerxpWOC7oeJYkAQj77zxMmH6CVVUo+R3gPfbjC3AQ3usIKDoJs0SGSu9/eEPNdS\nzGx+Mc7l7Ev8rjz5V741WJXYb6mNAwrCAafhyq2GKa2QHngM6LA9k9HOy8MAQGhs\nG7DAxy8WQywf/plVjbQGBxXlUhRx/HM4/6L+JRzw44tvBEe1BOfr5Py5+DuuqlD4\nLx6/DQwPH6zlBjJpOeAmxl8sCk0TOLJ9InIb+vKOnAM/GwRAkLZtNJHXCg5YIh1m\nWBnj1Z5jTkH/0NJvzInXohzEweJuxJkKUSbaa6a1exCE4JEvlKoP6+aa5/qrNkEf\nmd/gI5TEucas1B10WjjDyI3pu9lE3CmjL88zwxRAjprxSFbfS/jww8TNy+3dHGCf\nizr/P5Jfrl0x0LSqqLBPbuAw0lSAZawSqcPx26Lef5f16SXXNPTuFFYdKh7f4qTt\nvhZHeWc59QS+Ger5ZGvJNnurXNc08i9rX+0Fr1M1O7/iHJvKRfwoi2O5kwiYcDZd\nYzaGaq1rMmKPUUeQvE/JwVqXTNCqeVF5Ut/5DkEQIFgxGAzNFKY7AbAqxtW9nZ6u\nGMvXjL4H4ps8f19jasgjjZYfVR2KmqBnmLSSYCiiCoXy7tmSobHB5Ak=\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924512",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
}, {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIERjCCAi6gAwIBAgIRAKNl25MS9MEut9BMUoelJrEwDQYJKoZIhvcNAQENBQAw\nKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEwHhcN\nMjUwNDAzMTU1NTQyWhcNMjYwNDAzMjE1NTQyWjBPMQswCQYDVQQGEwJOTDEQMA4G\nA1UEBxMHVXRyZWNodDETMBEGA1UEChMKQXh1YWwgQi5WLjEZMBcGA1UEAxMQRXhh\nbXBsZSBQcm9kdWNlcjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMxb\nSTL03zz0jeEWeOVWnvLFWdqKD8v1xjYuz3T0Saj6Xh41cFIsDA79pGmS21zTNn8S\nLs0Q0QahyaeK9KJgfiN2BvFnUIYMLIGLxaHoxuI5+7EjxVMG8Rr0jqoZev4twJN8\nxIC1KXEqz/PL4O7aJF/yy5wlAJqKS9FhhoYT4223bz3E9ZR2Ybklw49rB6jGsHsJ\nui/VS39/UKXKGKEvXK4/YJiI3xf7yk56dsHh0oue9c5N/4l7Bd0tt8RuuInmnCC8\ny10TZ5/ipFdq+2zYu/bdhllSKuIvWfc99db2j4oH3dNuhQIZmnTaRlxQFuN9P9q6\nQVj18/K2PIY4oNm7uWECAwEAAaNBMD8wDgYDVR0PAQH/BAQDAgWgMAwGA1UdEwEB\n/wQCMAAwHwYDVR0jBBgwFoAUa9IpV4tSNiwFCsZXuRp0eKwTH2YwDQYJKoZIhvcN\nAQENBQADggIBADQxTNyo82iIMfEox7BQY13ix+c8YGaJpNxcbGH66wqQsb9QOuEZ\nldyQ8cuB+Qmsml8DhekuY/hMOrubsjzbUT1Jq4vyL0HGC1WneG5mzlMtIPKdpKsF\nOSpdMewj+lCL2ihpSpr6Jfc0QIjjPWUWsQJwGz0i6ZpWwityEKMBNzQegoGeTVqp\nTW9zDg3Ur0XtGgax1LQ2ZdeHUAGyVCuFDupWMVGPBSxOIJK5v/In4SpNcTJSbs+9\nI4zDEsUcNk6nVg0/KNX7WGpk9t3tX9e22a//Wh6DC4CAQMfTDwAWwxlsIfDdCANT\n42Oz0ez0Vc/KGGClDmPujgve88Mkd5Ub1nzgL7iaYvsKOQemh5ea8OIk0bHFRpXK\nGM2Ik9hDbxisxr6GdSxwJ8gcUASTdl6bqhq7u0eebt/6V+uxHsYbfFUnDBJSH9n1\nh08pB5OtVFcQEqLV9sO/aHgXqAKeIwbtcFq/PolRhsajI129uDXc4rPH50KLRS7a\nzBefbseiuOcVLdYnqFdkhJsYwxtFcUbEYUzLnSIcZllsORTP6prUm7mPzWq4wdgl\nOpk4Km7bVSCTMJqNa6RBpNZh8ujKZMRgl90nC5OIjjG1Tz9vgKFV1bjwMDFUQwIv\nIOvubeJetbtUXLpXEQkBkwpEPDrGapw3rIw76J3XwnAYDcOB7B5LyWDs\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924512",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
} ]'

32.5.3. HTTP request

POST /application_principals HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 16600
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

[ {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924512",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
}, {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIERTCCAi2gAwIBAgIQLr/CWF5yW4ohcZEWjQtyiTANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNTU1NDFaFw0yNjA0MDMyMTU1NDFaME8xCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMRkwFwYDVQQDExBFeGFt\ncGxlIENvbnN1bWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzrSE\n2HFGibL+G5i2Fp4YgYBKvXLT8w5gU4d7zXv4EYl5VdyO6mOJb0ixFZqOCqYLLSPk\nCPDgl/jj20cgTRTe5wt5+1yvlwsPxngAceE2WJ6FHi4KGFMg6nSeQROhRTjQGx2R\nLlUr1ehhzV+qevxrknNR75X0kTtphcPgxOgNeEGowne/PBg709B/ffsTlc3/Y9Dp\nZGl/vsUQXJkzBoaxIpO7z3xsY+m5w1/qSEBXexZsArl0E/zVW2TGV8rByngPk43W\nEuUqG2ISNtu1kj9wbFOrjzKuuK2L+ihIo2nih14NWDdd0lDm4ZG1RP7mMi0oOgTH\nzim0MUielYC4mN9YIQIDAQABo0EwPzAOBgNVHQ8BAf8EBAMCBaAwDAYDVR0TAQH/\nBAIwADAfBgNVHSMEGDAWgBRr0ilXi1I2LAUKxle5GnR4rBMfZjANBgkqhkiG9w0B\nAQ0FAAOCAgEAuSSO67qhMdpTJQHabrP52gL0TdAhATu1ksv7FC7U/0lXxJw0YFuq\nFerxpWOC7oeJYkAQj77zxMmH6CVVUo+R3gPfbjC3AQ3usIKDoJs0SGSu9/eEPNdS\nzGx+Mc7l7Ev8rjz5V741WJXYb6mNAwrCAafhyq2GKa2QHngM6LA9k9HOy8MAQGhs\nG7DAxy8WQywf/plVjbQGBxXlUhRx/HM4/6L+JRzw44tvBEe1BOfr5Py5+DuuqlD4\nLx6/DQwPH6zlBjJpOeAmxl8sCk0TOLJ9InIb+vKOnAM/GwRAkLZtNJHXCg5YIh1m\nWBnj1Z5jTkH/0NJvzInXohzEweJuxJkKUSbaa6a1exCE4JEvlKoP6+aa5/qrNkEf\nmd/gI5TEucas1B10WjjDyI3pu9lE3CmjL88zwxRAjprxSFbfS/jww8TNy+3dHGCf\nizr/P5Jfrl0x0LSqqLBPbuAw0lSAZawSqcPx26Lef5f16SXXNPTuFFYdKh7f4qTt\nvhZHeWc59QS+Ger5ZGvJNnurXNc08i9rX+0Fr1M1O7/iHJvKRfwoi2O5kwiYcDZd\nYzaGaq1rMmKPUUeQvE/JwVqXTNCqeVF5Ut/5DkEQIFgxGAzNFKY7AbAqxtW9nZ6u\nGMvXjL4H4ps8f19jasgjjZYfVR2KmqBnmLSSYCiiCoXy7tmSobHB5Ak=\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924512",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
}, {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIERjCCAi6gAwIBAgIRAKNl25MS9MEut9BMUoelJrEwDQYJKoZIhvcNAQENBQAw\nKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEwHhcN\nMjUwNDAzMTU1NTQyWhcNMjYwNDAzMjE1NTQyWjBPMQswCQYDVQQGEwJOTDEQMA4G\nA1UEBxMHVXRyZWNodDETMBEGA1UEChMKQXh1YWwgQi5WLjEZMBcGA1UEAxMQRXhh\nbXBsZSBQcm9kdWNlcjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMxb\nSTL03zz0jeEWeOVWnvLFWdqKD8v1xjYuz3T0Saj6Xh41cFIsDA79pGmS21zTNn8S\nLs0Q0QahyaeK9KJgfiN2BvFnUIYMLIGLxaHoxuI5+7EjxVMG8Rr0jqoZev4twJN8\nxIC1KXEqz/PL4O7aJF/yy5wlAJqKS9FhhoYT4223bz3E9ZR2Ybklw49rB6jGsHsJ\nui/VS39/UKXKGKEvXK4/YJiI3xf7yk56dsHh0oue9c5N/4l7Bd0tt8RuuInmnCC8\ny10TZ5/ipFdq+2zYu/bdhllSKuIvWfc99db2j4oH3dNuhQIZmnTaRlxQFuN9P9q6\nQVj18/K2PIY4oNm7uWECAwEAAaNBMD8wDgYDVR0PAQH/BAQDAgWgMAwGA1UdEwEB\n/wQCMAAwHwYDVR0jBBgwFoAUa9IpV4tSNiwFCsZXuRp0eKwTH2YwDQYJKoZIhvcN\nAQENBQADggIBADQxTNyo82iIMfEox7BQY13ix+c8YGaJpNxcbGH66wqQsb9QOuEZ\nldyQ8cuB+Qmsml8DhekuY/hMOrubsjzbUT1Jq4vyL0HGC1WneG5mzlMtIPKdpKsF\nOSpdMewj+lCL2ihpSpr6Jfc0QIjjPWUWsQJwGz0i6ZpWwityEKMBNzQegoGeTVqp\nTW9zDg3Ur0XtGgax1LQ2ZdeHUAGyVCuFDupWMVGPBSxOIJK5v/In4SpNcTJSbs+9\nI4zDEsUcNk6nVg0/KNX7WGpk9t3tX9e22a//Wh6DC4CAQMfTDwAWwxlsIfDdCANT\n42Oz0ez0Vc/KGGClDmPujgve88Mkd5Ub1nzgL7iaYvsKOQemh5ea8OIk0bHFRpXK\nGM2Ik9hDbxisxr6GdSxwJ8gcUASTdl6bqhq7u0eebt/6V+uxHsYbfFUnDBJSH9n1\nh08pB5OtVFcQEqLV9sO/aHgXqAKeIwbtcFq/PolRhsajI129uDXc4rPH50KLRS7a\nzBefbseiuOcVLdYnqFdkhJsYwxtFcUbEYUzLnSIcZllsORTP6prUm7mPzWq4wdgl\nOpk4Km7bVSCTMJqNa6RBpNZh8ujKZMRgl90nC5OIjjG1Tz9vgKFV1bjwMDFUQwIv\nIOvubeJetbtUXLpXEQkBkwpEPDrGapw3rIw76J3XwnAYDcOB7B5LyWDs\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924512",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
} ]

32.5.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 238

"http://api.example.com/application_principals/2aa668c417434e45a1f5c9c8fea8d7e9,http://api.example.com/application_principals/d61736bd2f4a4589bb9e1a1ef2976812,http://api.example.com/application_principals/3a1b7b7580ba4ee6b364d3f891088ce7"

32.6. Create Application Principal that is already present

In case the ApplicationPrincipal is already present in the Self-Service with the exact same Principal and fingerprint, we return a 400 Bad Request to prevent saving the same principal again.

32.6.1. HTTP request

POST /application_principals HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 3964
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

[ {
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "application" : "http://api.example.com/applications/5ffc4240fcdf4a479a16f2b0b12ab909",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
} ]

32.6.2. HTTP response

HTTP/1.1 400 Bad Request
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 172

{
  "status" : "BAD_REQUEST",
  "message" : "A certificate already exists with the same fingerprint.",
  "errors" : [ "errmsg.duplicate.principal" ],
  "subErrors" : null
}

32.7. Create a custom Application Principal to store a clientID

A POST request is used to create a custom ApplicationPrincipal without using a pem file. This type of certificate is used to authenticate your application with an IAM provider using the custom ApplicationPrincipal as Client ID.

32.7.1. Request fields

Path Type Description Constraints

[].principal

String

The custom principal of an Application for an Environment

[].application

String

A valid URI of an existing application

[].environment

String

A valid URI of an existing environment

[].custom

Boolean

A boolean identifying if we are creating a custom principal

32.7.2. Curl request

$ curl 'http://api.example.com/application_principals' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '[ {
  "principal" : "a-custom-principal-identifying-a-clientID",
  "application" : "http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924512",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52",
  "custom" : true
} ]'

32.7.3. HTTP request

POST /application_principals HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 266
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

[ {
  "principal" : "a-custom-principal-identifying-a-clientID",
  "application" : "http://api.example.com/applications/39d82d7f34484b53ae1dd47ee8924512",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52",
  "custom" : true
} ]

32.7.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 80

"http://api.example.com/application_principals/7c00a475fc2a463aa3c1ebe510a010b5"

32.8. Retrieve application principal

The application_principals/{id} resource is used to retrieve a single principal of an application for an environment.

A GET request will retrieve the details of a ApplicationPrincipal.

32.8.1. HTTP request

GET /application_principals/1e9ee6ce053c46b0932358c8503a26fd HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

32.8.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 4514

{
  "principal" : "principal 1 test",
  "applicationPem" : "principal 1 test",
  "principalChain" : null,
  "privateKeyPem" : null,
  "expiresOn" : "2038-05-24T10:34:14",
  "uid" : "1e9ee6ce053c46b0932358c8503a26fd",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "privateKeyUploaded" : false,
  "_embedded" : {
    "environment" : {
      "_links" : {
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "application" : {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app1",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
      "description" : "tenantaApplication1 description.",
      "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "applicationPrincipal" : {
      "href" : "...",
      "title" : "A principal for application"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "environment" : {
      "href" : "...",
      "templated" : true,
      "title" : "An environment"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    }
  }
}
Relation Description

delete

Existence of this link indicates that the currently authenticated user can delete this ApplicationPrincipal

32.9. Update application principal (deprecated)

The endpoint PATCH /application_principals/{uid} is now deprecated. If you want to renew your certificate, first you can create new one Create Application Principal and later try to remove the old ApplicationPrincipal Delete application principal.

A PATCH request is used to update a ApplicationPrincipal. Only principal field can be modified.

If application, environment or privateKey needs to be updated, delete the ApplicationPrincipal and create a new one.

32.9.1. Curl request

$ curl 'http://api.example.com/application_principals/1e9ee6ce053c46b0932358c8503a26fd' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----\n"
}'

32.9.2. HTTP request

PATCH /application_principals/1e9ee6ce053c46b0932358c8503a26fd HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 1898
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "principal" : "-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----\n"
}

32.9.3. HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

32.10. Update a custom application principal

A PATCH request is used to update a custom ApplicationPrincipal. Only principal field can be modified.

If application or environment needs to be updated, delete the ApplicationPrincipal and create a new one.

32.10.1. Curl request

$ curl 'http://api.example.com/application_principals/c58du2867d8e43668271761e23659ef8' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "principal" : "updated-custom-principal"
}'

32.10.2. HTTP request

PATCH /application_principals/c58du2867d8e43668271761e23659ef8 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 46
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "principal" : "updated-custom-principal"
}

32.10.3. HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

32.11. Delete application principal

A DELETE request is used to delete an ApplicationPrincipal.

$ curl 'http://api.example.com/application_principals/1e9ee6ce053c46b0932358c8503a26fd' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
DELETE /application_principals/1e9ee6ce053c46b0932358c8503a26fd HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

32.12. Validate application principal

Validates the provided application_principal pem’s content for validity.

POST /application_principals/validate HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 5454
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "contents" : "-----BEGIN CERTIFICATE-----\nMIIETTCCAjWgAwIBAgIQXbkAp+6u0FcGaEaPwIsyVDANBgkqhkiG9w0BAQ0FADAr\nMSkwJwYDVQQDDCBBeHVhbCBEdW1teSBJbnRlcm1lZGlhdGUgMjAxOCAwMTAeFw0y\nNTA0MDMxNDM1NThaFw0yNjA0MDMyMDM1NThaMFcxCzAJBgNVBAYTAk5MMRAwDgYD\nVQQHEwdVdHJlY2h0MRMwEQYDVQQKEwpBeHVhbCBCLlYuMSEwHwYDVQQDExhFeGFt\ncGxlIFN0cmVhbSBQcm9jZXNzb3IwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDBXcezkUjIzQrIZdog9A1Momi6izgzP9/QzPxhOQHj3DHhlVN4o9UT9y9K\nhpJdWXUFhijSFzLDHHl3GwA1KdDsybE3jaVSzBg6F2op2X7agmLhPV8NvOFwS0Rk\n5OGIRyvNOj8EXazh+z6Y2sOEAZ1UFyAA5rBUTXiIUcYEPbkvDHp4pxma1SEuSNvT\nWDl3H2NpfZUcHhZ6+6U0X1foM4/NKtgd1oD9hq+aYYG8zY6eCRwoxFpYRiysECcG\n6gJcw9Ns8z8GoDdQ+NYNP+GBMtnpn7rYBFcLAeQ1Ek/FFUscuWJJZTej03AGDxQa\nr8kSu5PpHFMXLYH8U/TyYs9UjLXTAgMBAAGjQTA/MA4GA1UdDwEB/wQEAwIFoDAM\nBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFGvSKVeLUjYsBQrGV7kadHisEx9mMA0G\nCSqGSIb3DQEBDQUAA4ICAQAx5nMoyOOoEVSGdpjqPhL3dw8yMmHJIox6h51Az50U\nPR1ki9mwlrK/xKyErdGxWpws3qi51hTXnlY+oXN2pzPHO7L+YC5WH7A2KGldrRqc\ng25CQpW5WG4/5QrP1FsPYIiaS+E7HdIP/zOUTJyEmPKxYyC0i+oyiWtebyTDhKuz\n72HR0UriI+uiPaBcJbYGN75eLkNm5Isoc+oR6sOHk+MY3nQ1tNKXQbcKNY0LvEkw\nXcaIBbHb6NcRcODxx8G/3dG8GoU7nZkzzP6Mmj52yPaoW3vm312PZrGi2rxA8ka1\n1vnzGOZGTes4cfT/7wlV5IfpukqIJyF4MnaHpoefBZi9TCfQaXfGVhUbf9gfY2vv\nr2KwyjmAmqkI2cWTjuG/5OSZTzq5k5mTU77e3uSTse24FSF0mi3oNFR0IVa0kPxG\nIfGsw8/0zu7+z+iclukg1iI9BJhtwe8ku+JNUITxrcOpr0vxh6FcOd1qQQ9aCoNi\nY7mFtlRb/WZwfgiCZyvvrW6btQM1yHjZFuEVtZCoRZXCegIvktEgzgBSwNpkfZ+Y\nPfjwdBKxrF0NG+ZPLfFlDCgKSpIbSw1s8Gd4UVVWCwwQJZNM5TEiOpjMh32UKdLN\nEw5mVEw2wuO0DLpKRrqwpJuheenry+2O3wiwrP51abA9k7zfMU/OzxCqIsymkA6S\nHg==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
  "environment" : "https://api.example.com/api/environments/047ab08009fe4da8be6905b55552ab52"
}
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

32.13. Validate application principal’s Private Key

Validates the provided application_principal’s private key.

POST /application_principals/validate_private_key HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 7257
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "certificate" : "-----BEGIN CERTIFICATE-----\nMIIFhjCCA26gAwIBAgICECwwDQYJKoZIhvcNAQELBQAwKzEpMCcGA1UEAwwgQXh1\nYWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEwHhcNMTkwNjEzMTQwNTMyWhcN\nMjExMTI5MTQwNTMyWjBjMQswCQYDVQQGEwJOTDEQMA4GA1UECAwHVXRyZWNodDEQ\nMA4GA1UEBwwHVXRyZWNodDEOMAwGA1UECgwFQXh1YWwxDjAMBgNVBAsMBUF4dWFs\nMRAwDgYDVQQDDAd0ZXN0IENOMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKC\nAgEAnZaQX6aDGnNsua3DNlV/RI8BmjvpFaqOWNmWQYive6w8BTciuq+EeVUM6SGc\nST4YCFsuNFQjxYCiGMzFBp1kBWOY/x255MVik/zlcSZgSIqr2zikyR/9d9F9QEQr\nUXPthu3UwLXWJu+itfiOKDb5a2SY512MXaUDNntiZdSoL9IzV3vKOxNibyT3Ldmc\nf4FvBpF3cH+/SFjWi7Nu7u6xqQDotm/u3S61XaFlenTHwHvNezLtSU7xVFoFOGk+\nC0OTfLFXcEeRPujTpDC15PweBwlnwmmj7QjmJYI6Eq1dJ5JW5rrHLO1qYqZtfyG3\nl1PsGpxWHNJGTIyNjbQzcjdCCZBSdEVnICAU6m4RG33EXkjExPerlEhCcw8D703r\nWB8fgBc1n3wM/NZ3YXsHxTIcBTYFeIAzs3sGDKZ4cjxzktFIAUQ5aIMj9vc95et8\nTE8EiVpDDbL0SppmSawoA+/U+sx7t8Hh9m/HnGNAIULuj4CWYqvgM2/4ptSdpQfl\nzCKe4Hp1ACfcuOs/O5sj0PhosdOHKoLFki+Bf+wL5I83VpNnDHuEZ+zNF83JdcWL\ncd5hWWZ+EcW9GO3ITUKvBwKTKWB9wHCdyuAUTj6UrF1X4PYMvV5rK081gguefJH9\nh9RlBWy+5JDU2j7nt1Jrl4CM1v73LftCKmCC6bF8wPfl34MCAwEAAaN8MHowCQYD\nVR0TBAIwADAdBgNVHQ4EFgQUbFnI40k82TldvwpXAmngw+Gy4OYwHwYDVR0jBBgw\nFoAUa9IpV4tSNiwFCsZXuRp0eKwTH2YwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQW\nMBQGCCsGAQUFBwMBBggrBgEFBQcDAjANBgkqhkiG9w0BAQsFAAOCAgEAlMAVbb+M\nKx6ej6boH27b5fSZGCiXEanQ0u8uO1DeLJsagYwsb9EsCLQpVc5+M+rhMk++yVvr\n2Yb+UkTWfWcUwTcfLk3TEYe8X/8zqY+uDJOumNpSIgyF0kPeQ9KGNjaCZLa87Npb\n0dvXIabohJlEMGJt2/cAK19keC5VbxwKeSk95RUiSwgE8K4DbtyFUIIy8a1y+Mwu\nvlfIz/FVgQWlWjSZ0NUx7/oKgznDg5oRjiuD6yYM084soiW3RgxGQ/sxqUXJyc++\nFU3xwO3mVX1tjry/d42KRSxsLpM2+jAXawwzRWFjuFUExl1i1OgaGtU33MRo6siO\n0BPal3eBC5I7rGb8GOuYQmO5QLPpj8+sxCzqzKQOZ9ATLvdjM6v9EiRp5nuTXFh4\nV07qQ4hxs4KeRz9Oig5VpnHQ8/SGWFPV2TgEnPr3Lu6knNjvI8O9wwo1mF/Q3yUc\nHE1YdLJ9ctJ2KHbsPpWDO4Zk7+6LejkbscYzEOA2pUlQzpv1rZmOQcnhnhKHlppK\ni5ogPiczSIdmOqQ1jQNS7hzdWZCxpGdjsXtVrYRFUDRv9vqHieBSzuh/GI/PvW7d\nPNRKkMlItv+C4UczOBM1y3kMsHwFSvFfC++TBlA4PkSmtpgnMAXePUlck6H8irtD\naqeURSylqc7U1W1KbsDpI97UCxbVZnFPMhE=\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n",
  "privateKey" : "-----BEGIN PRIVATE KEY-----\nMIIJQQIBADANBgkqhkiG9w0BAQEFAASCCSswggknAgEAAoICAQCdlpBfpoMac2y5\nrcM2VX9EjwGaO+kVqo5Y2ZZBiK97rDwFNyK6r4R5VQzpIZxJPhgIWy40VCPFgKIY\nzMUGnWQFY5j/HbnkxWKT/OVxJmBIiqvbOKTJH/130X1ARCtRc+2G7dTAtdYm76K1\n+I4oNvlrZJjnXYxdpQM2e2Jl1Kgv0jNXe8o7E2JvJPct2Zx/gW8GkXdwf79IWNaL\ns27u7rGpAOi2b+7dLrVdoWV6dMfAe817Mu1JTvFUWgU4aT4LQ5N8sVdwR5E+6NOk\nMLXk/B4HCWfCaaPtCOYlgjoSrV0nklbmuscs7Wpipm1/IbeXU+wanFYc0kZMjI2N\ntDNyN0IJkFJ0RWcgIBTqbhEbfcReSMTE96uUSEJzDwPvTetYHx+AFzWffAz81ndh\newfFMhwFNgV4gDOzewYMpnhyPHOS0UgBRDlogyP29z3l63xMTwSJWkMNsvRKmmZJ\nrCgD79T6zHu3weH2b8ecY0AhQu6PgJZiq+Azb/im1J2lB+XMIp7genUAJ9y46z87\nmyPQ+Gix04cqgsWSL4F/7AvkjzdWk2cMe4Rn7M0Xzcl1xYtx3mFZZn4Rxb0Y7chN\nQq8HApMpYH3AcJ3K4BROPpSsXVfg9gy9XmsrTzWCC558kf2H1GUFbL7kkNTaPue3\nUmuXgIzW/vct+0IqYILpsXzA9+XfgwIDAQABAoICAA3yTUSpz+B/ZpfoMOaWGnVO\n0q17r90jAwYJ+6pBFoazb3xmrMQo1GiIhmP7fYFd5XKX3zbyW1gXUkEvniA/vaJc\ndiXd053Tei3uq7+fzdWdsCfuk2bZVe1MtPEDF3JV+CeA1NtZPGKlwpioLqyQcPJ4\nLLANL2b6O5aOxN6OO3Q//hs38WXZCVUcyGNeZuNB6TmDljZ2l88nTZV/g8nRhheW\n5QGAVntsrtBigECeJS97xWupziY2vlTgwqWDauJEUMEwULS3ILuYj2JwjSh+x4mH\n447pGoDX0MZxCAKvJRdjdB1nWkk3mbqxT+94ZG8YFkUkoNpcIayUo9JuqD7rdQSP\n/PyxYgy7jmKh0flINuqdgwVZpz/8hjrGOfufYPrNfAZqjan1zt8hDQTyTI0V8Ngc\nXzSWMVddXObPyOrdlBbJRHvhQ5lpIh/TKqAURCKptpSarLdcwlQqiru6leDCNAwv\nAUPQ/212MrSl59p5T9RdvxikOfhFDalYcl3xywSjZowwRuSzgYXpRr8STKxxzlGB\nvO4rQYHPzdP3JvytFqPghSNSVt+M6qu1ph6ou70YHSpVuocvB5+6iHDDgr0vrSXE\nawm4EOSEI+J9F5/YkIE1UtOI6Aj5HHguAWJXBj0ZGiv/bpAVNr+eTx1Ga9qM8nx4\n/2LxlF0urRWZw+qfXL3BAoIBAQDaI0L8k460PSUVF/dL5jwqvSPZey+piHJGWfBr\n5wWslDYn/ABJYKj3NYFF4WDvnabXa8qTmxGOvMuwAwpkp3iEY7MB651tJ26CSCQ4\nYSYwYve/uuhlfQhtFiEihbj9jPebWJK1mQTU+SMOrxWU6UfkFTtsBqnB1ewAorWg\nAbqICUoW4Up10GOAsKRaRu6vhbReTRjM6/G2d3WlFiVsroVPbJeAAWCM7StQaio+\nUKfDJwv8TTC6nPLiYjXfwCLhMSmmD89rreWh8MvVefNTQ4sHcdLJe7reWYxYgOQ3\nXokPFDkbUOqZ1vwahDADYzzI0Nc0YgZW5vR8aYJkhnr7IzUlAoIBAQC48Nb2QXdl\ns9WUzCkKqhonUJhv5+85HIzE7EwnBaNgPAV+whLc1RHYXYGbIXmwZnGPW9gO8E9a\nnoVCCOLKEofhDQnbOH0xucESsGe1CeTj9gjlr0ASxqp7C2EnDBOBbd2g1KGX+IER\ny4YD3D1qeegG/Sntdh4G2x7W/omHRkz+uZ9EuJDd6VBZZwckGJ0kv4iUBAxn1BtL\ngTkFJwManqrQd/4Ceh4osUlXgmpMgjZWzXA+i2jrZh4uWTvvUFEh/GsAqVhXcrHS\nEkSTB8pVRmXq5WIefPNkQqfoXX3aa0KYgPK8TpJWu/oqzPLCzP12ioCFNDsFIx8o\ngFIqSniwhKWHAoIBACdMmQHmF5yTM34UXkI3TXmpr667yb9yTJwuEeluqpAH96XG\necq+dlJrOkn7q7ofnfJLgiiLlGMx0kR4l8PAhC7dw19CMo96vicMljHuFrI68kWB\nh+LY3s7AYOHWU5iib+11zKCY28z+wXkgw/Oa/4+w3467uJOqVaVbqvsTtKZTfhyX\nJBILpBGIQWPeSZwnq3Id06z/iQGFjhVa4w0sd+nyN20hUmKxS89mAQxO/ZpkC329\n7lyAcCWm6evQsrf9YnJ/gK/2mVtOhXqFSPgkQATsVbxk5Sqv2WAMgJEVH/4ud4db\nUZi7qZmhXQEPPOE09sCCNIAthbhwTcSMkdVy510CggEAQr3PpdEcaJyMsIU5LnsS\nsyt3x7LY9zBhcNOh69cyDZG7nfIl4oIWTZH5KuXax5lA1C6d+04oJRjeGGWiirBD\nTylobC+npqFVlwwIcSIf81CgB1vGcMA3V+5UYkYOaAAhImB57KEm2ygqtgvuMhXK\ncXM9hU/CKFE9gPMc6K+rK6YLXz6IMT143Lq8rf8f/toMTPZlD7dRHl+FF2Hr0dh+\n5nrXNUeiyKaqRCVxfSjkuVCseDXRaFpS/AECCyxeCzjP2M5EblKa76feDX2bPEkK\nkMm1LjGDmKQhek77Ey7wOp8WenSUhS6TaozJ8xkNQ5FaLjgaMJFrNi+Q92gmw/Uq\n0wKCAQA7eo+Wz6VBg7i//jrVaZl7MqmuqpaID6vXpAbmjU5BGEoOzxK9cIS0AMsL\npY5QzwQb+y9S35qpkaXsgndlyvdMBq58e5NN+Z8WEULuO85CW3rD6e1rWlXx6M3Y\nLFSKJQUjQ63FQJ+LX8nHylDkV/9T/sCFiYa1zv3AW2c7rz8eqXP9MabptpMqRfwZ\nUVlECszO2xb3zwg7WEnZu+DBNKsTIrKT8w/h3KvvWRbORpDOYcjW64V2NnjBP6Pc\nCUE2QsYVDOG/UDXjNanf3DnMCVVMJn06p+HQCDlATFnScu1qo++A7Dj4HTWmDtiU\nDsbI3yNePnNb5x1AZjii68cy9pLG\n-----END PRIVATE KEY-----\n"
}
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

32.14. ApplicationPrincipals search endpoints

32.14.1. /application_principals/search/findByApplication

Returns all application principals for given Application.

Parameter Description

application

A valid URI of an existing Application

 
GET /application_principals/search/findByApplication?application=http%3A%2F%2Flocalhost%2Fapplications%2F5ffc4240fcdf4a479a16f2b0b12ab909 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 14312

{
  "_embedded" : {
    "application_principals" : [ {
      "principal" : "CN=Axual Dummy Intermediate 2018 01",
      "applicationPem" : "-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
      "principalChain" : "[0] CN=Axual Dummy Root 2018, [1] CN=Axual Dummy Intermediate 2018 01",
      "privateKeyPem" : null,
      "expiresOn" : "2028-05-26T11:01:34",
      "uid" : "0572812fdc82413999e928fba1194d21",
      "created_at" : "2022-07-24T23:16:23",
      "modified_at" : "2022-07-24T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "privateKeyUploaded" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "applicationPrincipal" : {
          "href" : "...",
          "title" : "A principal for application"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        }
      }
    }, {
      "principal" : "principal 1 test",
      "applicationPem" : "principal 1 test",
      "principalChain" : null,
      "privateKeyPem" : null,
      "expiresOn" : "2038-05-24T10:34:14",
      "uid" : "1e9ee6ce053c46b0932358c8503a26fd",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "privateKeyUploaded" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "applicationPrincipal" : {
          "href" : "...",
          "title" : "A principal for application"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

32.14.2. /application_principals/search/findByEnvironment

Returns all application principals for given Environment.

Parameter Description

environment

A valid URI of an existing Environment

 
GET /application_principals/search/findByEnvironment?environment=http%3A%2F%2Flocalhost%2Fenvironments%2F46cfaf47d2d04d12923beefac3d0ba5a HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 5297

{
  "_embedded" : {
    "application_principals" : [ {
      "principal" : "CN=tenantaapp3,D=tenanta,S=utrecht,C=NL",
      "applicationPem" : "CN=tenantaapp3,D=tenanta,S=utrecht,C=NL",
      "principalChain" : null,
      "privateKeyPem" : null,
      "expiresOn" : null,
      "uid" : "177d7b6b14594e8d8e51186eff59408b",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "privateKeyUploaded" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaprivenv1",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv1",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "46cfaf47d2d04d12923beefac3d0ba5a",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaAutoApplication3",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team App Admins",
            "emailAddress" : null,
            "uid" : "514d4oit834841869644c2ad8b439997",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.auto.app3",
          "applicationType" : "Custom",
          "shortName" : "tenanta_auto_app3",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.auto.app3" ],
          "description" : "",
          "uid" : "4cc380171afc4c898b6f6c02caccf451",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "applicationPrincipal" : {
          "href" : "...",
          "title" : "A principal for application"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

32.14.3. /application_principals/search/findByApplicationAndEnvironment

Returns application principals for given Application and Environment, and ordered by the created date.

Parameter Description

application

A valid URI of an existing Application

environment

A valid URI of an existing Environment

 
GET /application_principals/search/findByApplicationAndEnvironment?application=http%3A%2F%2Flocalhost%2Fapplications%2F5ffc4240fcdf4a479a16f2b0b12ab909&environment=http%3A%2F%2Flocalhost%2Fenvironments%2F047ab08009fe4da8be6905b55552ab52 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 14427

{
  "_embedded" : {
    "application_principals" : [ {
      "principal" : "CN=Axual Dummy Intermediate 2018 01",
      "applicationPem" : "-----BEGIN CERTIFICATE-----\nMIIFLTCCAxWgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UEAwwVQXh1\nYWwgRHVtbXkgUm9vdCAyMDE4MB4XDTE4MDUyOTExMDEzNFoXDTI4MDUyNjExMDEz\nNFowKzEpMCcGA1UEAwwgQXh1YWwgRHVtbXkgSW50ZXJtZWRpYXRlIDIwMTggMDEw\nggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9uOuzJekmeo3hl8fjQlKS\nHApS3llcliq1YrXpkMbHAA9StHaMHPW+Dzr2/+cdfBAmN3sujCY8Paq15QI+TDOq\nKA5SByCBQKXx2qulBPcZs3mDMt+KxAaeWfwR4Nj0NNKbmw2HjDddo77joeVOuOX2\n4o1wXzmAAolVMIcRYA11EMWNUtYrHCzBa7RfYht2G5dE69ckrgfw1Nxs01Sbg+xP\nsK9aK/LHPUalYZNY+76x7vabEpzaPfpyKzDTWA20SPk0WfTf9/+K3o+urzDG8O/q\nw9xbBOzWohGmRyA/z841p1SD7inpZcyO/KeW1yTP2WyFxADwUrv2mEYXnma/Gdna\nG62IQYk/UMex9W8pT6tfwrg/36sSwr88yPR5dJxzjHUE+w/rYG3k+K+EqvZ5qOC5\n32AJ9BS2nbNuGpmRU1qoMCwpL7B2E/CKJLIdFcf/qmcnWJEXo+u34+fQZg8XaDCI\nXhUqAHz6YkjCiFGd/JwL1IqsfxFsV9wHTUbW2AumglU65ZrjhXrrzE7Hk9ng1spJ\ndOwfBihBNjnr0mKHY9leJ3chJ9HQ55/fEgcRNrj8EC69QCeAtpY5yOAjKpA03UvF\ngrDt8CIyIehNUwTXIhQSHZU4eZ0rzWf0vvMbhL2FvKtphbpnNKoXeNLv2IMZpT4B\nVwsqLqaIkl/I4FPpYBoSYwIDAQABo2YwZDAdBgNVHQ4EFgQUa9IpV4tSNiwFCsZX\nuRp0eKwTH2YwHwYDVR0jBBgwFoAUdKOPDqSFQ6Bfk0I/asBkByt5gsUwEgYDVR0T\nAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB\nAKoNIqiOdjlUBNg7cvR9Su4KgGrsZf78pG1H2MlNxJjFM/80EiWEfze/EG2MLxFq\n8vToIHDjb0kVetYpdmfHNXTTlaaroBlXwyUYToPzQ985qr3LD8RhYZFAsiZCTtpJ\n4FT6sh/mccTyx8G8+ZS6mn/le2WPj/t6beNLgbdl5n8fghdQcmT/TqGXE50UftWt\nHSx3fsq2aKuNdVzhKzTin50IbiE9DV1dKo6B+ipOy/Dz5GMv3Z/3ntLTvxabCMOl\n7s7WsUE7VPABRSifUS80Z9Ai38faLSu+Ouzx40ceXwvlFQtJ2LYQ8Ru5Q63k2wB3\nEOE6cgAhiYExrz3fDDtUkui9vIfWfTPMnXR7xQ8YqK4Qqld2ESxvMQU2jzbZKSf+\n3sWnPvN4HTg0cfysmOdLGZwf3u8A9tMtxhUEtxUx7r76M4ekSKdNv1Nf5u5N/h7b\nAbEqSp1XADTxkE448i7hNJzn2Ce6JtFya231Ni0xyYKQIajP18jNypAw1eABYFkN\n53vQTUfqcbtcrCios1xRdDqfgkYaKZv7p63aoObFTf/mmG7sFjGAEPQscagOukwN\nwnkjCVifVbk5qJUaUWSLeYziI+HYkEA9P/h4o83nbf0YgBtOFoc0XWKmKagHifZN\nSEJ9kRCWzYaL2ChiL6jHGh26WT/hbNKeAlcxPnT4u/l1\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFJjCCAw6gAwIBAgIJAINuAirfnRU6MA0GCSqGSIb3DQEBCwUAMCAxHjAcBgNV\nBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODAeFw0xODA1MjkxMDM0MTRaFw0zODA1\nMjQxMDM0MTRaMCAxHjAcBgNVBAMMFUF4dWFsIER1bW15IFJvb3QgMjAxODCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVDjbhq3TGuQ6INTZ+dhSIgsdbq\nw2nxF3myrS7v89bcNxMyLypWYTmR4OAYRXRBnW4KX6sTubPyL3ogPz6hXmfmPfAz\n+X//HTIiybL3e3qwxqWphp09+JT6veEp/e/wEEjSMj5nsxkDEjj9JEQWu/1B+N+V\nXOJkTYFy05ZgeWplkyLwT71myF047aISK27a+VebBMaPpvvetScbMSwxAbk51cGV\nUC4gpwvnvsbp/CRuMV0dYzkeTmxgn860l3s8+7qUJoOrtiO0cDpv97SK9Ck9ef1k\nR6KFttzxb/u+eMFi3RUErEGwE8P3thTseXRkp5hMwcyaSQv0wfLawlwcNFGOzsBx\nfJS7QUIUpEyzRqj5Ppgaj530APxbgitLOfVLZ2DvcBcmnQns6OE+uwymuvAj8Ftj\n6AFJXH2lmswHLl5uD9kIOwmpZg4NZLP2Qv+WOT6HLgI7Kv1z0OV2H7UlWA7hwQXl\noQ6fJ2YLEhT+GM9xHKJ+DQCxvjWvtGUSb/Dk0j/R9mpSFfHvVJgE/xV+7F7Vlyw5\n/cDpF3GZOTGQ/MFy4RqRrTtjnZw2/bZZyJ+Xb743OeQhABFUdadh8cmyehDregtr\nalHxtjKxCxrT55OHCYhbCoz6nEnQURD7EPQhU5puUKalRq2ApDkveIk8uj0HQmQm\nKyRuNX7M6vCoWnpxAgMBAAGjYzBhMB0GA1UdDgQWBBR0o48OpIVDoF+TQj9qwGQH\nK3mCxTAfBgNVHSMEGDAWgBR0o48OpIVDoF+TQj9qwGQHK3mCxTAPBgNVHRMBAf8E\nBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAbJanqR4P\nmr05AyAu8vlrLsleXA8VAPDiaaYStYH5cIdBBWkaIxanLFDmbyQwKkKdkHQWV9X8\n1P52q49T9RsoBsEOmwdiaCY2PEUz7Y3bFW0UeM+k65VlHlXWywRM6+O02t4TrJXH\nF6h7vPon01OwhgW9Yil/Kr+yyZK50Ic+pm4UhHmtxY932cNaRCdae5tKsjabsP7Z\nrdAksLia8mTp+HADkZJ1uODxyDh0S1WMKB5JoHYBrmtUr1NYLgRC6SinhK4r7rbi\nEWuurE605Nm//jv3Czdy8gEsMDtXLZYY0iqGnD11MAJFXyQ6PG2eq1cXcsJNRojm\n8D4ipfQ+z4bp9dDVR2DzVyTYe4yuhZuIe2phOhPc8KkBaXQRMHfVKyeEmzqEFLaM\nkfaDZkRsrMZSqh+KJoxDG3h8UqssChX+cuZdsjRhNWRqfbB20I9Upwa+XooyCU4E\nEkYyFTMchtvbYZEN/XvlPfhK5JB9eJ5rrcE8hKsP3gftchWWqCDedKugvZW/t5Vk\nlc+z4IjiJFnRDfcr4Z5V2Hpseyno3AEK7aUdJlmuPnxoImFXfQ4jUguM/wznJHl7\nXv9T0oaBVHM7Bd6PlES04Oho0KZXS6NryTsZn9GFV4qGZj5lEeOVl15AOfeIjP/I\nokA2uUH/ZuJlR/BEmqbLt5HWPRNT/GgLfPY=\n-----END CERTIFICATE-----",
      "principalChain" : "[0] CN=Axual Dummy Root 2018, [1] CN=Axual Dummy Intermediate 2018 01",
      "privateKeyPem" : null,
      "expiresOn" : "2028-05-26T11:01:34",
      "uid" : "0572812fdc82413999e928fba1194d21",
      "created_at" : "2022-07-24T23:16:23",
      "modified_at" : "2022-07-24T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "privateKeyUploaded" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "applicationPrincipal" : {
          "href" : "...",
          "title" : "A principal for application"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        }
      }
    }, {
      "principal" : "principal 1 test",
      "applicationPem" : "principal 1 test",
      "principalChain" : null,
      "privateKeyPem" : null,
      "expiresOn" : "2038-05-24T10:34:14",
      "uid" : "1e9ee6ce053c46b0932358c8503a26fd",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "privateKeyUploaded" : false,
      "_embedded" : {
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaApplication1",
          "type" : "Java",
          "applicationClass" : null,
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
          "applicationType" : "Custom",
          "shortName" : "tenanta_app1",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "description" : "tenantaApplication1 description.",
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "applicationPrincipal" : {
          "href" : "...",
          "title" : "A principal for application"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "templated" : true,
      "title" : "URI pointing to current request"
    },
    "viewApplicationPrincipal" : {
      "href" : "...",
      "templated" : true
    }
  }
}

33. ApplicationAccess

An ApplicationAccess defines the access type held by an Application on a Stream. There are two access types supported: PRODUCER and CONSUMER.

A PRODUCER access type indicates that the application will produce messages to the stream.

A CONSUMER access type indicates that the application will consume messages from the stream.

The /application_access resource is used to create and list ApplicationAccess.

An ApplicationAccess contains a collection of StreamAuthorization which describes the Environment where the ApplicationAccess is active. These authorizations can be managed at /application_access/uid/authorizations endpoint.

An Application can have multiple ApplicationAccess types (PRODUCER and CONSUMER) on a single Stream.

33.1. ApplicationAccess Schema

The /application_access resource uses the following json-schema:

GET /profile/application_access HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 1278

{
  "title" : "Application access",
  "definitions" : { },
  "properties" : {
    "accessType" : {
      "title" : "Access type",
      "readOnly" : false,
      "type" : "string",
      "enum" : [ "PRODUCER", "CONSUMER" ]
    },
    "grants" : {
      "title" : "Grants",
      "readOnly" : true,
      "type" : "string",
      "format" : "uri"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "application" : {
      "title" : "Application",
      "readOnly" : true,
      "type" : "string",
      "format" : "uri"
    },
    "stream" : {
      "title" : "Stream",
      "readOnly" : true,
      "type" : "string",
      "format" : "uri"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

33.2. List all application access

HTTP method GET is disabled for /application_access. Refer to search endpoints to find one or more ApplicationAccess for a Stream or an Application or both.

33.3. Update application access

HTTP method PATCH and PUT is disabled for /application_access. Once an application access is created, it cannot be modified. Instead delete and create a new one.

33.4. ApplicationAccess search endpoints

33.4.1. /application_access/search/findByGrantsContaining

Returns all application access for given ApplicationAccessGrant.

Parameter Description

applicationAccessGrant

A valid URI of an existing Application Access Grant

 
GET /application_access/search/findByGrantsContaining?applicationAccessGrant=http%3A%2F%2Flocalhost%2Fapplication_access_grants%2F764c61795cc4438ca8ea5aca262c8e70 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 12429

{
  "accessType" : "PRODUCER",
  "uid" : "fedb6478bfd640caa02f5e5893c62bf0",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "grants" : [ {
      "_links" : {
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "comment" : null,
      "status" : "Pending",
      "environment" : {
        "properties" : { },
        "name" : "tenantaprivenv7",
        "shortName" : "tenantaprivenv7",
        "description" : "environment with application_access_grant and mapping to application_access",
        "color" : "#80affe",
        "authorizationIssuer" : "Auto",
        "visibility" : "private",
        "retentionTime" : 604800000,
        "partitions" : 12,
        "settings" : { },
        "private" : true,
        "autoApproved" : true,
        "uid" : "a5f2383420e249459b24b7cb189b40bc",
        "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
        "streamOwnerAuthorizer" : false,
        "ksmlEnabled" : false,
        "created_at" : "2021-06-07T23:16:23",
        "modified_at" : "2021-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "requestedAt" : "2018-09-09T13:16:00",
      "requestedBy" : "diffperson@tenanta.nl",
      "processedAt" : "2018-06-09T13:16:00",
      "processedBy" : null,
      "uid" : "f6cc136ad13e011c98d620f7b45eff86",
      "created_at" : "2018-09-09T13:16:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "comment" : null,
      "status" : "Pending",
      "environment" : {
        "properties" : { },
        "name" : "tenantaprivenv7",
        "shortName" : "tenantaprivenv7",
        "description" : "environment with application_access_grant and mapping to application_access",
        "color" : "#80affe",
        "authorizationIssuer" : "Auto",
        "visibility" : "private",
        "retentionTime" : 604800000,
        "partitions" : 12,
        "settings" : { },
        "private" : true,
        "autoApproved" : true,
        "uid" : "a5f2383420e249459b24b7cb189b40bc",
        "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
        "streamOwnerAuthorizer" : false,
        "ksmlEnabled" : false,
        "created_at" : "2021-06-07T23:16:23",
        "modified_at" : "2021-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "requestedAt" : "2018-09-09T13:16:00",
      "requestedBy" : "streamowner@tenanta.nl",
      "processedAt" : "2018-06-09T13:16:00",
      "processedBy" : null,
      "uid" : "5ec9f6ff8136ad68d62cc13e0110f7b4",
      "created_at" : "2018-09-09T13:16:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "comment" : null,
      "status" : "Pending",
      "environment" : {
        "properties" : { },
        "name" : "tenantaenv1",
        "shortName" : "tenantaenv1",
        "description" : "environment",
        "color" : "#80affe",
        "authorizationIssuer" : "Stream owner",
        "visibility" : "public",
        "retentionTime" : 604800000,
        "partitions" : 12,
        "settings" : { },
        "private" : false,
        "autoApproved" : false,
        "uid" : "047ab08009fe4da8be6905b55552ab52",
        "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
        "streamOwnerAuthorizer" : true,
        "ksmlEnabled" : false,
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "requestedAt" : "2018-06-07T14:16:00",
      "requestedBy" : null,
      "processedAt" : "2018-06-07T15:16:00",
      "processedBy" : null,
      "uid" : "cc13e0110f7b45ec98d62f6ff8136ad6",
      "created_at" : "2018-06-07T13:16:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "comment" : null,
      "status" : "Approved",
      "environment" : {
        "properties" : { },
        "name" : "tenantaenv2",
        "shortName" : "tenantaenv2",
        "description" : "environment",
        "color" : "#80affe",
        "authorizationIssuer" : "Stream owner",
        "visibility" : "public",
        "retentionTime" : 604800000,
        "partitions" : 12,
        "settings" : { },
        "private" : false,
        "autoApproved" : false,
        "uid" : "e11ee2dd976647109ca904dd8adc050f",
        "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
        "streamOwnerAuthorizer" : true,
        "ksmlEnabled" : false,
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "requestedAt" : "2018-09-09T13:16:00",
      "requestedBy" : null,
      "processedAt" : "2018-06-09T13:16:00",
      "processedBy" : null,
      "uid" : "764c61795cc4438ca8ea5aca262c8e70",
      "created_at" : "2018-09-09T13:16:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "comment" : null,
      "status" : "Approved",
      "environment" : {
        "properties" : { },
        "name" : "tenantaenv10",
        "shortName" : "tenantaenv10",
        "description" : "environment",
        "color" : "#80affe",
        "authorizationIssuer" : "Stream owner",
        "visibility" : "public",
        "retentionTime" : 604800000,
        "partitions" : 12,
        "settings" : { },
        "private" : false,
        "autoApproved" : false,
        "uid" : "3gr4e2046dad49468e0848571982a4b8",
        "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
        "streamOwnerAuthorizer" : true,
        "ksmlEnabled" : false,
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "requestedAt" : "2018-06-07T13:16:00",
      "requestedBy" : null,
      "processedAt" : "2018-06-25T13:16:00",
      "processedBy" : null,
      "uid" : "8760527241d041430209ec714680g8db",
      "created_at" : "2022-06-07T13:16:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null
    } ],
    "application" : {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication1",
      "type" : "Java",
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1",
      "applicationType" : "Custom",
      "shortName" : "tenanta_app1",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
      "description" : "tenantaApplication1 description.",
      "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "stream" : {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream1",
      "properties" : {
        "key-1" : "696969",
        "key-3" : "696969",
        "key-2" : "60000"
      },
      "tags" : [ "TAG1", "tAg2", "avro" ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "066f5944d16344f88c9214d240d139dc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "applicationAccess" : {
      "href" : "...",
      "templated" : true,
      "title" : "Access declarations for streams of an application"
    },
    "createApplicationAccessGrant" : {
      "href" : "..."
    },
    "grants" : {
      "href" : "...",
      "templated" : true
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "stream" : {
      "href" : "...",
      "templated" : true,
      "title" : "A stream"
    }
  }
}

33.5. Managing ApplicationAccessGrant (Access per Environment)

In order to be able to request access for an ApplicationAccess on one or more Environment, application owner needs to create an ApplicationAccessGrant.

33.5.1. Create an ApplicationAccessGrant

A POST is used to create an ApplicationAccessGrant.

HTTP request
POST /application_access_grants HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 297
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "applicationId" : "http://api.example.com/applications/4cc380171afc4c898b6f6c02caccf451",
  "streamId" : "http://api.example.com/streams/a549f500d879419c9f5efa5d3cada7b3",
  "environmentId" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52",
  "accessType" : "CONSUMER"
}
HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://api.example.com/application_access_grants/6c40408ff43046349973e1a2f892a3d7
Content-Type: application/hal+json
Content-Length: 902

{
  "uid" : "6c40408ff43046349973e1a2f892a3d7",
  "id" : "6c40408ff43046349973e1a2f892a3d7",
  "status" : "Pending",
  "requestedBy" : "appadmin@tenanta.nl",
  "processedBy" : null,
  "comment" : null,
  "environment" : {
    "uid" : "047ab08009fe4da8be6905b55552ab52",
    "id" : "047ab08009fe4da8be6905b55552ab52",
    "properties" : { },
    "name" : "tenantaenv1",
    "shortName" : "tenantaenv1",
    "description" : "environment",
    "color" : "#80affe",
    "authorizationIssuer" : "Stream owner",
    "visibility" : "public",
    "retentionTime" : 604800000,
    "partitions" : 12,
    "created_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_at" : "2018-06-07T23:16:23",
    "modified_by" : null
  },
  "created_at" : null,
  "created_by" : null,
  "modified_at" : null,
  "modified_by" : null,
  "requested_at" : "2025-06-25T08:09:55.633674075",
  "processed_at" : null
}

33.5.2. Cancel a pending ApplicationAccessGrant

To cancel a grant that was already requested (in Pending state), call DELETE method on /application_access_grants/uid endpoint.

HTTP request
DELETE /application_access_grants/cc13e0110f7b45ec98d62f6ff8136ad6 HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

33.5.3. Approve a pending ApplicationAccessGrant

The StreamOwner needs to approve a pending ApplicationAccessGrant.

These can be done by using PUT method on /application_access_grants/uid.

HTTP request
PUT /application_access_grants/cc13e0110f7b45ec98d62f6ff8136ad6 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

33.5.4. Revoke/Deny an authorization request for an ApplicationAccessGrant

StreamOwner can DENY or REVOKE an ApplicationAccessGrant by using POST method on application_access_grants/uid/deny.

ApplicationOwner also can CANCEL or REVOKE an ApplicationAccessGrant by using this endpoint.

It’s also possible to specify a comment/reason beside the request.

EnvironmentOwner can REVOKE an ApplicationAccessGrant for their PRIVATE environments.
HTTP request
POST /application_access_grants/764c61795cc4438ca8ea5aca262c8e70/deny HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 31
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "reason" : "Not allowed."
}
HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

33.5.5. Searching grants by Attributes

A GET request is used to retrieve all application access grants based on the following parameters.

  • StreamId

  • ApplicationId

  • EnvironmentId

  • OwnerIds

  • Statuses

Query parameters
Parameter Description

streamId

Stream id to search for.

applicationId

Application id to search for.

environmentId

Environment id to search for.

ownerIds

Owner ids (comma separated) to search for.

statuses

Statuses (comma separated) of the application access grant to search for.

accessType

Access type filter. Allowed values: PRODUCER or CONSUMER.

sort

Property to sort on and the direction.

page

Navigate through different pages.

size

Property to define the page size.
HTTP request
GET /application_access_grants/search/findByAttributes?streamId=066f5944d16344f88c9214d240d139dc&applicationId=&environmentId=&ownerIds=&statuses=&accessType=PRODUCER&sort=processedAt%2Casc&page=0&size=5 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 28908

{
  "_embedded" : {
    "applicationAccessGrantResponses" : [ {
      "accessType" : "PRODUCER",
      "uid" : "cc13e0110f7b45ec98d62f6ff8136ad6",
      "comment" : null,
      "_embedded" : {
        "environment" : {
          "properties" : { },
          "name" : "tenantaenv1",
          "shortName" : "tenantaenv1",
          "description" : "environment",
          "color" : "#80affe",
          "authorizationIssuer" : "Stream owner",
          "visibility" : "public",
          "retentionTime" : 604800000,
          "partitions" : 12,
          "settings" : { },
          "private" : false,
          "autoApproved" : false,
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
          "streamOwnerAuthorizer" : true,
          "ksmlEnabled" : false,
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "name" : "tenantaApplication1",
          "shortName" : "tenanta_app1",
          "description" : "tenantaApplication1 description.",
          "applicationType" : "Custom",
          "type" : "Java",
          "applicationClass" : null,
          "visibility" : "public",
          "owners" : {
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "phoneNumber" : null,
            "properties" : { },
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null,
            "_embedded" : {
              "members" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "appOwner",
                "lastName" : "TenantA",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "appowner@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "51234a7a81994d1ca35ca7894cde08c6"
              } ]
            },
            "_links" : {
              "self" : {
                "href" : "...",
                "title" : "URI pointing to current request"
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ]
            }
          },
          "properties" : { },
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "kafkaStreamsBased" : false,
          "connector" : false,
          "axualManagedKsml" : false,
          "kafkaStreams" : false,
          "customKsml" : false,
          "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "ableToGenerateSchemaRegistryPassword" : false,
          "ableToResetOffsets" : true,
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null,
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
        },
        "stream" : {
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "name" : "tenanta-stream1",
          "description" : "description_tenanta-stream1",
          "keyType" : "AVRO",
          "valueType" : "AVRO",
          "retentionPolicy" : "delete",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "appConfigured" : true,
      "streamConfigured" : true,
      "status" : "Pending",
      "requestedByUser" : null,
      "processedByUser" : null,
      "processedAt" : "2018-06-07T15:16:00",
      "requestedAt" : "2018-06-07T14:16:00",
      "_links" : {
        "approve" : {
          "href" : "..."
        },
        "deny" : {
          "href" : "..."
        }
      }
    }, {
      "accessType" : "PRODUCER",
      "uid" : "764c61795cc4438ca8ea5aca262c8e70",
      "comment" : null,
      "_embedded" : {
        "environment" : {
          "properties" : { },
          "name" : "tenantaenv2",
          "shortName" : "tenantaenv2",
          "description" : "environment",
          "color" : "#80affe",
          "authorizationIssuer" : "Stream owner",
          "visibility" : "public",
          "retentionTime" : 604800000,
          "partitions" : 12,
          "settings" : { },
          "private" : false,
          "autoApproved" : false,
          "uid" : "e11ee2dd976647109ca904dd8adc050f",
          "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
          "streamOwnerAuthorizer" : true,
          "ksmlEnabled" : false,
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "name" : "tenantaApplication1",
          "shortName" : "tenanta_app1",
          "description" : "tenantaApplication1 description.",
          "applicationType" : "Custom",
          "type" : "Java",
          "applicationClass" : null,
          "visibility" : "public",
          "owners" : {
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "phoneNumber" : null,
            "properties" : { },
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null,
            "_embedded" : {
              "members" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "appOwner",
                "lastName" : "TenantA",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "appowner@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "51234a7a81994d1ca35ca7894cde08c6"
              } ]
            },
            "_links" : {
              "self" : {
                "href" : "...",
                "title" : "URI pointing to current request"
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ]
            }
          },
          "properties" : { },
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "kafkaStreamsBased" : false,
          "connector" : false,
          "axualManagedKsml" : false,
          "kafkaStreams" : false,
          "customKsml" : false,
          "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "ableToGenerateSchemaRegistryPassword" : false,
          "ableToResetOffsets" : true,
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null,
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
        },
        "stream" : {
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "name" : "tenanta-stream1",
          "description" : "description_tenanta-stream1",
          "keyType" : "AVRO",
          "valueType" : "AVRO",
          "retentionPolicy" : "delete",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "appConfigured" : false,
      "streamConfigured" : true,
      "status" : "Approved",
      "requestedByUser" : null,
      "processedByUser" : null,
      "processedAt" : "2018-06-09T13:16:00",
      "requestedAt" : "2018-09-09T13:16:00",
      "_links" : {
        "revoke" : {
          "href" : "..."
        }
      }
    }, {
      "accessType" : "PRODUCER",
      "uid" : "f6cc136ad13e011c98d620f7b45eff86",
      "comment" : null,
      "_embedded" : {
        "environment" : {
          "properties" : { },
          "name" : "tenantaprivenv7",
          "shortName" : "tenantaprivenv7",
          "description" : "environment with application_access_grant and mapping to application_access",
          "color" : "#80affe",
          "authorizationIssuer" : "Auto",
          "visibility" : "private",
          "retentionTime" : 604800000,
          "partitions" : 12,
          "settings" : { },
          "private" : true,
          "autoApproved" : true,
          "uid" : "a5f2383420e249459b24b7cb189b40bc",
          "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
          "streamOwnerAuthorizer" : false,
          "ksmlEnabled" : false,
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "name" : "tenantaApplication1",
          "shortName" : "tenanta_app1",
          "description" : "tenantaApplication1 description.",
          "applicationType" : "Custom",
          "type" : "Java",
          "applicationClass" : null,
          "visibility" : "public",
          "owners" : {
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "phoneNumber" : null,
            "properties" : { },
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null,
            "_embedded" : {
              "members" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "appOwner",
                "lastName" : "TenantA",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "appowner@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "51234a7a81994d1ca35ca7894cde08c6"
              } ]
            },
            "_links" : {
              "self" : {
                "href" : "...",
                "title" : "URI pointing to current request"
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ]
            }
          },
          "properties" : { },
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "kafkaStreamsBased" : false,
          "connector" : false,
          "axualManagedKsml" : false,
          "kafkaStreams" : false,
          "customKsml" : false,
          "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "ableToGenerateSchemaRegistryPassword" : false,
          "ableToResetOffsets" : true,
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null,
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
        },
        "stream" : {
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "name" : "tenanta-stream1",
          "description" : "description_tenanta-stream1",
          "keyType" : "AVRO",
          "valueType" : "AVRO",
          "retentionPolicy" : "delete",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "appConfigured" : false,
      "streamConfigured" : false,
      "status" : "Pending",
      "requestedByUser" : null,
      "processedByUser" : null,
      "processedAt" : "2018-06-09T13:16:00",
      "requestedAt" : "2018-09-09T13:16:00",
      "_links" : {
        "approve" : {
          "href" : "..."
        },
        "deny" : {
          "href" : "..."
        }
      }
    }, {
      "accessType" : "PRODUCER",
      "uid" : "5ec9f6ff8136ad68d62cc13e0110f7b4",
      "comment" : null,
      "_embedded" : {
        "environment" : {
          "properties" : { },
          "name" : "tenantaprivenv7",
          "shortName" : "tenantaprivenv7",
          "description" : "environment with application_access_grant and mapping to application_access",
          "color" : "#80affe",
          "authorizationIssuer" : "Auto",
          "visibility" : "private",
          "retentionTime" : 604800000,
          "partitions" : 12,
          "settings" : { },
          "private" : true,
          "autoApproved" : true,
          "uid" : "a5f2383420e249459b24b7cb189b40bc",
          "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
          "streamOwnerAuthorizer" : false,
          "ksmlEnabled" : false,
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "name" : "tenantaApplication1",
          "shortName" : "tenanta_app1",
          "description" : "tenantaApplication1 description.",
          "applicationType" : "Custom",
          "type" : "Java",
          "applicationClass" : null,
          "visibility" : "public",
          "owners" : {
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "phoneNumber" : null,
            "properties" : { },
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null,
            "_embedded" : {
              "members" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "appOwner",
                "lastName" : "TenantA",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "appowner@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "51234a7a81994d1ca35ca7894cde08c6"
              } ]
            },
            "_links" : {
              "self" : {
                "href" : "...",
                "title" : "URI pointing to current request"
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ]
            }
          },
          "properties" : { },
          "uid" : "5ffc4240fcdf4a479a16f2b0b12ab909",
          "kafkaStreamsBased" : false,
          "connector" : false,
          "axualManagedKsml" : false,
          "kafkaStreams" : false,
          "customKsml" : false,
          "allApplicationIds" : [ "nl.tenanta.new.app1", "nl.tenanta.app1" ],
          "ableToGenerateSchemaRegistryPassword" : false,
          "ableToResetOffsets" : true,
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null,
          "applicationId" : "nl.tenanta.app1,nl.tenanta.new.app1"
        },
        "stream" : {
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "name" : "tenanta-stream1",
          "description" : "description_tenanta-stream1",
          "keyType" : "AVRO",
          "valueType" : "AVRO",
          "retentionPolicy" : "delete",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "appConfigured" : false,
      "streamConfigured" : false,
      "status" : "Pending",
      "requestedByUser" : {
        "firstName" : "streamOwner",
        "lastName" : "TenantA",
        "middleName" : null,
        "emailAddress" : {
          "email" : "streamowner@tenanta.nl"
        },
        "phoneNumber" : null,
        "roles" : [ ],
        "settings" : { },
        "fullName" : "streamOwner TenantA",
        "uid" : "1ecbda9a995f4ab2a4c95716087b21c8",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "processedByUser" : null,
      "processedAt" : "2018-06-09T13:16:00",
      "requestedAt" : "2018-09-09T13:16:00",
      "_links" : {
        "approve" : {
          "href" : "..."
        },
        "deny" : {
          "href" : "..."
        }
      }
    }, {
      "accessType" : "PRODUCER",
      "uid" : "dd24e0110f7b45ec98d62f6ff8136ae7",
      "comment" : null,
      "_embedded" : {
        "environment" : {
          "properties" : { },
          "name" : "tenantaenv1",
          "shortName" : "tenantaenv1",
          "description" : "environment",
          "color" : "#80affe",
          "authorizationIssuer" : "Stream owner",
          "visibility" : "public",
          "retentionTime" : 604800000,
          "partitions" : 12,
          "settings" : { },
          "private" : false,
          "autoApproved" : false,
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
          "streamOwnerAuthorizer" : true,
          "ksmlEnabled" : false,
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "name" : "tenantaApplication5",
          "shortName" : "tenanta_app5",
          "description" : "",
          "applicationType" : "Custom",
          "type" : "Java",
          "applicationClass" : null,
          "visibility" : "public",
          "owners" : {
            "name" : "Team App Admins",
            "emailAddress" : null,
            "phoneNumber" : null,
            "properties" : { },
            "uid" : "514d4oit834841869644c2ad8b439997",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null,
            "_embedded" : {
              "members" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "appAuthor",
                "lastName" : "TenantA",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "appauthor@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "e235c8fe4264431bbdb3b40a2e5f8f62"
              }, {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "tenAdmin",
                "lastName" : "TenantActive",
                "middleName" : "middleName",
                "emailAddress" : {
                  "email" : "tenadmin@tenantactive.nl"
                },
                "phoneNumber" : null,
                "uid" : "s39sef147df84179a151bdc21f5bb813"
              }, {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "firstNameTest",
                "lastName" : "lastNameTest",
                "middleName" : "van der",
                "emailAddress" : {
                  "email" : "testuser@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
              }, {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "powerUser",
                "lastName" : "powerUser",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "poweruser@tenantactive.nl"
                },
                "phoneNumber" : null,
                "uid" : "avcdfr5c6d9e424ab1a9d9f767fc7cfd"
              }, {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "appAdmin",
                "lastName" : "TenantA",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "appadmin@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "caa51002633244ffbe36f4ccf8a8f501"
              } ],
              "resourceManagers" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "powerUser",
                "lastName" : "powerUser",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "poweruser@tenantactive.nl"
                },
                "phoneNumber" : null,
                "uid" : "avcdfr5c6d9e424ab1a9d9f767fc7cfd"
              } ],
              "managers" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "firstNameTest",
                "lastName" : "lastNameTest",
                "middleName" : "van der",
                "emailAddress" : {
                  "email" : "testuser@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "1759cc36cacd4df38ed1b0336e22e06d"
              } ]
            },
            "_links" : {
              "self" : {
                "href" : "...",
                "title" : "URI pointing to current request"
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              }, {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              }, {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              }, {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              }, {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              }
            }
          },
          "properties" : { },
          "uid" : "fdc9e4570f1c4866bef77722e2830d5g",
          "kafkaStreamsBased" : false,
          "connector" : false,
          "axualManagedKsml" : false,
          "kafkaStreams" : false,
          "customKsml" : false,
          "allApplicationIds" : [ "nl.tenanta.app5" ],
          "ableToGenerateSchemaRegistryPassword" : false,
          "ableToResetOffsets" : true,
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null,
          "applicationId" : "nl.tenanta.app5"
        },
        "stream" : {
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "name" : "tenanta-stream1",
          "description" : "description_tenanta-stream1",
          "keyType" : "AVRO",
          "valueType" : "AVRO",
          "retentionPolicy" : "delete",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "appConfigured" : true,
      "streamConfigured" : true,
      "status" : "Rejected",
      "requestedByUser" : null,
      "processedByUser" : null,
      "processedAt" : "2018-06-10T13:16:00",
      "requestedAt" : "2018-06-07T13:16:00"
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    }
  },
  "page" : {
    "size" : 5,
    "totalElements" : 7,
    "totalPages" : 2,
    "number" : 0
  }
}
Searching grants in your team grants

In order to search for grant that belongs to your team, set myTeams to true.

Query parameters
Parameter Description

myTeams

If the property is set to true returns the grants owned by the user’s team.
HTTP request
GET /application_access_grants/search/findByAttributes?myTeams=true HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 24163

{
  "_embedded" : {
    "applicationAccessGrantResponses" : [ {
      "accessType" : "CONSUMER",
      "uid" : "420ly0dy72gi123r2m2n56m93ht25wy9",
      "comment" : null,
      "_embedded" : {
        "environment" : {
          "properties" : { },
          "name" : "tenantaprivenv5",
          "shortName" : "tenantaprivenv5",
          "description" : "environment",
          "color" : "#80affe",
          "authorizationIssuer" : "Auto",
          "visibility" : "private",
          "retentionTime" : 604800000,
          "partitions" : 12,
          "settings" : { },
          "private" : true,
          "autoApproved" : true,
          "uid" : "6u2577bclboz97ievex0fv5hvysemooh",
          "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
          "streamOwnerAuthorizer" : false,
          "ksmlEnabled" : false,
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "name" : "testRevoke",
          "shortName" : "test_revoke",
          "description" : "",
          "applicationType" : "Custom",
          "type" : "Java",
          "applicationClass" : null,
          "visibility" : "private",
          "owners" : {
            "name" : "Team Kad",
            "emailAddress" : null,
            "phoneNumber" : null,
            "properties" : { },
            "uid" : "514d4e9a834841869644c2ad8b439553",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null,
            "_embedded" : {
              "members" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "kad",
                "lastName" : "member",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "kadmember@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "007b994a6ab34165a93fd4c7a8db1388"
              }, {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "strAdmin",
                "lastName" : "TenantA",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "stradmin@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "a0018341100c431d8a8117be2ad12d8a"
              }, {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "group",
                "lastName" : "manager",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "groupmanager@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "465a7a8db09a6ab3419913883fd4c07b"
              } ],
              "resourceManagers" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "group",
                "lastName" : "manager",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "groupmanager@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "465a7a8db09a6ab3419913883fd4c07b"
              } ],
              "managers" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "group",
                "lastName" : "manager",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "groupmanager@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "465a7a8db09a6ab3419913883fd4c07b"
              } ]
            },
            "_links" : {
              "self" : {
                "href" : "...",
                "title" : "URI pointing to current request"
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              }, {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              }, {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              }
            }
          },
          "properties" : { },
          "uid" : "39d82d7994484b53ae1de37ee8924512",
          "kafkaStreamsBased" : false,
          "connector" : false,
          "axualManagedKsml" : false,
          "kafkaStreams" : false,
          "customKsml" : false,
          "allApplicationIds" : [ "nl.tenanta.app.revoke" ],
          "ableToGenerateSchemaRegistryPassword" : false,
          "ableToResetOffsets" : true,
          "created_at" : "2020-11-01T23:16:23",
          "modified_at" : "2020-11-01T23:16:23",
          "created_by" : null,
          "modified_by" : null,
          "applicationId" : "nl.tenanta.app.revoke"
        },
        "stream" : {
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "name" : "tenanta-stream1",
          "description" : "description_tenanta-stream1",
          "keyType" : "AVRO",
          "valueType" : "AVRO",
          "retentionPolicy" : "delete",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "appConfigured" : false,
      "streamConfigured" : false,
      "status" : "Approved",
      "requestedByUser" : null,
      "processedByUser" : null,
      "processedAt" : "2018-06-14T13:16:00",
      "requestedAt" : "2018-06-07T13:16:00",
      "_links" : {
        "revoke" : {
          "href" : "..."
        }
      }
    }, {
      "accessType" : "CONSUMER",
      "uid" : "785f2bdf733d4c68a73ccdbdbd359b26",
      "comment" : null,
      "_embedded" : {
        "environment" : {
          "properties" : { },
          "name" : "tenantaenv9_with_revoked_app_access_only",
          "shortName" : "tenantaenv9",
          "description" : "environment with just revoked app_access configured",
          "color" : "#80affe",
          "authorizationIssuer" : "Auto",
          "visibility" : "public",
          "retentionTime" : 604800000,
          "partitions" : 12,
          "settings" : { },
          "private" : false,
          "autoApproved" : true,
          "uid" : "3b7963da58d7445bbf7a900782713069",
          "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
          "streamOwnerAuthorizer" : false,
          "ksmlEnabled" : false,
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "name" : "publicEnvRevoke",
          "shortName" : "tenanta_revoke_public",
          "description" : "",
          "applicationType" : "Custom",
          "type" : "Java",
          "applicationClass" : null,
          "visibility" : "private",
          "owners" : {
            "name" : "Team Kad",
            "emailAddress" : null,
            "phoneNumber" : null,
            "properties" : { },
            "uid" : "514d4e9a834841869644c2ad8b439553",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null,
            "_embedded" : {
              "members" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "kad",
                "lastName" : "member",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "kadmember@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "007b994a6ab34165a93fd4c7a8db1388"
              }, {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "strAdmin",
                "lastName" : "TenantA",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "stradmin@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "a0018341100c431d8a8117be2ad12d8a"
              }, {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "group",
                "lastName" : "manager",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "groupmanager@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "465a7a8db09a6ab3419913883fd4c07b"
              } ],
              "resourceManagers" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "group",
                "lastName" : "manager",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "groupmanager@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "465a7a8db09a6ab3419913883fd4c07b"
              } ],
              "managers" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "group",
                "lastName" : "manager",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "groupmanager@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "465a7a8db09a6ab3419913883fd4c07b"
              } ]
            },
            "_links" : {
              "self" : {
                "href" : "...",
                "title" : "URI pointing to current request"
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              }, {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              }, {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              }
            }
          },
          "properties" : { },
          "uid" : "68e4d4e2e3e54ddc836006655d42a995",
          "kafkaStreamsBased" : false,
          "connector" : false,
          "axualManagedKsml" : false,
          "kafkaStreams" : false,
          "customKsml" : false,
          "allApplicationIds" : [ "nl.tenanta.app.revoke.public.env" ],
          "ableToGenerateSchemaRegistryPassword" : false,
          "ableToResetOffsets" : true,
          "created_at" : "2020-11-01T23:16:23",
          "modified_at" : "2020-11-01T23:16:23",
          "created_by" : null,
          "modified_by" : null,
          "applicationId" : "nl.tenanta.app.revoke.public.env"
        },
        "stream" : {
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "name" : "tenanta-stream1",
          "description" : "description_tenanta-stream1",
          "keyType" : "AVRO",
          "valueType" : "AVRO",
          "retentionPolicy" : "delete",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "appConfigured" : false,
      "streamConfigured" : true,
      "status" : "Revoked",
      "requestedByUser" : null,
      "processedByUser" : null,
      "processedAt" : "2018-06-21T13:16:00",
      "requestedAt" : "2018-06-07T13:16:00"
    }, {
      "accessType" : "PRODUCER",
      "uid" : "54d965d723d640b5a56caf285f596f9b",
      "comment" : null,
      "_embedded" : {
        "environment" : {
          "properties" : { },
          "name" : "tenantaenv9_with_revoked_app_access_only",
          "shortName" : "tenantaenv9",
          "description" : "environment with just revoked app_access configured",
          "color" : "#80affe",
          "authorizationIssuer" : "Auto",
          "visibility" : "public",
          "retentionTime" : 604800000,
          "partitions" : 12,
          "settings" : { },
          "private" : false,
          "autoApproved" : true,
          "uid" : "3b7963da58d7445bbf7a900782713069",
          "apicurioKeycloakEnabledForAnyInstanceCluster" : false,
          "streamOwnerAuthorizer" : false,
          "ksmlEnabled" : false,
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "application" : {
          "name" : "publicEnvRevoke",
          "shortName" : "tenanta_revoke_public",
          "description" : "",
          "applicationType" : "Custom",
          "type" : "Java",
          "applicationClass" : null,
          "visibility" : "private",
          "owners" : {
            "name" : "Team Kad",
            "emailAddress" : null,
            "phoneNumber" : null,
            "properties" : { },
            "uid" : "514d4e9a834841869644c2ad8b439553",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null,
            "_embedded" : {
              "members" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "kad",
                "lastName" : "member",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "kadmember@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "007b994a6ab34165a93fd4c7a8db1388"
              }, {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "strAdmin",
                "lastName" : "TenantA",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "stradmin@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "a0018341100c431d8a8117be2ad12d8a"
              }, {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "group",
                "lastName" : "manager",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "groupmanager@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "465a7a8db09a6ab3419913883fd4c07b"
              } ],
              "resourceManagers" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "group",
                "lastName" : "manager",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "groupmanager@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "465a7a8db09a6ab3419913883fd4c07b"
              } ],
              "managers" : [ {
                "_links" : {
                  "tenant" : {
                    "href" : "...",
                    "title" : "A tenant"
                  },
                  "self" : {
                    "href" : "...",
                    "templated" : true,
                    "title" : "URI pointing to current request"
                  }
                },
                "settings" : { },
                "firstName" : "group",
                "lastName" : "manager",
                "middleName" : null,
                "emailAddress" : {
                  "email" : "groupmanager@tenanta.nl"
                },
                "phoneNumber" : null,
                "uid" : "465a7a8db09a6ab3419913883fd4c07b"
              } ]
            },
            "_links" : {
              "self" : {
                "href" : "...",
                "title" : "URI pointing to current request"
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              }, {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              }, {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              }
            }
          },
          "properties" : { },
          "uid" : "68e4d4e2e3e54ddc836006655d42a995",
          "kafkaStreamsBased" : false,
          "connector" : false,
          "axualManagedKsml" : false,
          "kafkaStreams" : false,
          "customKsml" : false,
          "allApplicationIds" : [ "nl.tenanta.app.revoke.public.env" ],
          "ableToGenerateSchemaRegistryPassword" : false,
          "ableToResetOffsets" : true,
          "created_at" : "2020-11-01T23:16:23",
          "modified_at" : "2020-11-01T23:16:23",
          "created_by" : null,
          "modified_by" : null,
          "applicationId" : "nl.tenanta.app.revoke.public.env"
        },
        "stream" : {
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "name" : "tenanta-stream1",
          "description" : "description_tenanta-stream1",
          "keyType" : "AVRO",
          "valueType" : "AVRO",
          "retentionPolicy" : "delete",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        }
      },
      "appConfigured" : false,
      "streamConfigured" : true,
      "status" : "Revoked",
      "requestedByUser" : null,
      "processedByUser" : null,
      "processedAt" : "2018-06-22T13:16:00",
      "requestedAt" : "2018-06-07T13:16:00"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

34. ApplicationDeployments

An ApplicationDeployment stores the configs for complex application types like connector that is saved for an Application on an Environment.

The /application_deployments resource is used to create, update, delete, and list application deployments.

34.1. List all application deployments

HTTP method GET is disabled for /application_deployments. Refer to search endpoints to find one or more ApplicationDeployment for an Application or an Environment.

34.2. Create Application deployment

A POST request is used to create a new ApplicationDeployment. The request should include reference to a valid existing application and environment.

A POST request to create an Application deployment for a Connector Application

34.2.1. Request fields

Path Type Description Constraints

configs

Object

Configs for an Application Deployment belongs to a Connector application

environment

String

A valid URI of an existing Environment

application

String

A valid URI of an existing Application

34.2.2. Curl request

$ curl 'http://api.example.com/application_deployments' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "configs" : {
    "configKey" : "configValue",
    "key.converter" : null,
    "tasks.max" : null
  },
  "application" : "http://api.example.com/applications/lmk9f4670h1c4866deg78722e2931e5g",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
}'

34.2.3. HTTP request

POST /application_deployments HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 287
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "configs" : {
    "configKey" : "configValue",
    "key.converter" : null,
    "tasks.max" : null
  },
  "application" : "http://api.example.com/applications/lmk9f4670h1c4866deg78722e2931e5g",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
}

34.2.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://api.example.com/application_deployments/7689463f2c3e41088d5826e1599498be

A POST request to create an Application deployment for a KSML Application with Standard Yaml format

34.2.5. Request fields

Path Type Description Constraints

configs

Object

Configs for an Application Deployment belongs to a KSML application. Providing the KSML_DEFINITION key and corresponding value in standard or minified yaml format is mandatory.

environment

String

A valid URI of an existing Environment

application

String

A valid URI of an existing Application

34.2.6. Curl request

$ curl 'http://api.example.com/application_deployments' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "configs" : {
    "ksml_definition" : "streams:\n  sensor_source_avro:\n    topic: ksml_sensordata_avro\n    keyType: string\n    valueType: 'avro:SensorData'\nfunctions:\n  # This function print each message\n  print_message:\n    type: forEach\n    code: | \n      print('key=' + str(key) + ', value=' + str(value))\npipelines:\n  consume_avro:\n    from: sensor_source_avro\n    forEach: print_message"
  },
  "application" : "http://api.example.com/applications/KSML-app18-ID-000000000000000000",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
}'

34.2.7. HTTP request

POST /application_deployments HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 595
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "configs" : {
    "ksml_definition" : "streams:\n  sensor_source_avro:\n    topic: ksml_sensordata_avro\n    keyType: string\n    valueType: 'avro:SensorData'\nfunctions:\n  # This function print each message\n  print_message:\n    type: forEach\n    code: | \n      print('key=' + str(key) + ', value=' + str(value))\npipelines:\n  consume_avro:\n    from: sensor_source_avro\n    forEach: print_message"
  },
  "application" : "http://api.example.com/applications/KSML-app18-ID-000000000000000000",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
}

34.2.8. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://api.example.com/application_deployments/39931614298d4a5d912699f0470676fe

A POST request to create an Application deployment for a KSML Application with Minified Yaml format

34.2.9. Request fields

Path Type Description Constraints

configs

Object

Configs for an Application Deployment belongs to a KSML application. Providing the KSML_DEFINITION key and corresponding value in standard or minified yaml format is mandatory.

environment

String

A valid URI of an existing Environment

application

String

A valid URI of an existing Application

34.2.10. Curl request

$ curl 'http://api.example.com/application_deployments' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "configs" : {
    "ksml_definition" : "{streams: {sensor_source_avro: {topic: ksml_sensordata_avro, keyType: string, valueType: 'avro:SensorData'}}, functions: {print_message: {type: forEach, code: \"print('key=' + str(key) + ', value=' + str(value))\\n\"}}, pipelines: {consume_avro: {from: sensor_source_avro, forEach: print_message}}}"
  },
  "application" : "http://api.example.com/applications/fe3234224b974292em07fe9dd80fe1fe",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
}'

34.2.11. HTTP request

POST /application_deployments HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 528
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "configs" : {
    "ksml_definition" : "{streams: {sensor_source_avro: {topic: ksml_sensordata_avro, keyType: string, valueType: 'avro:SensorData'}}, functions: {print_message: {type: forEach, code: \"print('key=' + str(key) + ', value=' + str(value))\\n\"}}, pipelines: {consume_avro: {from: sensor_source_avro, forEach: print_message}}}"
  },
  "application" : "http://api.example.com/applications/fe3234224b974292em07fe9dd80fe1fe",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52"
}

34.2.12. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://api.example.com/application_deployments/7c5d56967f3847798b66eafadeccdb1e

34.3. Retrieve application deployment

The application_deployments/{id} resource is used to retrieve a single deployment of an application for an environment.

A GET request will retrieve the details of a ApplicationDeployment for a Connector application.

34.3.1. HTTP request

GET /application_deployments/1e9ee6ce053c46b0932358c7403a56fd HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

34.3.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 4728

{
  "configs" : [ {
    "configKey" : "logger.name",
    "configValue" : "axual-logger",
    "ksmlDefinition" : false
  }, {
    "configKey" : "name",
    "configValue" : "Axual Logger",
    "ksmlDefinition" : false
  }, {
    "configKey" : "customeKey",
    "configValue" : "Custom Value",
    "ksmlDefinition" : false
  }, {
    "configKey" : "connector.class",
    "configValue" : "io.axual.connector",
    "ksmlDefinition" : false
  } ],
  "state" : "Undeployed",
  "uid" : "1e9ee6ce053c46b0932358c7403a56fd",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "application" : {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication6",
      "type" : "SINK",
      "applicationClass" : "io.axual.test.sink.plugin",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.app6",
      "applicationType" : "Connector",
      "shortName" : "tenanta_app6",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.app6" ],
      "description" : "",
      "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "environment" : {
      "_links" : {
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "applicationDeployment" : {
      "href" : "..."
    },
    "start" : {
      "href" : "..."
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "environment" : {
      "href" : "...",
      "templated" : true,
      "title" : "An environment"
    }
  }
}
Relation Description

start

Existence of this link indicates that the currently authenticated user can start this Application

A GET request will retrieve the details of a ApplicationDeployment for a KSML application.

34.3.4. HTTP request

GET /application_deployments/KSML-app18-deployment-0000000000 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

34.3.5. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Tue, 06 Sep 2022 10:00:00 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 4743

{
  "configs" : [ {
    "configKey" : "ksml_definition",
    "configValue" : "{streams: {sensor_source_avro: {topic: ksml_sensordata_avro, keyType: string, valueType: 'avro:SensorData'}}, functions: {print_message: {type: forEach, code: \"print('key=' + str(key) + ', value=' + str(value))\n\"}}, pipelines: {consume_avro: {from: sensor_source_avro, forEach: print_message}}}",
    "ksmlDefinition" : true
  } ],
  "state" : "Undeployed",
  "uid" : "KSML-app18-deployment-0000000000",
  "created_at" : "2022-09-06T10:00:00",
  "modified_at" : "2022-09-06T10:00:00",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "application" : {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaApplication18",
      "type" : null,
      "applicationClass" : null,
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "applicationId" : "nl.tenanta.ksml.app18",
      "applicationType" : "Ksml",
      "shortName" : "tenanta_app18_ksml",
      "visibility" : "public",
      "applicationIds" : [ "nl.tenanta.ksml.app18" ],
      "description" : "A KSML Application",
      "uid" : "KSML-app18-ID-000000000000000000",
      "created_at" : "2024-05-14T00:00:00",
      "modified_at" : "2024-05-14T00:00:00",
      "created_by" : null,
      "modified_by" : null
    },
    "environment" : {
      "_links" : {
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv_with_ksml",
      "owners" : {
        "_links" : {
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenvks",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "single cluster environment for ksml",
      "uid" : "ENV-tenanta-public-single-clustr",
      "created_at" : "2024-06-07T23:16:23",
      "modified_at" : "2024-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "applicationDeployment" : {
      "href" : "..."
    },
    "start" : {
      "href" : "..."
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "application" : {
      "href" : "...",
      "templated" : true,
      "title" : "An application"
    },
    "environment" : {
      "href" : "...",
      "templated" : true,
      "title" : "An environment"
    }
  }
}
Relation Description

start

Existence of this link indicates that the currently authenticated user can start this Application

34.4. Restart connector’s task

The application_deployments/{id}/task/{taskId}/operation resource is used to restart connector task.

A GET request will restart the connector task using taskId.

Parameter Description

action

A valid action to perform on the deployment

 
PUT /application_deployments/a5053c46b09c583g9ff678f323ce403f/task/2/operation?action=RESTART_TASK HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Type: application/x-www-form-urlencoded
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

34.5. Retrieve connector config from application deployment

The application_deployments/{id}/config resource is used to retrieve a configured connector config.

A GET request will retrieve the details of a ApplicationDeployment Connector Config.

When application_deployment gets a new plugin class after Axual Connect upgrade, the API provides information on which plugin config is unsupported or added. Each plugin config is marked as Unsupported, New or Custom and the fields unsupported PluginConfigFound and newPluginConfigFound will return true accordingly to signify that the deployment config has to be reviewed.

Any property which is not part of the default connector configuration will be marked as Custom.

34.5.1. HTTP request

GET /application_deployments/1e9ee6ce053c46b0932358c7403a56fd/config HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/json
Host: api.example.com

34.5.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 2459

{
  "pluginConfigs" : [ {
    "name" : "key.converter",
    "type" : "CLASS",
    "required" : true,
    "defaultValue" : null,
    "providedValue" : null,
    "importance" : "LOW",
    "documentation" : null,
    "pluginConfigState" : "New",
    "group" : "group1"
  }, {
    "name" : "connector.class",
    "type" : "STRING",
    "required" : true,
    "defaultValue" : null,
    "providedValue" : "io.axual.connector",
    "importance" : "HIGH",
    "documentation" : "Name or alias of the class for this connector. Must be a subclass of org.apache.kafka.connect.connector.Connector. If the connector is org.apache.kafka.connect.file.FileStreamSinkConnector, you can either specify this full name,  or use \"FileStreamSink\" or \"FileStreamSinkConnector\" to make the configuration a bit shorter",
    "pluginConfigState" : "Existing",
    "group" : "group1"
  }, {
    "name" : "name",
    "type" : "STRING",
    "required" : true,
    "defaultValue" : null,
    "providedValue" : "Axual Logger",
    "importance" : "HIGH",
    "documentation" : "Globally unique name to use for this connector.",
    "pluginConfigState" : "Existing",
    "group" : "group2"
  }, {
    "name" : "customeKey",
    "type" : null,
    "required" : false,
    "defaultValue" : null,
    "providedValue" : "Custom Value",
    "importance" : null,
    "documentation" : null,
    "pluginConfigState" : "Custom",
    "group" : ""
  }, {
    "name" : "logger.name",
    "type" : "STRING",
    "required" : true,
    "defaultValue" : null,
    "providedValue" : "axual-logger",
    "importance" : "HIGH",
    "documentation" : "The name of the SLF4J Logger to write the messages",
    "pluginConfigState" : "Existing",
    "group" : "group2"
  }, {
    "name" : "tasks.max",
    "type" : "INT",
    "required" : true,
    "defaultValue" : null,
    "providedValue" : null,
    "importance" : "LOW",
    "documentation" : null,
    "pluginConfigState" : "New",
    "group" : "group3"
  }, {
    "name" : "transforms",
    "type" : "LIST",
    "required" : true,
    "defaultValue" : "",
    "providedValue" : "",
    "importance" : "LOW",
    "documentation" : "Aliases for the transformations to be applied to records.",
    "pluginConfigState" : "New",
    "group" : "group1"
  } ],
  "unsupportedPluginConfigFound" : false,
  "newMandatoryPluginConfigFound" : true,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

34.6. Update application deployment

A PUT request is used to update a ApplicationDeployment. Only configs field can be modified. If application or environment needs to be updated, delete the ApplicationDeployment and create a new one.

$ curl 'http://api.example.com/application_deployments/1e9ee6ce053c46b0932358c7403a56fd' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "configs" : {
    "key" : "value"
  }
}'
PUT /application_deployments/1e9ee6ce053c46b0932358c7403a56fd HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 43
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "configs" : {
    "key" : "value"
  }
}
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

34.7. Delete application deployment

A DELETE request is used to delete an ApplicationDeployment.

$ curl 'http://api.example.com/application_deployments/3g9ff6ce053c46b0932358c7403a58ff' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
DELETE /application_deployments/3g9ff6ce053c46b0932358c7403a58ff HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

34.8. ApplicationDeployments search endpoints

34.8.1. /application_deployments/search/findByApplicationAndEnvironment

Returns application deployments for given Application and Environment.

Parameter Description

application

A valid URI of an existing Application

environment

A valid URI of an existing Environment

 
GET /application_deployments/search/findByApplicationAndEnvironment?application=http%3A%2F%2Flocalhost%2Fapplications%2Fdbc9e4670h1c4866deg78722e2930d2g&environment=http%3A%2F%2Flocalhost%2Fenvironments%2F047ab08009fe4da8be6905b55552ab52 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 5599

{
  "_embedded" : {
    "application_deployments" : [ {
      "configs" : [ {
        "configKey" : "logger.name",
        "configValue" : "axual-logger",
        "ksmlDefinition" : false
      }, {
        "configKey" : "name",
        "configValue" : "Axual Logger",
        "ksmlDefinition" : false
      }, {
        "configKey" : "customeKey",
        "configValue" : "Custom Value",
        "ksmlDefinition" : false
      }, {
        "configKey" : "connector.class",
        "configValue" : "io.axual.connector",
        "ksmlDefinition" : false
      } ],
      "state" : "Undeployed",
      "uid" : "1e9ee6ce053c46b0932358c7403a56fd",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "application" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaApplication6",
          "type" : "SINK",
          "applicationClass" : "io.axual.test.sink.plugin",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Application-tenAApplication1",
            "emailAddress" : null,
            "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "applicationId" : "nl.tenanta.app6",
          "applicationType" : "Connector",
          "shortName" : "tenanta_app6",
          "visibility" : "public",
          "applicationIds" : [ "nl.tenanta.app6" ],
          "description" : "",
          "uid" : "dbc9e4670h1c4866deg78722e2930d2g",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        },
        "environment" : {
          "_links" : {
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "applicationDeployment" : {
          "href" : "..."
        },
        "start" : {
          "href" : "..."
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "application" : {
          "href" : "...",
          "templated" : true,
          "title" : "An application"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

34.9. ApplicationDeployments Perform action

34.9.1. /application_deployments/operation

Perform an action for an application deployment : The valid actions are: START, STOP, RESET, DELETE.

Parameter Description

action

A valid action to perform on the deployment

 
PUT /application_deployments/1e9ee6ce053c46b0932358c7403a56fd/operation?action=START HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

34.10. ApplicationDeployments Get status

34.11. Connector deployments

34.11.1. /application_deployments/{uid}/status

Returns the real time status of the application_deployment, along with the status for the tasks associated to the application_deployment.

$ curl 'http://api.example.com/application_deployments/1e9ee6ce053c46b0932358c7403a56fd/status' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /application_deployments/1e9ee6ce053c46b0932358c7403a56fd/status HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 367

{
  "connectorState" : {
    "state" : "Undefined",
    "workerId" : null,
    "trace" : null
  },
  "taskStates" : null,
  "_links" : {
    "status" : {
      "href" : "..."
    },
    "logs" : {
      "href" : "..."
    },
    "start" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

34.12. KSML deployments

34.12.1. /application_deployments/{uid}/status

Returns the status of the application_deployment. Application deployment for KSML has following states:

  • Undeployed (with no other data)

  • Starting (app is being created)

  • Started (app is running)

  • Failed (app fails to start)

$ curl 'http://api.example.com/application_deployments/KSML-app18-deployment-0000000000/status' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /application_deployments/KSML-app18-deployment-0000000000/status HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 411

{
  "ksmlStatus" : {
    "status" : "Started",
    "replicas" : 1,
    "readyReplicas" : 1,
    "appVersion" : "0.1.0",
    "deployedAt" : "2024-03-18T21:57:36Z"
  },
  "_links" : {
    "status" : {
      "href" : "..."
    },
    "logs" : {
      "href" : "..."
    },
    "stop" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

34.13. ApplicationDeployments View logs

34.14. KSML deployments

34.14.1. /application_deployments/{uid}/logs

Returns the logs of the application_deployment per replica of deployed app. Log lines are separated with '\n`

$ curl 'http://api.example.com/application_deployments/KSML-app18-deployment-0000000000/logs?tailLines=10' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /application_deployments/KSML-app18-deployment-0000000000/logs?tailLines=10 HTTP/1.1
Content-Type: application/json
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 4463

{
  "ksml" : {
    "logs" : [ {
      "replicaName" : "id1",
      "logs" : "2024-07-29T11:42:35,284Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Message: key=sensor4, value=SensorData: {\"city\":\"Leiden\", \"color\":\"yellow\", \"name\":\"sensor4\", \"owner\":\"Evan\", \"timestamp\":1722253355283, \"type\":\"AREA\", \"unit\":\"m2\", \"value\":\"272\"}\n2024-07-29T11:42:35,288Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Produced message to ksml_sensordata_avro, partition 0, offset 1224\n2024-07-29T11:42:35,727Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Message: key=sensor5, value=SensorData: {\"city\":\"Amsterdam\", \"color\":\"yellow\", \"name\":\"sensor5\", \"owner\":\"Alice\", \"timestamp\":1722253355727, \"type\":\"HUMIDITY\", \"unit\":\"%\", \"value\":\"43\"}\n2024-07-29T11:42:35,731Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Produced message to ksml_sensordata_avro, partition 0, offset 1225\n2024-07-29T11:42:36,172Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Message: key=sensor6, value=SensorData: {\"city\":\"Utrecht\", \"color\":\"yellow\", \"name\":\"sensor6\", \"owner\":\"Bob\", \"timestamp\":1722253356172, \"type\":\"STATE\", \"unit\":\"state\", \"value\":\"on\"}\n2024-07-29T11:42:36,177Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Produced message to ksml_sensordata_avro, partition 0, offset 1226\n2024-07-29T11:42:36,616Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Message: key=sensor7, value=SensorData: {\"city\":\"Amsterdam\", \"color\":\"blue\", \"name\":\"sensor7\", \"owner\":\"Charlie\", \"timestamp\":1722253356615, \"type\":\"STATE\", \"unit\":\"state\", \"value\":\"off\"}\n2024-07-29T11:42:36,620Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Produced message to ksml_sensordata_avro, partition 0, offset 1227\n2024-07-29T11:42:37,059Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Message: key=sensor8, value=null: null\n2024-07-29T11:42:37,064Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Produced message to ksml_sensordata_avro, partition 0, offset 1228\n"
    }, {
      "replicaName" : "id2",
      "logs" : "2024-07-29T11:42:35,284Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Message: key=sensor4, value=SensorData: {\"city\":\"Leiden\", \"color\":\"yellow\", \"name\":\"sensor4\", \"owner\":\"Evan\", \"timestamp\":1722253355283, \"type\":\"AREA\", \"unit\":\"m2\", \"value\":\"272\"}\n2024-07-29T11:42:35,288Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Produced message to ksml_sensordata_avro, partition 0, offset 1224\n2024-07-29T11:42:35,727Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Message: key=sensor5, value=SensorData: {\"city\":\"Amsterdam\", \"color\":\"yellow\", \"name\":\"sensor5\", \"owner\":\"Alice\", \"timestamp\":1722253355727, \"type\":\"HUMIDITY\", \"unit\":\"%\", \"value\":\"43\"}\n2024-07-29T11:42:35,731Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Produced message to ksml_sensordata_avro, partition 0, offset 1225\n2024-07-29T11:42:36,172Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Message: key=sensor6, value=SensorData: {\"city\":\"Utrecht\", \"color\":\"yellow\", \"name\":\"sensor6\", \"owner\":\"Bob\", \"timestamp\":1722253356172, \"type\":\"STATE\", \"unit\":\"state\", \"value\":\"on\"}\n2024-07-29T11:42:36,177Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Produced message to ksml_sensordata_avro, partition 0, offset 1226\n2024-07-29T11:42:36,616Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Message: key=sensor7, value=SensorData: {\"city\":\"Amsterdam\", \"color\":\"blue\", \"name\":\"sensor7\", \"owner\":\"Charlie\", \"timestamp\":1722253356615, \"type\":\"STATE\", \"unit\":\"state\", \"value\":\"off\"}\n2024-07-29T11:42:36,620Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Produced message to ksml_sensordata_avro, partition 0, offset 1227\n2024-07-29T11:42:37,059Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Message: key=sensor8, value=null: null\n2024-07-29T11:42:37,064Z [pool-1-thread-1] INFO  i.a.k.r.backend.ExecutableProducer - Produced message to ksml_sensordata_avro, partition 0, offset 1228\n"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

35. Streams

A Stream is a continuous flow of similar events (messages) grouped together under a single identity.

The streams resource is used to create and list Streams.

35.1. Stream Schema

The streams resource uses the following json-schema:

GET /profile/streams HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 2581

{
  "title" : "Stream",
  "definitions" : { },
  "properties" : {
    "confidentiality" : {
      "title" : "Confidentiality",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "description" : {
      "title" : "Description",
      "readOnly" : false,
      "type" : "string"
    },
    "keySchema" : {
      "title" : "Key schema",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "owners" : {
      "title" : "Owners",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "tags" : {
      "title" : "Tags",
      "readOnly" : false,
      "type" : "array",
      "uniqueItems" : true,
      "items" : {
        "type" : "string"
      }
    },
    "valueSchema" : {
      "title" : "Value schema",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "integrity" : {
      "title" : "Integrity",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "viewers" : {
      "title" : "Viewers",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "valueType" : {
      "title" : "Value type",
      "readOnly" : false,
      "type" : "string",
      "enum" : [ "AVRO", "JSON", "JSON_SCHEMA", "String", "Binary", "Xml", "PROTOBUF" ]
    },
    "name" : {
      "title" : "Name",
      "readOnly" : false,
      "type" : "string"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "retentionPolicy" : {
      "title" : "Retention policy",
      "readOnly" : false,
      "type" : "string",
      "enum" : [ "Delete", "Compact", "Compact and delete" ]
    },
    "keyType" : {
      "title" : "Key type",
      "readOnly" : false,
      "type" : "string",
      "enum" : [ "AVRO", "JSON", "JSON_SCHEMA", "String", "Binary", "Xml", "PROTOBUF" ]
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "properties" : {
      "title" : "Properties",
      "readOnly" : true,
      "type" : "object"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

35.2. List all streams

A GET request will list all the Streams visible to the currently logged in user.

35.2.1. Curl request

$ curl 'http://api.example.com/streams' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

35.2.2. HTTP request

GET /streams HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

35.2.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 49131

{
  "_embedded" : {
    "streams" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream1",
      "properties" : {
        "key-1" : "696969",
        "key-3" : "696969",
        "key-2" : "60000"
      },
      "tags" : [ "TAG1", "tAg2", "avro" ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "066f5944d16344f88c9214d240d139dc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream-string-avro",
      "properties" : { },
      "tags" : [ "tag" ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream-string-avro",
      "uid" : "066f5944d16944f88c91e4d240d139dc",
      "created_at" : "2022-06-07T23:16:23",
      "modified_at" : "2022-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream-avro-string",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream-avro-string",
      "uid" : "066f5949d16944f69c91e4d240d420dc",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream-viewer",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-no-viewer",
      "uid" : "0d420de46944f6946f594cd206c919d1",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream-with-viewer-2",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-no-viewer",
      "uid" : "0d4269f59949d160de464cd206c944f1",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream-protobuf-protobuf",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "155ade4f3ad644ab95d317172cc7fe4c",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream_pagination10",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "21105915be694c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream_pagination12",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915ba694c0d9da2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream_auto_approve_test",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915ba964c0d9dd2302cf54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-my_stream",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915ba964c0d9dd23444454153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : null,
      "created_by" : "poweruser@tenanta.nl",
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream_pagination2",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be614c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream_pagination16",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be624c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream_pagination14",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be694c0d6dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream4",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be694c0d9dd2301ff54153f0",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream_pagination18",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be694c0d9dd2302cf54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream_pagination6",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "311ac915be694c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream_pagination8",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31bbb915be694c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream_pagination9",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "41105915be694c0d9dd2301ff54153f1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream-avro-avro",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream-avro-avro",
      "uid" : "4d245949d1694066f4f69c91e0d420dc",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream5",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication2",
        "emailAddress" : null,
        "uid" : "88eb98e0eff34fde923c15687e6d75d5",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "63f9d62dfb6141dcae073c2cd09c982f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 36,
    "totalPages" : 2,
    "number" : 0
  }
}
Relation Description

create

Existence of this link indicates that the currently authenticated user can create a new Stream

35.3. Create stream

A POST request is used to create a new stream. A message stored in a stream is a key-value pair. The key is used internally by Kafka while value represents the payload of the message. The key and value could be of different formats. These formats are described in below table.

Data format Description

AVRO

A JSON like data model with sophisticated schema description.

JSON Schemaless

Data structured in JSON format.

STRING

A plain text data with no format.

BINARY

Low-level binary data.

PROTOBUF

Data serialized in Protocol Buffers format.

JSON Schema

Schema for validating JSON data.

The data format for key and value is specified by keyType and valueType fields. If AVRO,PROTOBUF or JSON Schema format is selected, a separate keySchema and valueSchema must be specified for complete type definition. For all other data formats, these fields can be skipped.

It is possible to have different data formats for key and value.

35.3.1. Request fields

Path Type Description Constraints

name

String

The name of the stream

Must match the regular expression (?i)^[a-z0-9\.\-_ ]+$. Must not be empty. Size must be between 3 and 180 inclusive

description

String

A summary text describing the purpose of this stream.

Size must be between 0 and 200 inclusive

properties

Object

A list of Stream specific variables in Key, Value format.

owners

String

A valid URI of an existing group, must not be null.

Must not be null

viewers

Array

A valid list of URI of existing groups. It is used to give view authority on Stream Configuration for this Stream.

tags

Array

A list of strings that help to distinguish Streams by their function.

retentionPolicy

String

Defines the policy to retain the messages on this stream. Possible values delete, compact, and It is also possible to specify both policies in a comma-separated list (e.g."delete,compact"). Default is delete. When set to delete, messages will be cleaned up based on the retentionTime property of StreamConfig. If both policies are specified, old segments will be discarded per the retention time and size configuration, while retained segments will be compacted.

Must not be null

keyType

String

Key type of Stream. Can be one of AVRO, JSON Schemaless, STRING, XML Schemaless, BINARY, PROTOBUF or JSON Schema

Must not be null

valueType

String

Value type of Stream. Can be one of AVRO, JSON Schemaless, STRING, XML Schemaless, BINARY, PROTOBUF or JSON Schema

Must not be null

keySchema

String

A URI of an existing Schema. Only needed when keyType is AVRO, PROTOBUF or JSON Schema.

valueSchema

String

A URI of an existing Schema. Only needed when valueType is AVRO, PROTOBUF or JSON Schema

integrity

String

A URI of an existing Integrity. Only needed when dataClassificationEnabled for the current Tenant is ON

confidentiality

String

A URI of an existing Confidentiality. Only needed when dataClassificationEnabled for the current Tenant is ON

35.3.2. Curl request

$ curl 'http://api.example.com/streams' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "name" : "general-applicationlog",
  "description" : "Stream to capture application logs",
  "keyType" : "AVRO",
  "valueType" : "AVRO",
  "retentionPolicy" : "delete",
  "keySchema" : "http://api.example.com/schemas/4edccfd6aa744e698542da36f1f01114",
  "valueSchema" : "http://api.example.com/schemas/8bc19be0c9cd4da296acd78e6022edf1",
  "integrity" : "http://api.example.com/integrities/247ab08159fe4da8be6905b55552ab52",
  "confidentiality" : "http://api.example.com/confidentialities/347ab08009fe4da8be6905b55552ab52",
  "owners" : "http://api.example.com/groups/2d8e99afd6e047f69c9595b4f2525fa6",
  "viewers" : [ "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775", "http://api.example.com/groups/88eb98e0eff34fde923c15687e6d75d5" ],
  "tags" : [ "tag1 TestUppercase", "tag2 TestNumber 123" ]
}'

35.3.3. HTTP request

POST /streams HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 816
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "name" : "general-applicationlog",
  "description" : "Stream to capture application logs",
  "keyType" : "AVRO",
  "valueType" : "AVRO",
  "retentionPolicy" : "delete",
  "keySchema" : "http://api.example.com/schemas/4edccfd6aa744e698542da36f1f01114",
  "valueSchema" : "http://api.example.com/schemas/8bc19be0c9cd4da296acd78e6022edf1",
  "integrity" : "http://api.example.com/integrities/247ab08159fe4da8be6905b55552ab52",
  "confidentiality" : "http://api.example.com/confidentialities/347ab08009fe4da8be6905b55552ab52",
  "owners" : "http://api.example.com/groups/2d8e99afd6e047f69c9595b4f2525fa6",
  "viewers" : [ "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775", "http://api.example.com/groups/88eb98e0eff34fde923c15687e6d75d5" ],
  "tags" : [ "tag1 TestUppercase", "tag2 TestNumber 123" ]
}

35.3.4. HTTP response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 08:12:35 GMT
Location: http://api.example.com/streams/14963f78c553424da4845b6aa0c14fa9
Content-Type: application/hal+json
Content-Length: 5116

{
  "properties" : { },
  "tags" : [ "tag2 TestNumber 123", "tag1 TestUppercase" ],
  "name" : "general-applicationlog",
  "description" : "Stream to capture application logs",
  "keyType" : "AVRO",
  "valueType" : "AVRO",
  "retentionPolicy" : "delete",
  "uid" : "14963f78c553424da4845b6aa0c14fa9",
  "created_at" : "2025-06-25T08:12:35.334188324",
  "modified_at" : "2025-06-25T08:12:35.334188324",
  "created_by" : "poweruser@tenanta.nl",
  "modified_by" : "poweruser@tenanta.nl",
  "_embedded" : {
    "keySchema" : {
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "nl.tenanta.key-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "owners" : {
      "_links" : {
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ],
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "Stream-tenAApplication1",
      "emailAddress" : null,
      "phoneNumber" : "abc789964",
      "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "valueSchema" : {
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "nl.tenanta.value-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "8bc19be0c9cd4da296acd78e6022edf1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "viewers" : [ {
      "_links" : {
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ],
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "Application-tenAApplication1",
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ],
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "Stream-tenAApplication2",
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "88eb98e0eff34fde923c15687e6d75d5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "stream" : {
      "href" : "...",
      "templated" : true,
      "title" : "A stream"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "keySchema" : {
      "href" : "...",
      "templated" : true,
      "title" : "The AVRO schema configured for key"
    },
    "owners" : {
      "href" : "...",
      "templated" : true,
      "title" : "The group responsible for this object"
    },
    "integrity" : {
      "href" : "...",
      "templated" : true,
      "title" : "The integrity configured for the object"
    },
    "valueSchema" : {
      "href" : "...",
      "templated" : true,
      "title" : "The AVRO schema configured for value"
    },
    "confidentiality" : {
      "href" : "...",
      "templated" : true,
      "title" : "The confidentiality configured for the object"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}

35.4. Retrieve a stream

The streams/{id} resource is used to retrieve, update and delete individual streams.

A GET request will retrieve the details of a Stream.

35.4.1. HTTP request

GET /streams/066f5944d16344f88c9214d240d139dc HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

35.4.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 3510

{
  "properties" : {
    "key-1" : "696969",
    "key-3" : "696969",
    "key-2" : "60000"
  },
  "tags" : [ "TAG1", "tAg2", "avro" ],
  "name" : "tenanta-stream1",
  "description" : "description_tenanta-stream1",
  "keyType" : "AVRO",
  "valueType" : "AVRO",
  "retentionPolicy" : "delete",
  "uid" : "066f5944d16344f88c9214d240d139dc",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : "strauthor@tenanta.nl",
  "modified_by" : "strauthor@tenanta.nl",
  "_embedded" : {
    "keySchema" : {
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "nl.tenanta.key-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "owners" : {
      "_links" : {
        "managers" : {
          "href" : "...",
          "templated" : true
        },
        "resourceManagers" : {
          "href" : "...",
          "templated" : true
        },
        "members" : [ {
          "href" : "...",
          "templated" : true,
          "title" : "Users belonging to this group"
        } ],
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "Stream-tenAApplication1",
      "emailAddress" : null,
      "phoneNumber" : "abc789964",
      "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    },
    "valueSchema" : {
      "_links" : {
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "nl.tenanta.value-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "8bc19be0c9cd4da296acd78e6022edf1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "stream" : {
      "href" : "...",
      "templated" : true,
      "title" : "A stream"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "keySchema" : {
      "href" : "...",
      "templated" : true,
      "title" : "The AVRO schema configured for key"
    },
    "owners" : {
      "href" : "...",
      "templated" : true,
      "title" : "The group responsible for this object"
    },
    "integrity" : {
      "href" : "...",
      "templated" : true,
      "title" : "The integrity configured for the object"
    },
    "valueSchema" : {
      "href" : "...",
      "templated" : true,
      "title" : "The AVRO schema configured for value"
    },
    "confidentiality" : {
      "href" : "...",
      "templated" : true,
      "title" : "The confidentiality configured for the object"
    },
    "viewers" : {
      "href" : "...",
      "templated" : true
    }
  }
}
Relation Description

keySchema

Version of the Key schema definition

valueSchema

Version of the Value schema definition

owners

The group of users allowed to access/update the environment.

integrity

UID of the Integrity level definition

confidentiality

UID of the Confidentiality level definition

edit

Existence of this link indicates that the currently authenticated user can edit this Stream

delete

Existence of this link indicates that the currently authenticated user can cascade delete this Stream

35.5. Update a stream

A PATCH request is used to update a stream. In the request, pass only the field that needs changing.

Stream’s Value Type, Key Type, Retention Policy and Schema(if AVRO, PROTOBUF or JSON Schema) are editable when there is no stream config created for the stream.

$ curl 'http://api.example.com/streams/066f5944d16344f88c9214d240d139dc' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "description" : "Purpose of this stream is documentation",
  "tags" : [ "a", "b", "c" ]
}'
PATCH /streams/066f5944d16344f88c9214d240d139dc HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 93
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "description" : "Purpose of this stream is documentation",
  "tags" : [ "a", "b", "c" ]
}
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 21:16:23 GMT
Location: http://api.example.com/streams/066f5944d16344f88c9214d240d139dc
Content-Type: application/hal+json
Content-Length: 4408

{
  "name" : "tenanta-stream1",
  "properties" : {
    "key-1" : "696969",
    "key-3" : "696969",
    "key-2" : "60000"
  },
  "tags" : [ "a", "b", "c" ],
  "uid" : "066f5944d16344f88c9214d240d139dc",
  "keySchema" : {
    "name" : "nl.tenanta.key-schema1",
    "type" : "AVRO",
    "description" : "",
    "owners" : null,
    "fileName" : "key-schema1.avsc",
    "uid" : "4edccfd6aa744e698542da36f1f01114",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "valueSchema" : {
    "name" : "nl.tenanta.value-schema1",
    "type" : "AVRO",
    "description" : "",
    "owners" : null,
    "fileName" : "value-schema1.avsc",
    "uid" : "8bc19be0c9cd4da296acd78e6022edf1",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "keyType" : "AVRO",
  "valueType" : "AVRO",
  "retentionPolicy" : "delete",
  "description" : "Purpose of this stream is documentation",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : "strauthor@tenanta.nl",
  "modified_by" : "strauthor@tenanta.nl",
  "_embedded" : {
    "owners" : {
      "name" : "Stream-tenAApplication1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : "abc789964",
      "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    },
    "viewers" : [ ],
    "keySchema" : {
      "name" : "nl.tenanta.key-schema1",
      "owners" : null,
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "description" : "",
      "type" : "AVRO",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "title" : "A schema"
        }
      }
    },
    "valueSchema" : {
      "name" : "nl.tenanta.value-schema1",
      "owners" : null,
      "uid" : "8bc19be0c9cd4da296acd78e6022edf1",
      "description" : "",
      "type" : "AVRO",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "title" : "A schema"
        }
      }
    }
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "stream" : {
      "href" : "...",
      "title" : "A stream"
    },
    "confidentiality" : {
      "href" : "...",
      "title" : "The confidentiality configured for the object"
    },
    "valueSchema" : {
      "href" : "...",
      "title" : "The AVRO schema configured for value"
    },
    "keySchema" : {
      "href" : "...",
      "title" : "The AVRO schema configured for key"
    },
    "integrity" : {
      "href" : "...",
      "title" : "The integrity configured for the object"
    },
    "viewers" : {
      "href" : "..."
    },
    "owners" : {
      "href" : "...",
      "title" : "The group responsible for this object"
    }
  }
}

35.5.1. Update viewer groups

A PATCH request is used to update a stream to add/remove viewer groups. You can provide a valid list of URIs of the existing groups.

Curl request
$ curl 'http://api.example.com/streams/0d420de46944f6946f594cd206c919d1' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "viewers" : [ "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775", "http://api.example.com/groups/88eb98e0eff34fde923c15687e6d75d5" ]
}'
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Tue, 07 Jun 2022 11:16:23 GMT
Location: http://api.example.com/streams/0d420de46944f6946f594cd206c919d1
Content-Type: application/hal+json
Content-Length: 5501

{
  "name" : "tenanta-stream-viewer",
  "properties" : { },
  "tags" : [ ],
  "uid" : "0d420de46944f6946f594cd206c919d1",
  "keySchema" : {
    "name" : "nl.tenanta.key-schema1",
    "type" : "AVRO",
    "description" : "",
    "owners" : null,
    "fileName" : "key-schema1.avsc",
    "uid" : "4edccfd6aa744e698542da36f1f01114",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "valueSchema" : null,
  "keyType" : "AVRO",
  "valueType" : "String",
  "retentionPolicy" : "delete",
  "description" : "description_tenanta-no-viewer",
  "created_at" : "2022-06-07T13:16:23",
  "modified_at" : "2022-06-07T13:16:23",
  "created_by" : "strauthor@tenanta.nl",
  "modified_by" : "strauthor@tenanta.nl",
  "_embedded" : {
    "owners" : {
      "name" : "Stream-tenAApplication1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : "abc789964",
      "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    },
    "viewers" : [ {
      "name" : "Stream-tenAApplication2",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "88eb98e0eff34fde923c15687e6d75d5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    }, {
      "name" : "Application-tenAApplication1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    } ],
    "keySchema" : {
      "name" : "nl.tenanta.key-schema1",
      "owners" : null,
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "description" : "",
      "type" : "AVRO",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "title" : "A schema"
        }
      }
    }
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "stream" : {
      "href" : "...",
      "title" : "A stream"
    },
    "confidentiality" : {
      "href" : "...",
      "title" : "The confidentiality configured for the object"
    },
    "valueSchema" : {
      "href" : "...",
      "title" : "The AVRO schema configured for value"
    },
    "keySchema" : {
      "href" : "...",
      "title" : "The AVRO schema configured for key"
    },
    "integrity" : {
      "href" : "...",
      "title" : "The integrity configured for the object"
    },
    "viewers" : {
      "href" : "..."
    },
    "owners" : {
      "href" : "...",
      "title" : "The group responsible for this object"
    }
  }
}

35.5.2. Update tags

A PATCH request is used to update a stream to add/remove tags. You can provide a list of strings for tags.

Curl request
$ curl 'http://api.example.com/streams/0d420de46944f6946f594cd206c919d1' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "tags" : [ "tag1 TestUppercase", "tag2 TestNumber 123" ]
}'
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Tue, 07 Jun 2022 11:16:23 GMT
Location: http://api.example.com/streams/0d420de46944f6946f594cd206c919d1
Content-Type: application/hal+json
Content-Length: 4500

{
  "name" : "tenanta-stream-viewer",
  "properties" : { },
  "tags" : [ "tag2 TestNumber 123", "tag1 TestUppercase" ],
  "uid" : "0d420de46944f6946f594cd206c919d1",
  "keySchema" : {
    "name" : "nl.tenanta.key-schema1",
    "type" : "AVRO",
    "description" : "",
    "owners" : null,
    "fileName" : "key-schema1.avsc",
    "uid" : "4edccfd6aa744e698542da36f1f01114",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "valueSchema" : null,
  "keyType" : "AVRO",
  "valueType" : "String",
  "retentionPolicy" : "delete",
  "description" : "description_tenanta-no-viewer",
  "created_at" : "2022-06-07T13:16:23",
  "modified_at" : "2022-06-07T13:16:23",
  "created_by" : "strauthor@tenanta.nl",
  "modified_by" : "strauthor@tenanta.nl",
  "_embedded" : {
    "owners" : {
      "name" : "Stream-tenAApplication1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : "abc789964",
      "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    },
    "viewers" : [ {
      "name" : "stream_viewer_group",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "itad8484ppob4399983iu1869644c27",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    } ],
    "keySchema" : {
      "name" : "nl.tenanta.key-schema1",
      "owners" : null,
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "description" : "",
      "type" : "AVRO",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "title" : "A schema"
        }
      }
    }
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "stream" : {
      "href" : "...",
      "title" : "A stream"
    },
    "confidentiality" : {
      "href" : "...",
      "title" : "The confidentiality configured for the object"
    },
    "valueSchema" : {
      "href" : "...",
      "title" : "The AVRO schema configured for value"
    },
    "keySchema" : {
      "href" : "...",
      "title" : "The AVRO schema configured for key"
    },
    "integrity" : {
      "href" : "...",
      "title" : "The integrity configured for the object"
    },
    "viewers" : {
      "href" : "..."
    },
    "owners" : {
      "href" : "...",
      "title" : "The group responsible for this object"
    }
  }
}
Duplicated tags

In case the PATCH request contains duplicated tags, the Platform Manager will only store one entry of each duplicated tag.

Curl request
$ curl 'http://api.example.com/streams/0d420de46944f6946f594cd206c919d1' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "tags" : [ "tag1 TestUppercase", "tag1 TestUppercase", "tag2 TestNumber 123" ]
}'
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Tue, 07 Jun 2022 11:16:23 GMT
Location: http://api.example.com/streams/0d420de46944f6946f594cd206c919d1
Content-Type: application/hal+json
Content-Length: 4500

{
  "name" : "tenanta-stream-viewer",
  "properties" : { },
  "tags" : [ "tag2 TestNumber 123", "tag1 TestUppercase" ],
  "uid" : "0d420de46944f6946f594cd206c919d1",
  "keySchema" : {
    "name" : "nl.tenanta.key-schema1",
    "type" : "AVRO",
    "description" : "",
    "owners" : null,
    "fileName" : "key-schema1.avsc",
    "uid" : "4edccfd6aa744e698542da36f1f01114",
    "created_at" : "2018-06-07T23:16:23",
    "modified_at" : "2018-06-07T23:16:23",
    "created_by" : null,
    "modified_by" : null
  },
  "valueSchema" : null,
  "keyType" : "AVRO",
  "valueType" : "String",
  "retentionPolicy" : "delete",
  "description" : "description_tenanta-no-viewer",
  "created_at" : "2022-06-07T13:16:23",
  "modified_at" : "2022-06-07T13:16:23",
  "created_by" : "strauthor@tenanta.nl",
  "modified_by" : "strauthor@tenanta.nl",
  "_embedded" : {
    "owners" : {
      "name" : "Stream-tenAApplication1",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : "abc789964",
      "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    },
    "viewers" : [ {
      "name" : "stream_viewer_group",
      "properties" : { },
      "emailAddress" : null,
      "phoneNumber" : null,
      "uid" : "itad8484ppob4399983iu1869644c27",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "group" : {
          "href" : "...",
          "title" : "A group"
        },
        "members" : [ {
          "href" : "...",
          "title" : "Users belonging to this group"
        } ],
        "managers" : {
          "href" : "..."
        },
        "resourceManagers" : {
          "href" : "..."
        }
      }
    } ],
    "keySchema" : {
      "name" : "nl.tenanta.key-schema1",
      "owners" : null,
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "description" : "",
      "type" : "AVRO",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "title" : "A schema"
        }
      }
    }
  },
  "_links" : {
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "stream" : {
      "href" : "...",
      "title" : "A stream"
    },
    "confidentiality" : {
      "href" : "...",
      "title" : "The confidentiality configured for the object"
    },
    "valueSchema" : {
      "href" : "...",
      "title" : "The AVRO schema configured for value"
    },
    "keySchema" : {
      "href" : "...",
      "title" : "The AVRO schema configured for key"
    },
    "integrity" : {
      "href" : "...",
      "title" : "The integrity configured for the object"
    },
    "viewers" : {
      "href" : "..."
    },
    "owners" : {
      "href" : "...",
      "title" : "The group responsible for this object"
    }
  }
}

35.6. Stream search endpoints

35.6.1. /streams/search/findByAttributes

A GET request is used to retrieve all streams based on parameters.

Query parameters
Parameter Description

name

Stream name to search for.

streamId

Stream id to search for.

groupName

Stream owner name to search for.

tag

Stream tag to search for.

description

Stream description to search.

myStreams

If set to true - returns only owned streams.

sort

Property to sort on and the direction.

page

Navigate through different pages.

size

Property to define the page size.
HTTP request
GET /streams/search/findByAttributes?name=tenanta-stream1&streamId=&tag=&groupName=Stream-tenAApplication1&myStreams=false&description=t&sort=name%2Casc&page=0&size=5 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2894

{
  "_embedded" : {
    "streams" : [ {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream1",
      "properties" : {
        "key-1" : "696969",
        "key-3" : "696969",
        "key-2" : "60000"
      },
      "tags" : [ "TAG1", "tAg2", "avro" ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "066f5944d16344f88c9214d240d139dc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 5,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}
Filter by myStreams

A GET request will retrieve streams owned by the current user if parameter myStreams is set to true.

Parameter Description

myStreams

Search only for my streams.

 
GET /streams/search/findByAttributes?myStreams=true HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2732

{
  "_embedded" : {
    "streams" : [ {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-my_stream",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915ba964c0d9dd23444454153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : null,
      "created_by" : "poweruser@tenanta.nl",
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

35.6.2. /streams/search/findByName

Search for a stream by exact name.

Parameter Description

name

Stream name to search for.

 
GET /streams/search/findByName?name=tenanta-stream1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 2687

{
  "_embedded" : {
    "streams" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "tenanta-stream1",
      "properties" : {
        "key-1" : "696969",
        "key-3" : "696969",
        "key-2" : "60000"
      },
      "tags" : [ "TAG1", "tAg2", "avro" ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "066f5944d16344f88c9214d240d139dc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

35.6.3. /streams/search/findByNameContaining

Search for a stream by name containing search term.

Parameter Description

name

Term to search within stream name.

 
GET /streams/search/findByNameContaining?name=stream HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 47132

{
  "_embedded" : {
    "streams" : [ {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream1",
      "properties" : {
        "key-1" : "696969",
        "key-3" : "696969",
        "key-2" : "60000"
      },
      "tags" : [ "TAG1", "tAg2", "avro" ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "066f5944d16344f88c9214d240d139dc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-string-avro",
      "properties" : { },
      "tags" : [ "tag" ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream-string-avro",
      "uid" : "066f5944d16944f88c91e4d240d139dc",
      "created_at" : "2022-06-07T23:16:23",
      "modified_at" : "2022-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-avro-string",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream-avro-string",
      "uid" : "066f5949d16944f69c91e4d240d420dc",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-viewer",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-no-viewer",
      "uid" : "0d420de46944f6946f594cd206c919d1",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-with-viewer-2",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-no-viewer",
      "uid" : "0d4269f59949d160de464cd206c944f1",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-protobuf-protobuf",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "155ade4f3ad644ab95d317172cc7fe4c",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination10",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "21105915be694c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination12",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915ba694c0d9da2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_auto_approve_test",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915ba964c0d9dd2302cf54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-my_stream",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915ba964c0d9dd23444454153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : null,
      "created_by" : "poweruser@tenanta.nl",
      "modified_by" : null
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination2",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be614c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination16",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be624c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination14",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be694c0d6dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream4",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be694c0d9dd2301ff54153f0",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination18",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be694c0d9dd2302cf54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination6",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "311ac915be694c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination8",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31bbb915be694c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination9",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "41105915be694c0d9dd2301ff54153f1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-avro-avro",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream-avro-avro",
      "uid" : "4d245949d1694066f4f69c91e0d420dc",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream5",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication2",
        "emailAddress" : null,
        "uid" : "88eb98e0eff34fde923c15687e6d75d5",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "63f9d62dfb6141dcae073c2cd09c982f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 34,
    "totalPages" : 2,
    "number" : 0
  }
}

35.6.4. /streams/search/findByNameContaining

Search for a stream by name containing search term and order by a nested property.

Parameter Description

name

Term to search within stream name.

sort

Property to sort on and the direction.

 
GET /streams/search/findByNameContaining?name=stream&sort=owners.name%2Casc HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 47810

{
  "_embedded" : {
    "streams" : [ {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-with-viewer-2",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Application-tenAApplication1",
        "emailAddress" : null,
        "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-no-viewer",
      "uid" : "0d4269f59949d160de464cd206c944f1",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-my_stream",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915ba964c0d9dd23444454153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : null,
      "created_by" : "poweruser@tenanta.nl",
      "modified_by" : null
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta_byok_stream_jsonSchema",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-json-stream1",
      "uid" : "tenanta_nonByok_jsonSchema_stream",
      "created_at" : "2024-06-07T23:16:23",
      "modified_at" : "2024-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-avro-avro",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream-avro-avro",
      "uid" : "4d245949d1694066f4f69c91e0d420dc",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-avro-string",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream-avro-string",
      "uid" : "066f5949d16944f69c91e4d240d420dc",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-protobuf-protobuf",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "155ade4f3ad644ab95d317172cc7fe4c",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-string-avro",
      "properties" : { },
      "tags" : [ "tag" ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream-string-avro",
      "uid" : "066f5944d16944f88c91e4d240d139dc",
      "created_at" : "2022-06-07T23:16:23",
      "modified_at" : "2022-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-viewer",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-no-viewer",
      "uid" : "0d420de46944f6946f594cd206c919d1",
      "created_at" : "2022-06-07T13:16:23",
      "modified_at" : "2022-06-07T13:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream1",
      "properties" : {
        "key-1" : "696969",
        "key-3" : "696969",
        "key-2" : "60000"
      },
      "tags" : [ "TAG1", "tAg2", "avro" ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "066f5944d16344f88c9214d240d139dc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream-string-string",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication2",
        "emailAddress" : null,
        "uid" : "88eb98e0eff34fde923c15687e6d75d5",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "a532f500d879419fff5efa5d3cada7b3",
      "created_at" : "2021-06-07T23:16:23",
      "modified_at" : "2021-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream2",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication2",
        "emailAddress" : null,
        "uid" : "88eb98e0eff34fde923c15687e6d75d5",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : {
        "level" : "L2",
        "description" : "This is level 2",
        "color" : "yellow",
        "uid" : "247ab03ffafe4da2bet905b5e352ab53",
        "created_at" : "2019-06-08T23:16:23",
        "modified_at" : "2019-06-08T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "confidentiality" : {
        "level" : "L2",
        "description" : "L2 confidentiality",
        "color" : "blue",
        "uid" : "648ab08009fe4da8be6905b55552ac43",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "a549f500d879419c9f5efa5d3cada7b3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream5",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication2",
        "emailAddress" : null,
        "uid" : "88eb98e0eff34fde923c15687e6d75d5",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "63f9d62dfb6141dcae073c2cd09c982f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_auto_approve_test",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915ba964c0d9dd2302cf54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination1",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "91105915be694c0d9dd2301ff54153f1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination10",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "21105915be694c0d9dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination11",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "9110591abe694c0d9dd2301ff54153f1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination12",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915ba694c0d9da2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination13",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "91105915be694c0d9df2301ff54153f1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination14",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "31105915be694c0d6dd2301ff54153f2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    }, {
      "_links" : {
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream_pagination15",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Team Null",
        "emailAddress" : null,
        "uid" : "514d4e9a834841699644c2420b439553",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "91105915be695c0d9dd2301ff54153f1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "export" : {
      "href" : "...",
      "title" : "URL to export the list of the entities in CSV"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 34,
    "totalPages" : 2,
    "number" : 0
  }
}

35.7. Delete stream

Deleting stream is a two-step process a GET request to check the constraints followed by the DELETE request.

35.7.1. Delete stream constraints

A GET request is used to get the constraints for deleting Stream.

$ curl 'http://api.example.com/streams/066f5944d16344f88c9214d240d139dc/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /streams/066f5944d16344f88c9214d240d139dc/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1142

{
  "canDelete" : false,
  "streamConfigsCount" : 9,
  "streamConfigs" : [ {
    "environmentName" : "tenantaenv1"
  }, {
    "environmentName" : "tenantaenv9_with_revoked_app_access_only"
  }, {
    "environmentName" : "tenantaenv10"
  }, {
    "environmentName" : "tenantaenv7_with_app_access_only"
  }, {
    "environmentName" : "tenantaprivenv3"
  }, {
    "environmentName" : "tenantaenv9_with_app_principal_and_credential"
  }, {
    "environmentName" : "tenantaenv2"
  }, {
    "environmentName" : "tenantaenv6_with_app_principal"
  }, {
    "environmentName" : "tenantaenv_with_ksml"
  } ],
  "activeGrantsCount" : 4,
  "activeGrants" : [ {
    "environmentName" : "tenantaenv2",
    "applicationName" : "tenantaApplication1",
    "accessType" : "PRODUCER"
  }, {
    "environmentName" : "tenantaenv10",
    "applicationName" : "tenantaApplication1",
    "accessType" : "PRODUCER"
  }, {
    "environmentName" : "tenantaprivenv5",
    "applicationName" : "testRevoke",
    "accessType" : "CONSUMER"
  }, {
    "environmentName" : "tenantaprivenv4",
    "applicationName" : "tenantaApplication25",
    "accessType" : "CONSUMER"
  } ]
}

35.7.2. Delete stream

A DELETE request is used to delete a Stream.

It is important to know that executing this operation will result in the deletion of not only the stream itself but also its associated entities, including stream configs, application accesses and access grants.

$ curl 'http://api.example.com/streams/31105915be694c0d9dd2301ff54153f0' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
DELETE /streams/31105915be694c0d9dd2301ff54153f0 HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

35.8. Topic browse config

A GET request is used to obtain the information required to query messages on a specific cluster.

The UID present in the request path needs to be a valid Stream Config uid and NOT a Stream uid !!! 
$ curl 'http://api.example.com/stream_configs/3f9ee6ce053c46b0932358c8503a2687/browse-config?selectedCluster=Zone1ClusterPROD&unmask=true' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /stream_configs/3f9ee6ce053c46b0932358c8503a2687/browse-config?selectedCluster=Zone1ClusterPROD&unmask=true HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 732

{
  "bootstrapUrls" : "cluster-bootstrap",
  "brokerProtocolType" : "cluster-protocol-type",
  "resolvedTopicName" : "tenanta-prod-tenantaprivenv5-tenanta-stream2",
  "keyType" : "AVRO",
  "valueType" : "AVRO",
  "brokerAuthConfigs" : {
    "broker.password" : "cluster-password",
    "broker.ca.certs" : "cluster-ca-cert",
    "broker.username" : "cluster-username",
    "broker.security.protocol.type" : "cluster-security-protocol-type",
    "broker.ca.validation" : "cluster-ca-validation"
  },
  "schemaRegistryUrls" : "schema-registry-url",
  "srProtocolType" : "No-Auth",
  "srType" : "APICURIO",
  "srAuthConfigs" : {
    "sr.ca.certs" : "schema-registry-ca-cert"
  },
  "keyMaskedFields" : [ ],
  "valueMaskedFields" : [ ]
}

35.9. Export Streams in CSV

A GET request is used to export a CSV containing information about the Streams.

The endpoint is also reachable at /export/topics/. 
$ curl 'http://api.example.com/export/streams' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /export/streams HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Disposition: attachment; filename="streams.csv"
Content-Length: 8570

"NAME","DESCRIPTION","KEY_TYPE","KEY_SCHEMA_NAME","VALUE_TYPE","VALUE_SCHEMA_NAME","OWNERS_GROUP_NAME","RETENTION_POLICY","PROPERTIES","CREATED_BY","CREATED_AT","MODIFIED_BY","MODIFIED_AT"
"tenanta-stream1","description_tenanta-stream1","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Stream-tenAApplication1","DELETE","{key-1=696969, key-3=696969, key-2=60000}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream-string-avro","description_tenanta-stream-string-avro","STRING","","AVRO","nl.tenanta.value-schema1","Stream-tenAApplication1","DELETE","{}","strauthor@tenanta.nl","2022-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2022-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream-avro-string","description_tenanta-stream-avro-string","AVRO","nl.tenanta.key-schema1","STRING","","Stream-tenAApplication1","DELETE","{}","strauthor@tenanta.nl","2022-06-07T13:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2022-06-07T13:16:23Z[Etc/UTC]"
"tenanta-stream-viewer","description_tenanta-no-viewer","AVRO","nl.tenanta.key-schema1","STRING","","Stream-tenAApplication1","DELETE","{}","strauthor@tenanta.nl","2022-06-07T13:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2022-06-07T13:16:23Z[Etc/UTC]"
"tenanta-stream-with-viewer-2","description_tenanta-no-viewer","AVRO","nl.tenanta.key-schema1","STRING","","Application-tenAApplication1","DELETE","{}","strauthor@tenanta.nl","2022-06-07T13:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2022-06-07T13:16:23Z[Etc/UTC]"
"tenanta-stream-protobuf-protobuf","description_tenanta-stream1","PROTOBUF","nl.tenanta.key-proto-schema1","PROTOBUF","nl.tenanta.value-proto-schema1","Stream-tenAApplication1","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination10","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination12","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_auto_approve_test","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-my_stream","description","STRING","","STRING","","Environment-tenAenv1","DELETE","{}","poweruser@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","",""
"tenanta-stream_pagination2","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination16","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination14","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream4","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination18","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination6","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination8","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination9","description","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream-avro-avro","description_tenanta-stream-avro-avro","STRING","","AVRO","io.axual.qa.general.Rand","Stream-tenAApplication1","DELETE","{}","strauthor@tenanta.nl","2022-06-07T13:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2022-06-07T13:16:23Z[Etc/UTC]"
"tenanta-stream5","description","AVRO","nl.tenanta.key-schema2","AVRO","nl.tenanta.value-schema2","Stream-tenAApplication2","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination4","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream3","description","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination1","description","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination3","description","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination17","description","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination13","description","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination15","description","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination5","description","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination11","description","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream_pagination7","description","AVRO","nl.tenanta.key-schema1","AVRO","nl.tenanta.value-schema1","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream-string-string","description","STRING","","STRING","","Stream-tenAApplication2","DELETE","{}","strauthor@tenanta.nl","2021-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2021-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream2","description","AVRO","nl.tenanta.key-schema2","AVRO","nl.tenanta.value-schema2","Stream-tenAApplication2","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"collision-topic-name-1","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"collision-topic-name-2","description","STRING","","STRING","","Team Null","DELETE","{}","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2018-06-07T23:16:23Z[Etc/UTC]"
"tenanta_byok_stream_jsonSchema","description_tenanta-json-stream1","JSON_SCHEMA","JsonSchema-KeyName","JSON_SCHEMA","JsonSchema-ValueName","Stream-tenAApplication1","DELETE","{}","strauthor@tenanta.nl","2024-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2024-06-07T23:16:23Z[Etc/UTC]"
"tenanta-stream-string-resource-managers","description","STRING","","STRING","","Team with two resource managers","DELETE","{}","strauthor@tenanta.nl","2021-06-07T23:16:23Z[Etc/UTC]","strauthor@tenanta.nl","2021-06-07T23:16:23Z[Etc/UTC]"

36. StreamConfigs

A StreamConfig is a unique set of configurations of a Stream for an Environment.

The /stream_configs resource is used to create and list StreamConfigs.

36.1. StreamConfig Schema

The /stream_configs resource uses the following json-schema:

GET /profile/stream_configs HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 1626

{
  "title" : "Stream config",
  "definitions" : { },
  "properties" : {
    "partitions" : {
      "title" : "Partitions",
      "readOnly" : false,
      "type" : "integer"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "environment" : {
      "title" : "Environment",
      "readOnly" : true,
      "type" : "string",
      "format" : "uri"
    },
    "stream" : {
      "title" : "Stream",
      "readOnly" : true,
      "type" : "string",
      "format" : "uri"
    },
    "valueSchemaVersion" : {
      "title" : "Value schema version",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "keySchemaVersion" : {
      "title" : "Key schema version",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "retentionTime" : {
      "title" : "Retention time",
      "readOnly" : false,
      "type" : "integer"
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "properties" : {
      "title" : "Properties",
      "readOnly" : true,
      "type" : "object"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

36.2. List all stream configs

HTTP method GET is disabled for /stream_configs. Refer to search endpoints to find one or more StreamConfig for a Stream or an Environment or both.

36.3. List all stream configs properties

The /stream_configs/properties method is used to retrieve all supported stream config properties. The method returns an Array of all supported stream configs properties

$ curl 'http://api.example.com/stream_configs/properties' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /stream_configs/properties HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 150

[ "max.compaction.lag.ms", "message.timestamp.difference.max.ms", "message.timestamp.type", "min.compaction.lag.ms", "retention.bytes", "segment.ms" ]

Starting with Platform Manager version 7.0.0 we are supporting external Kafka providers, to get the list of supported Kafka properties based on your provider, please provide your tenantId or environmentId as the request param.

$ curl 'http://api.example.com/stream_configs/properties?tenantId=1149c97f04c42had8d9c97faa5a375ac&environmentId=84d93e918d49430fbf1d8cc7494d24d4' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /stream_configs/properties?tenantId=1149c97f04c42had8d9c97faa5a375ac&environmentId=84d93e918d49430fbf1d8cc7494d24d4 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 547

[ "cleanup.policy", "compression.type", "delete.retention.ms", "file.delete.delay.ms", "flush.messages", "flush.ms", "index.interval.bytes", "max.compaction.lag.ms", "max.message.bytes", "message.downconversion.enable", "message.format.version", "message.timestamp.difference.max.ms", "message.timestamp.type", "min.cleanable.dirty.ratio", "min.compaction.lag.ms", "min.insync.replicas", "preallocate", "retention.bytes", "retention.ms", "segment.bytes", "segment.index.bytes", "segment.jitter.ms", "segment.ms", "unclean.leader.election.enable" ]

36.4. Unsupported stream config properties

When creating a stream-config you can pass kafka properties to fine-tuning your use case.

We do not support all kafka properties available for a TopicConfig, in case you are passing an unsupported kafka property we return an error.

36.4.1. Curl request

$ curl 'http://api.example.com/stream_configs' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "stream" : "http://api.example.com/streams/a532f500d879419fff5efa5d3cada7b3",
  "environment" : "http://api.example.com/environments/e11ee2dd976647109ca904dd8adc050f",
  "properties" : {
    "cleanup.policy" : "COMPACT",
    "follower.replication.throttled.replicas" : "",
    "leader.replication.throttled.replicas" : "",
    "max.message.bytes" : 1048588,
    "message.format.version" : "2.6-IV0",
    "preallocate" : "false"
  }
}'

36.4.2. HTTP request

POST /stream_configs HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 437
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "stream" : "http://api.example.com/streams/a532f500d879419fff5efa5d3cada7b3",
  "environment" : "http://api.example.com/environments/e11ee2dd976647109ca904dd8adc050f",
  "properties" : {
    "cleanup.policy" : "COMPACT",
    "follower.replication.throttled.replicas" : "",
    "leader.replication.throttled.replicas" : "",
    "max.message.bytes" : 1048588,
    "message.format.version" : "2.6-IV0",
    "preallocate" : "false"
  }
}

36.4.3. HTTP response

HTTP/1.1 400 Bad Request
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 548

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Found an unsupported property." ],
  "subErrors" : [ {
    "field" : "StreamConfig.properties",
    "rejectedValue" : {
      "cleanup.policy" : "COMPACT",
      "follower.replication.throttled.replicas" : "",
      "leader.replication.throttled.replicas" : "",
      "max.message.bytes" : "1048588",
      "message.format.version" : "2.6-IV0",
      "preallocate" : "false"
    },
    "recommendedValues" : null,
    "errors" : [ "Found an unsupported property." ]
  } ]
}

36.5. Create stream config endpoints

Creating stream config is a two-step process a GET request to check the constraints followed by the CREATE request

36.5.1. Create stream config constraints

A GET request is used to get the constraints for creating StreamConfig.

$ curl 'http://api.example.com/streams/066f5944d16344f88c9214d240d139dc/create-constraints?envShortName=tenantaprivenv1' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /streams/066f5944d16344f88c9214d240d139dc/create-constraints?envShortName=tenantaprivenv1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 45

{
  "canCreate" : true,
  "waitTill" : null
}

36.5.2. Create stream config

A POST request is used to create a new StreamConfig. The request should include reference to a valid existing stream, key schema version and value schema version. The schema version should be of the same schema that is being used by the stream.

Request fields
Path Type Description Constraints

retentionTime

Number

The time in milliseconds after which the messages can be deleted from all streams. This is an optional field. If not specified, default value is 7 days (604800000).

Must be at least 1000. Must be at most 160704000000

partitions

Number

Defines the number of partitions configured for every stream of this tenant. This is an optional field. If not specified, default value is 12.

Must be at least 1. Must be at most 120000

stream

String

A valid URI of an existing stream.

Must not be null

environment

String

A valid URI of an existing environment.

Must not be null

keySchemaVersion

String

A valid URI of an existing schema version.

valueSchemaVersion

String

A valid URI of an existing schema version

properties

Object

A list of Kafka specific properties in Key,Value format.
Curl request
$ curl 'http://api.example.com/stream_configs' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "retentionTime" : 10000,
  "partitions" : 12,
  "stream" : "http://api.example.com/streams/a549f500d879419c9f5efa5d3cada7b3",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52",
  "keySchemaVersion" : "http://api.example.com/schema_versions/5162f72742cd4c6db07b9a71a825fe4f",
  "valueSchemaVersion" : "http://api.example.com/schema_versions/0aa818df699847d08c24f75a4a7399ed",
  "properties" : {
    "max.compaction.lag.ms" : "60000"
  }
}'
HTTP request
POST /stream_configs HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 480
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "retentionTime" : 10000,
  "partitions" : 12,
  "stream" : "http://api.example.com/streams/a549f500d879419c9f5efa5d3cada7b3",
  "environment" : "http://api.example.com/environments/047ab08009fe4da8be6905b55552ab52",
  "keySchemaVersion" : "http://api.example.com/schema_versions/5162f72742cd4c6db07b9a71a825fe4f",
  "valueSchemaVersion" : "http://api.example.com/schema_versions/0aa818df699847d08c24f75a4a7399ed",
  "properties" : {
    "max.compaction.lag.ms" : "60000"
  }
}
HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Wed, 25 Jun 2025 08:12:46 GMT
Location: http://api.example.com/stream_configs/0885f5476493426e9c0cfc6b4d47593e
Content-Type: application/hal+json
Content-Length: 5983

{
  "properties" : {
    "max.compaction.lag.ms" : "60000"
  },
  "retentionTime" : 10000,
  "partitions" : 12,
  "uid" : "0885f5476493426e9c0cfc6b4d47593e",
  "created_at" : "2025-06-25T08:12:46.725525037",
  "modified_at" : "2025-06-25T08:12:46.725525037",
  "created_by" : "streamowner@tenanta.nl",
  "modified_by" : "streamowner@tenanta.nl",
  "_embedded" : {
    "stream" : {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream2",
      "properties" : { },
      "tags" : [ ],
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication2",
        "emailAddress" : null,
        "uid" : "88eb98e0eff34fde923c15687e6d75d5",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : {
        "level" : "L2",
        "description" : "This is level 2",
        "color" : "yellow",
        "uid" : "247ab03ffafe4da2bet905b5e352ab53",
        "created_at" : "2019-06-08T23:16:23",
        "modified_at" : "2019-06-08T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "confidentiality" : {
        "level" : "L2",
        "description" : "L2 confidentiality",
        "color" : "blue",
        "uid" : "648ab08009fe4da8be6905b55552ac43",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "retentionPolicy" : "delete",
      "description" : "description",
      "uid" : "a549f500d879419c9f5efa5d3cada7b3",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    },
    "environment" : {
      "_links" : {
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "streamConfig" : {
      "href" : "...",
      "title" : "A configuration of a stream"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "keySchemaVersion" : {
      "href" : "...",
      "templated" : true,
      "title" : "A version of an AVRO schema configured for key"
    },
    "stream" : {
      "href" : "...",
      "templated" : true,
      "title" : "A stream"
    },
    "valueSchemaVersion" : {
      "href" : "...",
      "templated" : true,
      "title" : "A version of an AVRO schema configured for value"
    },
    "environment" : {
      "href" : "...",
      "templated" : true,
      "title" : "An environment"
    }
  }
}

36.6. Retrieve a stream config

The stream_configs/{id} resource is used to retrieve, update and delete individual stream config.

A GET request will retrieve the details of a StreamConfig.

36.6.1. HTTP request

GET /stream_configs/c082e097545948dcbd0cf993128d3fc2 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

36.6.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 5433

{
  "properties" : {
    "segment.ms" : "696969"
  },
  "retentionTime" : 10000,
  "partitions" : 12,
  "uid" : "c082e097545948dcbd0cf993128d3fc2",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "stream" : {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream1",
      "properties" : {
        "key-1" : "696969",
        "key-3" : "696969",
        "key-2" : "60000"
      },
      "tags" : [ "TAG1", "tAg2", "avro" ],
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "066f5944d16344f88c9214d240d139dc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    },
    "environment" : {
      "_links" : {
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "streamConfig" : {
      "href" : "...",
      "title" : "A configuration of a stream"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "keySchemaVersion" : {
      "href" : "...",
      "templated" : true,
      "title" : "A version of an AVRO schema configured for key"
    },
    "stream" : {
      "href" : "...",
      "templated" : true,
      "title" : "A stream"
    },
    "valueSchemaVersion" : {
      "href" : "...",
      "templated" : true,
      "title" : "A version of an AVRO schema configured for value"
    },
    "environment" : {
      "href" : "...",
      "templated" : true,
      "title" : "An environment"
    }
  }
}
Relation Description

edit

Existence of this link indicates that the currently authenticated user can edit this StreamConfig

delete

Existence of this link indicates that the currently authenticated user can delete this StreamConfig

36.7. Update a stream config

A PATCH request is used to update a stream config. In the request, pass only the field that needs changing.

$ curl 'http://api.example.com/stream_configs/c082e097545948dcbd0cf993128d3fc2' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "retentionTime" : 40000
}'
PATCH /stream_configs/c082e097545948dcbd0cf993128d3fc2 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 29
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "retentionTime" : 40000
}
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
Content-Type: application/hal+json
Content-Length: 5433

{
  "properties" : {
    "segment.ms" : "696969"
  },
  "retentionTime" : 40000,
  "partitions" : 12,
  "uid" : "c082e097545948dcbd0cf993128d3fc2",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "stream" : {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream1",
      "properties" : {
        "key-1" : "696969",
        "key-3" : "696969",
        "key-2" : "60000"
      },
      "tags" : [ "TAG1", "tAg2", "avro" ],
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "066f5944d16344f88c9214d240d139dc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    },
    "environment" : {
      "_links" : {
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "streamConfig" : {
      "href" : "...",
      "title" : "A configuration of a stream"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "keySchemaVersion" : {
      "href" : "...",
      "templated" : true,
      "title" : "A version of an AVRO schema configured for key"
    },
    "stream" : {
      "href" : "...",
      "templated" : true,
      "title" : "A stream"
    },
    "valueSchemaVersion" : {
      "href" : "...",
      "templated" : true,
      "title" : "A version of an AVRO schema configured for value"
    },
    "environment" : {
      "href" : "...",
      "templated" : true,
      "title" : "An environment"
    }
  }
}

36.8. Force a stream config

When you want to update a stream config with an incompatible schema change you need to force it. A PATCH request is used to force a stream config. In the request, pass only the field that needs changing and the field force=true.

$ curl 'http://api.example.com/stream_configs/c082e097545948dcbd0cf993128d3fc2' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "keySchemaVersion" : "http://api.example.com/schema_versions/5322f72742cd4c6db07b9a71a825fe4f",
  "force" : true
}'
PATCH /stream_configs/c082e097545948dcbd0cf993128d3fc2 HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 118
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "keySchemaVersion" : "http://api.example.com/schema_versions/5322f72742cd4c6db07b9a71a825fe4f",
  "force" : true
}
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
ETag: "0"
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
Content-Type: application/hal+json
Content-Length: 5433

{
  "properties" : {
    "segment.ms" : "696969"
  },
  "retentionTime" : 10000,
  "partitions" : 12,
  "uid" : "c082e097545948dcbd0cf993128d3fc2",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_embedded" : {
    "stream" : {
      "_links" : {
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "valueSchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for value"
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "keySchema" : {
          "href" : "...",
          "templated" : true,
          "title" : "The AVRO schema configured for key"
        },
        "confidentiality" : {
          "href" : "...",
          "templated" : true,
          "title" : "The confidentiality configured for the object"
        },
        "integrity" : {
          "href" : "...",
          "templated" : true,
          "title" : "The integrity configured for the object"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenanta-stream1",
      "properties" : {
        "key-1" : "696969",
        "key-3" : "696969",
        "key-2" : "60000"
      },
      "tags" : [ "TAG1", "tAg2", "avro" ],
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Stream-tenAApplication1",
        "emailAddress" : null,
        "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "integrity" : null,
      "confidentiality" : null,
      "retentionPolicy" : "delete",
      "description" : "description_tenanta-stream1",
      "uid" : "066f5944d16344f88c9214d240d139dc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "strauthor@tenanta.nl",
      "modified_by" : "strauthor@tenanta.nl"
    },
    "environment" : {
      "_links" : {
        "instance" : {
          "href" : "...",
          "templated" : true,
          "title" : "An instance"
        },
        "viewers" : {
          "href" : "...",
          "templated" : true
        },
        "owners" : {
          "href" : "...",
          "templated" : true,
          "title" : "The group responsible for this object"
        },
        "self" : {
          "href" : "...",
          "templated" : true,
          "title" : "URI pointing to current request"
        }
      },
      "name" : "tenantaenv1",
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "shortName" : "tenantaenv1",
      "color" : "#80affe",
      "visibility" : "public",
      "description" : "environment",
      "uid" : "047ab08009fe4da8be6905b55552ab52",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "streamConfig" : {
      "href" : "...",
      "title" : "A configuration of a stream"
    },
    "edit" : {
      "href" : "...",
      "title" : "Indication that this entity can be edited"
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    },
    "keySchemaVersion" : {
      "href" : "...",
      "templated" : true,
      "title" : "A version of an AVRO schema configured for key"
    },
    "stream" : {
      "href" : "...",
      "templated" : true,
      "title" : "A stream"
    },
    "valueSchemaVersion" : {
      "href" : "...",
      "templated" : true,
      "title" : "A version of an AVRO schema configured for value"
    },
    "environment" : {
      "href" : "...",
      "templated" : true,
      "title" : "An environment"
    }
  }
}

36.9. Delete stream config endpoints

Deleting stream config is a two step process a GET request to check the constraints followed by the DELETE request

36.9.1. Delete stream config constraints

A GET request is used to get the constraints for deleting StreamConfig.

$ curl 'http://api.example.com/stream_configs/mnjfeor3cwkult1khjh55sm7hp172tns/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /stream_configs/mnjfeor3cwkult1khjh55sm7hp172tns/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 52

{
  "activeGrantsCount" : 1,
  "canDelete" : false
}

36.9.2. Delete stream config

A DELETE request is used to delete a stream config.

$ curl 'http://api.example.com/stream_configs/c082e097545948dcbd0cf993128d3fc2' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'
DELETE /stream_configs/c082e097545948dcbd0cf993128d3fc2 HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

36.10. StreamConfig search endpoints

36.10.1. /stream_configs/search/findByStream

Returns all stream configs for given Stream.

Parameter Description

stream

A valid URI of an existing Stream

 
GET /stream_configs/search/findByStream?stream=http%3A%2F%2Flocalhost%2Fstreams%2F066f5944d16344f88c9214d240d139dc HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 56142

{
  "_embedded" : {
    "stream_configs" : [ {
      "properties" : {
        "segment.ms" : "696969"
      },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "c082e097545948dcbd0cf993128d3fc2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "264821e7c2234358989e766dbfbbb4bc",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv9_with_revoked_app_access_only",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv9",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just revoked app_access configured",
          "uid" : "3b7963da58d7445bbf7a900782713069",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "78b237531a614ddda15bf13737defb7d",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv10",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenantaenv22",
            "emailAddress" : null,
            "uid" : "66625b8c334d48ac88abff939e9cf453",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv10",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "3gr4e2046dad49468e0848571982a4b8",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "b842e097545948dcbd0cf993128d3fc2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv7_with_app_access_only",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv7",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_access configured",
          "uid" : "48dd87236ec445138330adb1a8a79f7e",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "2f9ee6ce053c46b0932358c8503a2697",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaprivenv3",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaprivenv3",
          "color" : "#80affe",
          "visibility" : "private",
          "description" : "environment",
          "uid" : "72c1b34b0c6744dcadb85f4c188518f6",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "eab92b9s6c4c44b49be1a9fe28ca7463",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv9_with_app_principal_and_credential",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantapublicenv9",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with app access and grant configured",
          "uid" : "73f73e918d49430fbf1d8cc7494d24d4",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "1e9ee6ce053c46b0932358c8503a2686",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv2",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv2",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "e11ee2dd976647109ca904dd8adc050f",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "eab92b9s6c4c44b49be1a9fe28cs67gh",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv6_with_app_principal",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv6",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment with just app_principal configured",
          "uid" : "e26e0006c5504351a58e3181066cf56a",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "tenant_a_stream1_config_00000000",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv_with_ksml",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenvks",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "single cluster environment for ksml",
          "uid" : "ENV-tenanta-public-single-clustr",
          "created_at" : "2024-06-07T23:16:23",
          "modified_at" : "2024-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

36.10.2. /stream_configs/search/findByEnvironment

Returns configurations of all available streams for given Environment.

Parameter Description

environment

A valid URI of an existing Environment

 
GET /stream_configs/search/findByEnvironment?environment=http%3A%2F%2Flocalhost%2Fenvironments%2F047ab08009fe4da8be6905b55552ab52 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 55359

{
  "_embedded" : {
    "stream_configs" : [ {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "3f9ee6c3rg3c46b0932358c8503a2687",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream2",
          "properties" : { },
          "tags" : [ ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : {
            "level" : "L2",
            "description" : "This is level 2",
            "color" : "yellow",
            "uid" : "247ab03ffafe4da2bet905b5e352ab53",
            "created_at" : "2019-06-08T23:16:23",
            "modified_at" : "2019-06-08T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "confidentiality" : {
            "level" : "L2",
            "description" : "L2 confidentiality",
            "color" : "blue",
            "uid" : "648ab08009fe4da8be6905b55552ac43",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "retentionPolicy" : "delete",
          "description" : "description",
          "uid" : "a549f500d879419c9f5efa5d3cada7b3",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "48dc0975459bd0cf99c082e3128d3fc2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream-avro-avro",
          "properties" : { },
          "tags" : [ ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream-avro-avro",
          "uid" : "4d245949d1694066f4f69c91e0d420dc",
          "created_at" : "2022-06-07T13:16:23",
          "modified_at" : "2022-06-07T13:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "c082e04254dc48dcbd0cf993128d3fc2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream-string-string",
          "properties" : { },
          "tags" : [ ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication2",
            "emailAddress" : null,
            "uid" : "88eb98e0eff34fde923c15687e6d75d5",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description",
          "uid" : "a532f500d879419fff5efa5d3cada7b3",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "c082e04254dc48dcbd0cf993420d3fc2",
      "created_at" : "2022-06-07T23:16:23",
      "modified_at" : "2022-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream-string-avro",
          "properties" : { },
          "tags" : [ "tag" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream-string-avro",
          "uid" : "066f5944d16944f88c91e4d240d139dc",
          "created_at" : "2022-06-07T23:16:23",
          "modified_at" : "2022-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : {
        "segment.ms" : "696969"
      },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "c082e097545948dcbd0cf993128d3fc2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "tAg2", "TAG1", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "e02fdd3a96d84d5d81c703e6c3084d8f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream-protobuf-protobuf",
          "properties" : { },
          "tags" : [ ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "155ade4f3ad644ab95d317172cc7fe4c",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "f420e04254dc48d69d0cf993420d3fc2",
      "created_at" : "2022-06-07T23:16:23",
      "modified_at" : "2022-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream-avro-string",
          "properties" : { },
          "tags" : [ ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream-avro-string",
          "uid" : "066f5949d16944f69c91e4d240d420dc",
          "created_at" : "2022-06-07T13:16:23",
          "modified_at" : "2022-06-07T13:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "jsonSchema_streamConfig000000000",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta_byok_stream_jsonSchema",
          "properties" : { },
          "tags" : [ ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-json-stream1",
          "uid" : "tenanta_nonByok_jsonSchema_stream",
          "created_at" : "2024-06-07T23:16:23",
          "modified_at" : "2024-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    }, {
      "properties" : { },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "tenanta_resource_managers_strconfig1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream-string-resource-managers",
          "properties" : { },
          "tags" : [ ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Team with two resource managers",
            "emailAddress" : null,
            "uid" : "GroupWithTwoResourceManagers0000",
            "created_at" : "2025-06-07T23:16:23",
            "modified_at" : "2025-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description",
          "uid" : "tenanta_resource_managers_stream1",
          "created_at" : "2021-06-07T23:16:23",
          "modified_at" : "2021-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

36.10.3. /stream_configs/search/findByStreamAndEnvironment

Returns the configuration of the given Stream for given Environment.

Parameter Description

stream

A valid URI of an existing Stream

environment

A valid URI of an existing Environment

 
GET /stream_configs/search/findByStreamAndEnvironment?stream=http%3A%2F%2Flocalhost%2Fstreams%2F066f5944d16344f88c9214d240d139dc&environment=http%3A%2F%2Flocalhost%2Fenvironments%2F047ab08009fe4da8be6905b55552ab52 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 6547

{
  "_embedded" : {
    "stream_configs" : [ {
      "properties" : {
        "segment.ms" : "696969"
      },
      "retentionTime" : 10000,
      "partitions" : 12,
      "uid" : "c082e097545948dcbd0cf993128d3fc2",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "stream" : {
          "_links" : {
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "valueSchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for value"
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "keySchema" : {
              "href" : "...",
              "templated" : true,
              "title" : "The AVRO schema configured for key"
            },
            "confidentiality" : {
              "href" : "...",
              "templated" : true,
              "title" : "The confidentiality configured for the object"
            },
            "integrity" : {
              "href" : "...",
              "templated" : true,
              "title" : "The integrity configured for the object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenanta-stream1",
          "properties" : {
            "key-1" : "696969",
            "key-3" : "696969",
            "key-2" : "60000"
          },
          "tags" : [ "TAG1", "tAg2", "avro" ],
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Stream-tenAApplication1",
            "emailAddress" : null,
            "uid" : "2d8e99afd6e047f69c9595b4f2525fa6",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "integrity" : null,
          "confidentiality" : null,
          "retentionPolicy" : "delete",
          "description" : "description_tenanta-stream1",
          "uid" : "066f5944d16344f88c9214d240d139dc",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : "strauthor@tenanta.nl",
          "modified_by" : "strauthor@tenanta.nl"
        },
        "environment" : {
          "_links" : {
            "instance" : {
              "href" : "...",
              "templated" : true,
              "title" : "An instance"
            },
            "viewers" : {
              "href" : "...",
              "templated" : true
            },
            "owners" : {
              "href" : "...",
              "templated" : true,
              "title" : "The group responsible for this object"
            },
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "tenantaenv1",
          "owners" : {
            "_links" : {
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "shortName" : "tenantaenv1",
          "color" : "#80affe",
          "visibility" : "public",
          "description" : "environment",
          "uid" : "047ab08009fe4da8be6905b55552ab52",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "streamConfig" : {
          "href" : "...",
          "title" : "A configuration of a stream"
        },
        "edit" : {
          "href" : "...",
          "title" : "Indication that this entity can be edited"
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        },
        "keySchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for key"
        },
        "stream" : {
          "href" : "...",
          "templated" : true,
          "title" : "A stream"
        },
        "valueSchemaVersion" : {
          "href" : "...",
          "templated" : true,
          "title" : "A version of an AVRO schema configured for value"
        },
        "environment" : {
          "href" : "...",
          "templated" : true,
          "title" : "An environment"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "createStreamConfig" : {
      "href" : "...",
      "templated" : true
    },
    "viewStreamConfig" : {
      "href" : "...",
      "templated" : true
    }
  }
}

36.11. StreamConfig Browse Permission Group

36.11.1. Grant browse permission to users

A POST request is used to grant browse permission to users. The users added to a stream’s permission group will get access to browse the given stream anymore.

This request is only allowed to Stream Owner of the stream.

Curl request
$ curl 'http://api.example.com/stream_configs/c082e097545948dcbd0cf993128d3fc2/permissions' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "type" : "browse",
  "users" : [ "dc67596abe224691a363a230ca1e291e" ]
}'
HTTP request
POST /stream_configs/c082e097545948dcbd0cf993128d3fc2/permissions HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 75
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "type" : "browse",
  "users" : [ "dc67596abe224691a363a230ca1e291e" ]
}
HTTP response
HTTP/1.1 204 No Content

36.11.2. Grant browse permission to users and groups

A POST request is used to grant browse permission to users andgroups. The users and group members added to a stream’s permission group will get access to browse the given stream.

This request is only allowed to Stream Owner of the stream.

Curl request
$ curl 'http://api.example.com/stream_configs/c082e097545948dcbd0cf993128d3fc2/permissions' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "type" : "browse",
  "users" : [ "ea0e7f147df84179a151bdc21f5bb813" ],
  "groups" : [ "aac290536035440e9a85f193e4affeb3" ]
}'
HTTP request
POST /stream_configs/c082e097545948dcbd0cf993128d3fc2/permissions HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 128
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "type" : "browse",
  "users" : [ "ea0e7f147df84179a151bdc21f5bb813" ],
  "groups" : [ "aac290536035440e9a85f193e4affeb3" ]
}
HTTP response
HTTP/1.1 204 No Content
Attempting to grant browse permission for an Instance with granularBrowsePermissions=false

In case the Instance used by the Stream-Config has granularBrowsePermissions=false, we return 400 Bad Request

HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
Content-Length: 158

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Granular Browse Permission is disabled for this instance" ],
  "subErrors" : null
}
Attempting to grant browse permission for a PRIVATE or AUTO environment

In case the Environment used by the Stream-Config has visibility=PRIVATE or authorizationIssuer=AUTO, we return 400 Bad Request

HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
Content-Length: 234

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Permission groups are only supported for public environments or environments with the authorization issuer set to ‘stream owner’" ],
  "subErrors" : null
}
Attempting to grant not-browse permission

In case the type of the grant present in the request is not browse, we return 400 Bad Request

HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
Content-Length: 145

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Unsupported permission group type specified" ],
  "subErrors" : null
}
Attempting to grant browse permission for self

In case the users present in the request contains the stream owner requesting the grant, we return 400 Bad Request

HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
Content-Length: 155

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Logged in user can not be added to a permission group" ],
  "subErrors" : null
}
Attempting to grant browse permission for invalid users

In case the users present in the request are not valid, we return 400 Bad Request

HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
Content-Length: 129

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Non existing user specified" ],
  "subErrors" : null
}
Attempting to grant browse permission for invalid groups

In case the groups present in the request are not valid, we return 400 Bad Request

HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
Content-Length: 130

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Non existing group specified" ],
  "subErrors" : null
}

36.11.3. Revoke browse permission to users

A DELETE request is used to revoke browse permission to users. The users revoked from a stream’s permission group won’t get access to browse the given stream anymore.

This request is only allowed to Stream Owner of the stream.

Curl request
$ curl 'http://api.example.com/stream_configs/c082e097545948dcbd0cf993128d3fc2/permissions' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "type" : "browse",
  "users" : [ "dc67596abe224691a363a230ca1e291e" ]
}'
HTTP request
DELETE /stream_configs/c082e097545948dcbd0cf993128d3fc2/permissions HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 75
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "type" : "browse",
  "users" : [ "dc67596abe224691a363a230ca1e291e" ]
}
HTTP response
HTTP/1.1 204 No Content
Attempting to revoke browse permission for an Instance with granularBrowsePermissions=false

In case the Instance used by the Stream-Config has granularBrowsePermissions=false, we return 400 Bad Request

HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
Content-Length: 158

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Granular Browse Permission is disabled for this instance" ],
  "subErrors" : null
}
Attempting to revoke browse permission for a PRIVATE or AUTO environment

In case the Environment used by the Stream-Config has visibility=PRIVATE or authorizationIssuer=AUTO, we return 400 Bad Request

HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
Content-Length: 234

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Permission groups are only supported for public environments or environments with the authorization issuer set to ‘stream owner’" ],
  "subErrors" : null
}
Attempting to revoke browse permission for invalid users

In case the users present in the request are not valid, we return 400 Bad Request

HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
Content-Length: 129

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Non existing user specified" ],
  "subErrors" : null
}

36.11.4. Get users from permission group

A GET request is used only by STREAM_OWNERS to get users from permission group.

HTTP request
GET /stream_configs/c082e097545948dcbd0cf993128d3fc2/permissions?type=BROWSE HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1515

[ {
  "uid" : "ea0e7f147df84179a151bdc21f5bb813",
  "firstName" : "tenAdmin",
  "lastName" : "TenantA",
  "middleName" : "middleName",
  "emailAddress" : {
    "email" : "tenadmin@tenanta.nl"
  },
  "name" : null,
  "type" : "USER",
  "created_at" : "2022-10-17T23:16:23",
  "created_by" : "strauthor@tenanta.nl",
  "modified_at" : "2022-10-17T23:16:23",
  "modified_by" : "strauthor@tenanta.nl"
}, {
  "uid" : "dc67596abe224691a363a230ca1e291e",
  "firstName" : "regular",
  "lastName" : "user",
  "middleName" : null,
  "emailAddress" : {
    "email" : "regularuser@tenanta.nl"
  },
  "name" : null,
  "type" : "USER",
  "created_at" : "2022-10-17T23:16:23",
  "created_by" : "strauthor@tenanta.nl",
  "modified_at" : "2022-10-17T23:16:23",
  "modified_by" : "strauthor@tenanta.nl"
}, {
  "uid" : "c339c5cf9b5a4f6b8342c6ea2f9b6775",
  "firstName" : null,
  "lastName" : null,
  "middleName" : null,
  "emailAddress" : null,
  "name" : "Application-tenAApplication1",
  "type" : "GROUP",
  "created_at" : "2022-10-17T23:16:23",
  "created_by" : "strauthor@tenanta.nl",
  "modified_at" : "2022-10-17T23:16:23",
  "modified_by" : "strauthor@tenanta.nl"
}, {
  "uid" : "aac290536035440e9a85f193e4affeb3",
  "firstName" : null,
  "lastName" : null,
  "middleName" : null,
  "emailAddress" : null,
  "name" : "Environment-tenAenv1",
  "type" : "GROUP",
  "created_at" : "2022-10-17T23:16:23",
  "created_by" : "strauthor@tenanta.nl",
  "modified_at" : "2022-10-17T23:16:23",
  "modified_by" : "strauthor@tenanta.nl"
} ]
Attempting to get browse permission users with invalid type

In case the type of the grant present in the request is not browse, we return 400 Bad Request

HTTP request
GET /stream_configs/c082e097545948dcbd0cf993128d3fc2/permissions?type=xxx HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 145

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Unsupported permission group type specified" ],
  "subErrors" : null
}
Attempting to get browse permission users for an Instance with granularBrowsePermissions=false

In case the Instance used by the Stream-Config has granularBrowsePermissions=false, we return 400 Bad Request

HTTP request
GET /stream_configs/3f9ee6ce053c46b0932358c8503a2687/permissions?type=BROWSE HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 158

{
  "status" : "BAD_REQUEST",
  "message" : "Bad request",
  "errors" : [ "Granular Browse Permission is disabled for this instance" ],
  "subErrors" : null
}

36.12. StreamConfig Data Masking

36.12.1. Store key/value Masking Fields for a StreamConfig

A PUT request is used to store the key/value Masking Fields for a StreamConfig. This endpoint always expects the full list of masked fields to be stored. The fields that are not strictly masked at the schema level, can be strictly masked in the streamConfig level.

If a field is strictly masked at StreamConfig level, it cannot be overridden at Environment level.
Request fields
Path Type Description Constraints

keyFields

Array

A list of key schema fields to be masked

valueFields

Array

A list of value schema fields to be masked

keyFields[].name

String

A name of the schema’s field to be masked. The masked fields are identified by the Field name, in case of Schema having internal Schema, the field will be identified like path.to.nested.field

keyFields[].isStrict

Boolean

A boolean value to enforce strict masking. If true, the environment owners cannot override the setting in the environment level
Curl request
$ curl 'http://api.example.com/stream_configs/c082e097545948dcbd0cf993128d3fc2/fields' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "keyFields" : [ {
    "name" : "name",
    "isStrict" : false
  } ],
  "valueFields" : [ {
    "name" : "value",
    "isStrict" : true
  } ]
}'
HTTP request
PUT /stream_configs/c082e097545948dcbd0cf993128d3fc2/fields HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Content-Length: 146
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "keyFields" : [ {
    "name" : "name",
    "isStrict" : false
  } ],
  "valueFields" : [ {
    "name" : "value",
    "isStrict" : true
  } ]
}
HTTP response
HTTP/1.1 204 No Content

36.12.2. Get Masking Fields for a StreamConfig

A GET request is used to retrieve the key/value Masking Fields for a StreamConfig.

Curl request
$ curl 'http://api.example.com/stream_configs/48dc0975459bd0cf99c082e3128d3fc2/fields' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /stream_configs/48dc0975459bd0cf99c082e3128d3fc2/fields HTTP/1.1
Content-Type: application/json
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 601

{
  "keyFields" : [ ],
  "valueFields" : [ {
    "name" : "random1",
    "isStrict" : true,
    "isMasked" : true,
    "isStrictEditable" : false,
    "isMaskedEditable" : false
  }, {
    "name" : "random2",
    "isStrict" : false,
    "isMasked" : true,
    "isStrictEditable" : true,
    "isMaskedEditable" : true
  }, {
    "name" : "random3",
    "isStrict" : true,
    "isMasked" : true,
    "isStrictEditable" : true,
    "isMaskedEditable" : false
  }, {
    "name" : "random4",
    "isStrict" : true,
    "isMasked" : true,
    "isStrictEditable" : true,
    "isMaskedEditable" : true
  } ]
}

36.12.3. Unmask Masked Fields

A GET request is used to unmask key/value Masking Fields for a StreamConfig.

Curl request
$ curl 'http://api.example.com/stream_configs/f0c9969bbd2f4ce69380e65976b7fed1/browse-config?selectedCluster=BYOKClusterForApacheKafka&unmask=true&keyword=test&fromTimestamp=1692368520065&toTimestamp=1692372120065' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /stream_configs/f0c9969bbd2f4ce69380e65976b7fed1/browse-config?selectedCluster=BYOKClusterForApacheKafka&unmask=true&keyword=test&fromTimestamp=1692368520065&toTimestamp=1692372120065 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 755

{
  "bootstrapUrls" : "cluster-bootstrap",
  "brokerProtocolType" : "cluster-protocol-type",
  "resolvedTopicName" : "BYOKtenant-BYOKKAFKA-BYOKEnvPlainKafka-tenantbyok-topic1-apache-kafka",
  "keyType" : "STRING",
  "valueType" : "STRING",
  "brokerAuthConfigs" : {
    "broker.password" : "cluster-password",
    "broker.ca.certs" : "cluster-ca-cert",
    "broker.username" : "cluster-username",
    "broker.security.protocol.type" : "cluster-security-protocol-type",
    "broker.ca.validation" : "cluster-ca-validation"
  },
  "schemaRegistryUrls" : "schema-registry-url",
  "srProtocolType" : "No-Auth",
  "srType" : null,
  "srAuthConfigs" : {
    "sr.ca.certs" : "schema-registry-ca-cert"
  },
  "keyMaskedFields" : [ ],
  "valueMaskedFields" : [ ]
}

37. Schemas

A Schema is an AVRO definition formatted in JSON. Schemas are used by Streams of data type AVRO.

The schemas resource is used to create and list Schemas.

37.1. JSON Schema

The schemas resource uses the following json-schema:

37.1.1. HTTP request

GET /schemas HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

37.1.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 14034

{
  "_embedded" : {
    "schemas" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "io.axual.qa.general.Rand",
      "type" : "AVRO",
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "description" : "Rand schema",
      "uid" : "069a916a808584253e138s2e4d480569",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenantb.Random",
      "type" : "AVRO",
      "owners" : null,
      "description" : "Random schema",
      "uid" : "092d480569fe069aef6a8053e138s0de",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-proto-schema1",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "Tenanta Protobuf Schema",
      "uid" : "480a4c8bc786468dac90a0a90277f93e",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-proto-schema-no-stream",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "Tenanta Protobuf Schema",
      "uid" : "561d5e1e9aaa4b1ea4281144d707b1e3",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "io.axual.qa.general.Random",
      "type" : "AVRO",
      "owners" : null,
      "description" : "Demo schema",
      "uid" : "858d48056942069a916a8053e138s2e4",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.value-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "8bc19be0c9cd4da296acd78e6022edf1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenantb.key-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "8e37406569d64f32bf7cfb837993dc77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-schema2",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "a32ead9183734d838e32c8454af9f3f5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.value-proto-schema1",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "Tenanta Protobuf Schema",
      "uid" : "a40825c3d01444f697a6554156cee72a",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "io.axual.general.Random",
      "type" : "AVRO",
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "description" : "Random schema",
      "uid" : "a8085842069a91653e138s2e4d480569",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenantb.value-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "af8f33ce859a47bd9a92fa3b052e7069",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.value-json-schema1",
      "type" : "JSON_SCHEMA",
      "owners" : null,
      "description" : "Tenanta JSON Schema",
      "uid" : "b39e91761d684f048272cfbbb6219688",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-avro-schema3",
      "type" : "AVRO",
      "owners" : null,
      "description" : "Tenanta schema 3",
      "uid" : "b58073b2caeb4474aa3c6e8c269d919e",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.key-json-schema1",
      "type" : "JSON_SCHEMA",
      "owners" : null,
      "description" : "Tenanta JSON Schema",
      "uid" : "b90f502e4ab24b1b9476ff3236eefdb4",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.keyProtoSchema",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "TenantBYOK Protobuf Schema",
      "uid" : "byokkschemaa1114d4b1ea4281707b1s",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.key-proto-schema",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "TenantBYOK Protobuf Schema",
      "uid" : "byokkschemaa4b1ea42811114d707b1s",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.key-avro-schema3",
      "type" : "AVRO",
      "owners" : null,
      "description" : "Tenant BYOK schema AVRO",
      "uid" : "byokschema_avro",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.value-proto-schema",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "TenantBYOK Protobuf Schema",
      "uid" : "byokvschemaa4b1ea42812214d707b1s",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.value-schema2",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "dae551f956af48c1baa53281b5edca00",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 25,
    "totalPages" : 2,
    "number" : 0
  }
}

37.2. List all schemas

A GET request will list all the Schemas visible to the currently logged in user.

37.2.1. Curl request

$ curl 'http://api.example.com/schemas' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

37.2.2. HTTP request

GET /schemas HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

37.2.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 14034

{
  "_embedded" : {
    "schemas" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "io.axual.qa.general.Rand",
      "type" : "AVRO",
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "description" : "Rand schema",
      "uid" : "069a916a808584253e138s2e4d480569",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenantb.Random",
      "type" : "AVRO",
      "owners" : null,
      "description" : "Random schema",
      "uid" : "092d480569fe069aef6a8053e138s0de",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-proto-schema1",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "Tenanta Protobuf Schema",
      "uid" : "480a4c8bc786468dac90a0a90277f93e",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-proto-schema-no-stream",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "Tenanta Protobuf Schema",
      "uid" : "561d5e1e9aaa4b1ea4281144d707b1e3",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "io.axual.qa.general.Random",
      "type" : "AVRO",
      "owners" : null,
      "description" : "Demo schema",
      "uid" : "858d48056942069a916a8053e138s2e4",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.value-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "8bc19be0c9cd4da296acd78e6022edf1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenantb.key-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "8e37406569d64f32bf7cfb837993dc77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-schema2",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "a32ead9183734d838e32c8454af9f3f5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.value-proto-schema1",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "Tenanta Protobuf Schema",
      "uid" : "a40825c3d01444f697a6554156cee72a",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "io.axual.general.Random",
      "type" : "AVRO",
      "owners" : {
        "_links" : {
          "resourceManagers" : {
            "href" : "...",
            "templated" : true
          },
          "members" : [ {
            "href" : "...",
            "templated" : true,
            "title" : "Users belonging to this group"
          } ],
          "managers" : {
            "href" : "...",
            "templated" : true
          },
          "self" : {
            "href" : "...",
            "templated" : true,
            "title" : "URI pointing to current request"
          }
        },
        "name" : "Environment-tenAenv1",
        "emailAddress" : null,
        "uid" : "aac290536035440e9a85f193e4affeb3",
        "created_at" : "2018-06-07T23:16:23",
        "modified_at" : "2018-06-07T23:16:23",
        "created_by" : null,
        "modified_by" : null
      },
      "description" : "Random schema",
      "uid" : "a8085842069a91653e138s2e4d480569",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenantb.value-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "af8f33ce859a47bd9a92fa3b052e7069",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.value-json-schema1",
      "type" : "JSON_SCHEMA",
      "owners" : null,
      "description" : "Tenanta JSON Schema",
      "uid" : "b39e91761d684f048272cfbbb6219688",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-avro-schema3",
      "type" : "AVRO",
      "owners" : null,
      "description" : "Tenanta schema 3",
      "uid" : "b58073b2caeb4474aa3c6e8c269d919e",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.key-json-schema1",
      "type" : "JSON_SCHEMA",
      "owners" : null,
      "description" : "Tenanta JSON Schema",
      "uid" : "b90f502e4ab24b1b9476ff3236eefdb4",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.keyProtoSchema",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "TenantBYOK Protobuf Schema",
      "uid" : "byokkschemaa1114d4b1ea4281707b1s",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.key-proto-schema",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "TenantBYOK Protobuf Schema",
      "uid" : "byokkschemaa4b1ea42811114d707b1s",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.key-avro-schema3",
      "type" : "AVRO",
      "owners" : null,
      "description" : "Tenant BYOK schema AVRO",
      "uid" : "byokschema_avro",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.value-proto-schema",
      "type" : "PROTOBUF",
      "owners" : null,
      "description" : "TenantBYOK Protobuf Schema",
      "uid" : "byokvschemaa4b1ea42812214d707b1s",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.value-schema2",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "dae551f956af48c1baa53281b5edca00",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 25,
    "totalPages" : 2,
    "number" : 0
  }
}

37.3. List all schema names only

Sometimes, fetching the schema names might be enough instead of fetching the complete object. For e.g. in displaying drop-down forms. To get schema names only, use the same GET call as above but add a parameter projection with value names.

37.3.1. Query parameters

Parameter Description

projection

There is only 1 valid value: names

37.3.2. Curl request

$ curl 'http://api.example.com/schemas?projection=names' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

37.3.3. HTTP request

GET /schemas?projection=names HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

37.3.4. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 10648

{
  "_embedded" : {
    "schemas" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "io.axual.qa.general.Rand",
      "uid" : "069a916a808584253e138s2e4d480569",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenantb.Random",
      "uid" : "092d480569fe069aef6a8053e138s0de",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-proto-schema1",
      "uid" : "480a4c8bc786468dac90a0a90277f93e",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-schema1",
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-proto-schema-no-stream",
      "uid" : "561d5e1e9aaa4b1ea4281144d707b1e3",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "io.axual.qa.general.Random",
      "uid" : "858d48056942069a916a8053e138s2e4",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.value-schema1",
      "uid" : "8bc19be0c9cd4da296acd78e6022edf1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenantb.key-schema1",
      "uid" : "8e37406569d64f32bf7cfb837993dc77",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-schema2",
      "uid" : "a32ead9183734d838e32c8454af9f3f5",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.value-proto-schema1",
      "uid" : "a40825c3d01444f697a6554156cee72a",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "io.axual.general.Random",
      "uid" : "a8085842069a91653e138s2e4d480569",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenantb.value-schema1",
      "uid" : "af8f33ce859a47bd9a92fa3b052e7069",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.value-json-schema1",
      "uid" : "b39e91761d684f048272cfbbb6219688",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-avro-schema3",
      "uid" : "b58073b2caeb4474aa3c6e8c269d919e",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.key-json-schema1",
      "uid" : "b90f502e4ab24b1b9476ff3236eefdb4",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.keyProtoSchema",
      "uid" : "byokkschemaa1114d4b1ea4281707b1s",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.key-proto-schema",
      "uid" : "byokkschemaa4b1ea42811114d707b1s",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.key-avro-schema3",
      "uid" : "byokschema_avro",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "byok.tenant.value-proto-schema",
      "uid" : "byokvschemaa4b1ea42812214d707b1s",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.value-schema2",
      "uid" : "dae551f956af48c1baa53281b5edca00",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 25,
    "totalPages" : 2,
    "number" : 0
  }
}

37.4. List all schemas with the latest schema versions

A GET request will list all schemas with the latest schema versions for every schema visible to the currently logged in user.

37.4.1. Curl request

$ curl 'http://api.example.com/schemas/getAllWithLatestSchemaVersion' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

37.4.2. HTTP request

GET /schemas/getAllWithLatestSchemaVersion HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

37.4.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 7375

[ {
  "schemaUid" : "069a916a808584253e138s2e4d480569",
  "schemaName" : "io.axual.qa.general.Rand",
  "type" : "AVRO",
  "latestSchemaVersionUid" : "a805069b9163e1858d480568s2f69423",
  "latestSchemaVersion" : "0.0.2",
  "latestSchemaVersionBody" : "{\"type\":\"record\",\"name\":\"Rand\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
  "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "480a4c8bc786468dac90a0a90277f93e",
  "schemaName" : "nl.tenanta.key-proto-schema1",
  "type" : "PROTOBUF",
  "latestSchemaVersionUid" : "f7059e7675cd4c439d6f8ca5a31d8b53",
  "latestSchemaVersion" : "0.0.1",
  "latestSchemaVersionBody" : "keySchemaBody1",
  "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "4edccfd6aa744e698542da36f1f01114",
  "schemaName" : "nl.tenanta.key-schema1",
  "type" : "AVRO",
  "latestSchemaVersionUid" : "b5c0a6b2fdd94d64925fd2fadb367f2d",
  "latestSchemaVersion" : "v2",
  "latestSchemaVersionBody" : "schemaBody",
  "latestSchemaVersionCreatedAt" : "2018-06-07T23:16:23",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "561d5e1e9aaa4b1ea4281144d707b1e3",
  "schemaName" : "nl.tenanta.key-proto-schema-no-stream",
  "type" : "PROTOBUF",
  "latestSchemaVersionUid" : "480dffd4cff042e4a50317b7e4c3eae2",
  "latestSchemaVersion" : "V1",
  "latestSchemaVersionBody" : "keySchemaBodyV1",
  "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "858d48056942069a916a8053e138s2e4",
  "schemaName" : "io.axual.qa.general.Random",
  "type" : "AVRO",
  "latestSchemaVersionUid" : "858d48056942069b916a8053e138s2f6",
  "latestSchemaVersion" : "0.0.1",
  "latestSchemaVersionBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
  "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "8bc19be0c9cd4da296acd78e6022edf1",
  "schemaName" : "nl.tenanta.value-schema1",
  "type" : "AVRO",
  "latestSchemaVersionUid" : "c633a9d3badb4fa0861965246be645a2",
  "latestSchemaVersion" : "v2",
  "latestSchemaVersionBody" : "schemaBody1",
  "latestSchemaVersionCreatedAt" : "2018-06-07T23:16:23",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "a32ead9183734d838e32c8454af9f3f5",
  "schemaName" : "nl.tenanta.key-schema2",
  "type" : "AVRO",
  "latestSchemaVersionUid" : "8152f72742cd4c6db07b9a71a825fe4f",
  "latestSchemaVersion" : "v2",
  "latestSchemaVersionBody" : "schemaBody",
  "latestSchemaVersionCreatedAt" : "2018-06-07T23:16:23",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "a40825c3d01444f697a6554156cee72a",
  "schemaName" : "nl.tenanta.value-proto-schema1",
  "type" : "PROTOBUF",
  "latestSchemaVersionUid" : "e70f5a811af643a981ec7d2c07e1cf01",
  "latestSchemaVersion" : "0.0.1",
  "latestSchemaVersionBody" : "valueSchemaBody",
  "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "a8085842069a91653e138s2e4d480569",
  "schemaName" : "io.axual.general.Random",
  "type" : "AVRO",
  "latestSchemaVersionUid" : "3e185a805069b91639428d480568s2f69423",
  "latestSchemaVersion" : "0.0.2",
  "latestSchemaVersionBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random1\",\"type\":\"string\",\"doc\":\"The random1 value.\"},{\"name\":\"random2\",\"type\":\"string\",\"doc\":\"The random2 value.\"},{\"name\":\"random3\",\"type\":\"string\",\"doc\":\"The random3 value.\"},{\"name\":\"random4\",\"type\":\"string\",\"doc\":\"The random4 value.\"}]}",
  "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "b58073b2caeb4474aa3c6e8c269d919e",
  "schemaName" : "nl.tenanta.key-avro-schema3",
  "type" : "AVRO",
  "latestSchemaVersionUid" : "659d8cc539c743ec8c052700dae3a081",
  "latestSchemaVersion" : "0.0.1",
  "latestSchemaVersionBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
  "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "byokkschemaa1114d4b1ea4281707b1s",
  "schemaName" : "nl.tenanta.keyProtoSchema",
  "type" : "PROTOBUF",
  "latestSchemaVersionUid" : "byokkschemaversiond4b1ea428170",
  "latestSchemaVersion" : "0.0.1",
  "latestSchemaVersionBody" : "keySchemaBody",
  "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "dae551f956af48c1baa53281b5edca00",
  "schemaName" : "nl.tenanta.value-schema2",
  "type" : "AVRO",
  "latestSchemaVersionUid" : "0aa818df699847d08c24f75a4a7399ed",
  "latestSchemaVersion" : "v1",
  "latestSchemaVersionBody" : "schemaBody1",
  "latestSchemaVersionCreatedAt" : "2018-06-07T23:16:23",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "json_schema_key_used000000000000",
  "schemaName" : "JsonSchema-KeyName",
  "type" : "JSON_SCHEMA",
  "latestSchemaVersionUid" : "json_schema_key_used_version_000",
  "latestSchemaVersion" : "V1",
  "latestSchemaVersionBody" : "existingUsedKeyJsonSchemaBodyV1",
  "latestSchemaVersionCreatedAt" : "2024-09-02T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "json_schema_value_used0000000000",
  "schemaName" : "JsonSchema-ValueName",
  "type" : "JSON_SCHEMA",
  "latestSchemaVersionUid" : "json_schema_value_used_version_0",
  "latestSchemaVersion" : "V1",
  "latestSchemaVersionBody" : "existingUsedValueJsonSchemaBodyV1",
  "latestSchemaVersionCreatedAt" : "2024-09-02T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
}, {
  "schemaUid" : "json_schema000000000000000000000",
  "schemaName" : "JsonSchema-schemaName",
  "type" : "JSON_SCHEMA",
  "latestSchemaVersionUid" : "json_schema_version_000000000001",
  "latestSchemaVersion" : "V2",
  "latestSchemaVersionBody" : "existingJsonSchemaBodyV1",
  "latestSchemaVersionCreatedAt" : "2024-09-02T00:00:00",
  "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA"
} ]

A GET request will list all schemas with the latest schema versions and links for every schema visible to the currently logged in user.

$ curl 'http://api.example.com/schemas/includeSchemaVersions?filter=latest' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
GET /schemas/includeSchemaVersions?filter=latest HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 12726

{
  "_embedded" : {
    "schemas" : [ {
      "schemaUid" : "069a916a808584253e138s2e4d480569",
      "schemaName" : "io.axual.qa.general.Rand",
      "type" : "AVRO",
      "latestSchemaVersionUid" : "a805069b9163e1858d480568s2f69423",
      "latestSchemaVersion" : "0.0.2",
      "latestSchemaVersionBody" : "{\"type\":\"record\",\"name\":\"Rand\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
      "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : {
        "id" : "aac290536035440e9a85f193e4affeb3",
        "name" : "Environment-tenAenv1"
      },
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "480a4c8bc786468dac90a0a90277f93e",
      "schemaName" : "nl.tenanta.key-proto-schema1",
      "type" : "PROTOBUF",
      "latestSchemaVersionUid" : "f7059e7675cd4c439d6f8ca5a31d8b53",
      "latestSchemaVersion" : "0.0.1",
      "latestSchemaVersionBody" : "keySchemaBody1",
      "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "4edccfd6aa744e698542da36f1f01114",
      "schemaName" : "nl.tenanta.key-schema1",
      "type" : "AVRO",
      "latestSchemaVersionUid" : "b5c0a6b2fdd94d64925fd2fadb367f2d",
      "latestSchemaVersion" : "v2",
      "latestSchemaVersionBody" : "schemaBody",
      "latestSchemaVersionCreatedAt" : "2018-06-07T23:16:23",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "561d5e1e9aaa4b1ea4281144d707b1e3",
      "schemaName" : "nl.tenanta.key-proto-schema-no-stream",
      "type" : "PROTOBUF",
      "latestSchemaVersionUid" : "480dffd4cff042e4a50317b7e4c3eae2",
      "latestSchemaVersion" : "V1",
      "latestSchemaVersionBody" : "keySchemaBodyV1",
      "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "858d48056942069a916a8053e138s2e4",
      "schemaName" : "io.axual.qa.general.Random",
      "type" : "AVRO",
      "latestSchemaVersionUid" : "858d48056942069b916a8053e138s2f6",
      "latestSchemaVersion" : "0.0.1",
      "latestSchemaVersionBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
      "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "8bc19be0c9cd4da296acd78e6022edf1",
      "schemaName" : "nl.tenanta.value-schema1",
      "type" : "AVRO",
      "latestSchemaVersionUid" : "c633a9d3badb4fa0861965246be645a2",
      "latestSchemaVersion" : "v2",
      "latestSchemaVersionBody" : "schemaBody1",
      "latestSchemaVersionCreatedAt" : "2018-06-07T23:16:23",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "a32ead9183734d838e32c8454af9f3f5",
      "schemaName" : "nl.tenanta.key-schema2",
      "type" : "AVRO",
      "latestSchemaVersionUid" : "8152f72742cd4c6db07b9a71a825fe4f",
      "latestSchemaVersion" : "v2",
      "latestSchemaVersionBody" : "schemaBody",
      "latestSchemaVersionCreatedAt" : "2018-06-07T23:16:23",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "a40825c3d01444f697a6554156cee72a",
      "schemaName" : "nl.tenanta.value-proto-schema1",
      "type" : "PROTOBUF",
      "latestSchemaVersionUid" : "e70f5a811af643a981ec7d2c07e1cf01",
      "latestSchemaVersion" : "0.0.1",
      "latestSchemaVersionBody" : "valueSchemaBody",
      "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "a8085842069a91653e138s2e4d480569",
      "schemaName" : "io.axual.general.Random",
      "type" : "AVRO",
      "latestSchemaVersionUid" : "3e185a805069b91639428d480568s2f69423",
      "latestSchemaVersion" : "0.0.2",
      "latestSchemaVersionBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random1\",\"type\":\"string\",\"doc\":\"The random1 value.\"},{\"name\":\"random2\",\"type\":\"string\",\"doc\":\"The random2 value.\"},{\"name\":\"random3\",\"type\":\"string\",\"doc\":\"The random3 value.\"},{\"name\":\"random4\",\"type\":\"string\",\"doc\":\"The random4 value.\"}]}",
      "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : {
        "id" : "aac290536035440e9a85f193e4affeb3",
        "name" : "Environment-tenAenv1"
      },
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "b58073b2caeb4474aa3c6e8c269d919e",
      "schemaName" : "nl.tenanta.key-avro-schema3",
      "type" : "AVRO",
      "latestSchemaVersionUid" : "659d8cc539c743ec8c052700dae3a081",
      "latestSchemaVersion" : "0.0.1",
      "latestSchemaVersionBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
      "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "byokkschemaa1114d4b1ea4281707b1s",
      "schemaName" : "nl.tenanta.keyProtoSchema",
      "type" : "PROTOBUF",
      "latestSchemaVersionUid" : "byokkschemaversiond4b1ea428170",
      "latestSchemaVersion" : "0.0.1",
      "latestSchemaVersionBody" : "keySchemaBody",
      "latestSchemaVersionCreatedAt" : "2018-09-20T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "dae551f956af48c1baa53281b5edca00",
      "schemaName" : "nl.tenanta.value-schema2",
      "type" : "AVRO",
      "latestSchemaVersionUid" : "0aa818df699847d08c24f75a4a7399ed",
      "latestSchemaVersion" : "v1",
      "latestSchemaVersionBody" : "schemaBody1",
      "latestSchemaVersionCreatedAt" : "2018-06-07T23:16:23",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "json_schema_key_used000000000000",
      "schemaName" : "JsonSchema-KeyName",
      "type" : "JSON_SCHEMA",
      "latestSchemaVersionUid" : "json_schema_key_used_version_000",
      "latestSchemaVersion" : "V1",
      "latestSchemaVersionBody" : "existingUsedKeyJsonSchemaBodyV1",
      "latestSchemaVersionCreatedAt" : "2024-09-02T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "json_schema_value_used0000000000",
      "schemaName" : "JsonSchema-ValueName",
      "type" : "JSON_SCHEMA",
      "latestSchemaVersionUid" : "json_schema_value_used_version_0",
      "latestSchemaVersion" : "V1",
      "latestSchemaVersionBody" : "existingUsedValueJsonSchemaBodyV1",
      "latestSchemaVersionCreatedAt" : "2024-09-02T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    }, {
      "schemaUid" : "json_schema000000000000000000000",
      "schemaName" : "JsonSchema-schemaName",
      "type" : "JSON_SCHEMA",
      "latestSchemaVersionUid" : "json_schema_version_000000000001",
      "latestSchemaVersion" : "V2",
      "latestSchemaVersionBody" : "existingJsonSchemaBodyV1",
      "latestSchemaVersionCreatedAt" : "2024-09-02T00:00:00",
      "latestSchemaVersionCreatedByFullName" : "tenAdmin middleName TenantA",
      "owners" : null,
      "_links" : {
        "transferOwnership" : {
          "href" : "..."
        },
        "update" : {
          "href" : "..."
        },
        "delete" : {
          "href" : "...",
          "title" : "Indication that this entity can be deleted"
        }
      }
    } ]
  },
  "_links" : {
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    }
  }
}

37.6. List all schema versions of a schema

A GET request will list all schema versions of a schema visible to the currently logged-in user.

37.6.1. Curl request

$ curl 'http://api.example.com/schemas/4edccfd6aa744e698542da36f1f01114/schema-versions' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'

37.6.2. HTTP request

GET /schemas/4edccfd6aa744e698542da36f1f01114/schema-versions HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

37.6.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 363

[ {
  "schemaVersion" : "v2.1",
  "schemaVersionUid" : "5322f72742cd4c6db07b9a71a825fe4f"
}, {
  "schemaVersion" : "v2",
  "schemaVersionUid" : "b5c0a6b2fdd94d64925fd2fadb367f2d"
}, {
  "schemaVersion" : "v1.02",
  "schemaVersionUid" : "b5c0a6b2fdd94d64925fd2fadb367892"
}, {
  "schemaVersion" : "v1",
  "schemaVersionUid" : "b5c0a6b2fdd94d64925fd2fadb367891"
} ]

37.7. Retrieve a schema

The schemas/{id} resource is used to retrieve, update and delete individual schemas.

A GET request will retrieve the details of a schema.

37.7.1. HTTP request

GET /schemas/4edccfd6aa744e698542da36f1f01114 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

37.7.2. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Last-Modified: Thu, 07 Jun 2018 23:16:23 GMT
ETag: "0"
Content-Type: application/hal+json
Content-Length: 520

{
  "name" : "nl.tenanta.key-schema1",
  "type" : "AVRO",
  "description" : "",
  "owners" : null,
  "fileName" : "key-schema1.avsc",
  "uid" : "4edccfd6aa744e698542da36f1f01114",
  "created_at" : "2018-06-07T23:16:23",
  "modified_at" : "2018-06-07T23:16:23",
  "created_by" : null,
  "modified_by" : null,
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "schema" : {
      "href" : "...",
      "templated" : true,
      "title" : "A schema"
    }
  }
}

37.8. Delete a schema

37.8.1. Delete schema constraints

A GET request is used to get the constraints for deleting Schema.

Curl request
$ curl 'http://api.example.com/schemas/069a916a808584253e138s2e4d480569/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /schemas/069a916a808584253e138s2e4d480569/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 183

{
  "canDelete" : false,
  "activeStreamsCount" : 1,
  "activeStreams" : [ {
    "streamId" : "4d245949d1694066f4f69c91e0d420dc",
    "streamName" : "tenanta-stream-avro-avro"
  } ]
}

37.8.2. Delete a schema

A DELETE request will delete the schema with the related schemaVersions.

HTTP request
DELETE /schemas/b58073b2caeb4474aa3c6e8c269d919e HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN
HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers

37.9. Schema search endpoints

37.9.1. /schemas/search/findByName

Search for a schema by exact name.

Curl request
$ curl 'http://api.example.com/schemas/search/findByName?name=nl.tenanta.key-schema1' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /schemas/search/findByName?name=nl.tenanta.key-schema1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 827

{
  "_embedded" : {
    "schemas" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

37.9.2. /schemas/search/findByNameContaining

Search for a schema by name containing search term.

Curl request
$ curl 'http://api.example.com/schemas/search/findByNameContaining?name=nl.tenanta.key-schema1' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /schemas/search/findByNameContaining?name=nl.tenanta.key-schema1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 827

{
  "_embedded" : {
    "schemas" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.key-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "4edccfd6aa744e698542da36f1f01114",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

37.9.3. /schemas/search/findByNameContainingAndType

Search for a schema by name containing search term and filter by type of the schema.

Curl request
$ curl 'http://api.example.com/schemas/search/findByNameContainingAndType?name=key&type=JSON_SCHEMA' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /schemas/search/findByNameContainingAndType?name=key&type=JSON_SCHEMA HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 849

{
  "_embedded" : {
    "schemas" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "JsonSchema-KeyName",
      "type" : "JSON_SCHEMA",
      "owners" : null,
      "description" : "Tenanta JSON Schema",
      "uid" : "json_schema_key_used000000000000",
      "created_at" : "2023-09-20T00:00:00",
      "modified_at" : "2023-09-20T00:00:00",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

When the type is not specified, it will return AVRO schema type schemas.

Curl request
$ curl 'http://api.example.com/schemas/search/findByNameContainingAndType?name=nl.tenanta.value-schema1' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /schemas/search/findByNameContainingAndType?name=nl.tenanta.value-schema1 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 829

{
  "_embedded" : {
    "schemas" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "name" : "nl.tenanta.value-schema1",
      "type" : "AVRO",
      "owners" : null,
      "description" : "",
      "uid" : "8bc19be0c9cd4da296acd78e6022edf1",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

37.10. Upload schemas

Only valid and parsed Schemas can be uploaded into the Self-Service.

There is an endpoint available to validate the input schema and another endpoint to upload it into the Self-Service.

37.10.1. Check and Parse a schema

A POST request is used to check and parse a schema, it will return the parsed Schema as string.

Curl request
$ curl 'http://api.example.com/schemas/check-parse' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "schema" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The Random value.\"}]}",
  "type" : "AVRO"
}'
HTTP request
POST /schemas/check-parse HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 325
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "schema" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The Random value.\"}]}",
  "type" : "AVRO"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 524

{
  "versions" : [ "0.0.1" ],
  "fullName" : "io.axual.qa.general.Random",
  "schema" : "{\n  \"type\" : \"record\",\n  \"name\" : \"Random\",\n  \"namespace\" : \"io.axual.qa.general\",\n  \"doc\" : \"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\n  \"fields\" : [ {\n    \"name\" : \"random\",\n    \"type\" : \"string\",\n    \"doc\" : \"The Random value.\"\n  } ]\n}",
  "type" : "AVRO",
  "_links" : {
    "upload" : {
      "href" : "..."
    }
  }
}

37.10.2. Upload a schema

A POST request is used to upload a schema. You can also validate the schema before uploading by calling POST /schemas/check-parse.

Curl request
$ curl 'http://api.example.com/schemas/upload' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "schema" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The Random value.\"}]}",
  "version" : "2",
  "description" : "description",
  "type" : "AVRO"
}'
HTTP request
POST /schemas/upload HTTP/1.1
Content-Type: application/json;charset=UTF-8
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 377
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "schema" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The Random value.\"}]}",
  "version" : "2",
  "description" : "description",
  "type" : "AVRO"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 196

{
  "schemaUid" : "858d48056942069a916a8053e138s2e4",
  "schemaVersionUid" : "ad6b88b6b9804fa39b77287c62ddd2ec",
  "fullName" : "io.axual.qa.general.Random",
  "version" : "2",
  "owners" : null
}

37.10.3. Transfer schema ownership

A PATCH request is used to update the ownership of a schema.

Curl request
$ curl 'http://api.example.com/schemas/4edccfd6aa744e698542da36f1f01114/transferOwnership' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "owners" : "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775"
}'
HTTP request
PATCH /schemas/4edccfd6aa744e698542da36f1f01114/transferOwnership HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 81
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "owners" : "http://api.example.com/groups/c339c5cf9b5a4f6b8342c6ea2f9b6775"
}
HTTP response
HTTP/1.1 204 No Content

37.10.4. Store Masking Fields for a Schema

A PUT request is used to store the Masking Fields for a Schema. This endpoint always expects the full list of masked fields to be stored.

If a field is strictly masked at Schema level, it cannot be overridden at TopicConfig or Environment level and it will be always masked.
Request fields
Path Type Description Constraints

maskedFields

Array

A list of schema fields to be masked

maskedFields[].name

String

A name of the schema’s field to be masked. The masked fields are identified by the Field name, in case of Schema having internal Schema, the field will be identified like path.to.nested.field

maskedFields[].isStrict

Boolean

A boolean value to enforce strict masking. If true, topic owners cannot override the setting
Curl request
$ curl 'http://api.example.com/schemas/4edccfd6aa744e698542da36f1f01114/fields' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN' \
    -d '{
  "maskedFields" : [ {
    "name" : "source.owner",
    "isStrict" : true
  }, {
    "name" : "message",
    "isStrict" : false
  } ]
}'
HTTP request
PUT /schemas/4edccfd6aa744e698542da36f1f01114/fields HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Content-Length: 137
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

{
  "maskedFields" : [ {
    "name" : "source.owner",
    "isStrict" : true
  }, {
    "name" : "message",
    "isStrict" : false
  } ]
}
HTTP response
HTTP/1.1 204 No Content

37.10.5. Get Masking Fields for a Schema

A GET request is used to retrieve the Masking Fields for a Schema.

Curl request
$ curl 'http://api.example.com/schemas/480a4c8bc786468dac90a0a90277f93e/fields' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /schemas/480a4c8bc786468dac90a0a90277f93e/fields HTTP/1.1
Content-Type: application/json
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 319

{
  "fields" : [ {
    "name" : "id",
    "isStrict" : false,
    "isMasked" : false
  }, {
    "name" : "name",
    "isStrict" : false,
    "isMasked" : false
  }, {
    "name" : "type1",
    "isStrict" : false,
    "isMasked" : false
  }, {
    "name" : "type2",
    "isStrict" : false,
    "isMasked" : false
  } ]
}

38. Schema Version

A Schema is an AVRO definition formatted in JSON. Schemas are used by Streams of data type AVRO.

The schemas resource is used to create and list Schemas.

38.1. JSON Schema

The schemas resource uses the following json-schema:

GET /profile/schema_versions HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/schema+json
Host: api.example.com
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/schema+json
Content-Length: 1174

{
  "title" : "Schema version",
  "definitions" : { },
  "properties" : {
    "schema" : {
      "title" : "Schema",
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "uid" : {
      "title" : "Uid",
      "readOnly" : true,
      "type" : "string"
    },
    "schemaBody" : {
      "title" : "Schema body",
      "readOnly" : false,
      "type" : "string"
    },
    "modified_by" : {
      "title" : "Modified by",
      "readOnly" : false,
      "type" : "string"
    },
    "created_at" : {
      "title" : "Created at",
      "readOnly" : true,
      "type" : "string",
      "format" : "date-time"
    },
    "modified_at" : {
      "title" : "Modified at",
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "version" : {
      "title" : "Version",
      "readOnly" : false,
      "type" : "string"
    },
    "created_by" : {
      "title" : "Created by",
      "readOnly" : true,
      "type" : "string"
    },
    "avro" : {
      "title" : "Avro",
      "readOnly" : true,
      "type" : "boolean"
    }
  },
  "type" : "object",
  "$schema" : "http://json-schema.org/draft-04/schema#"
}

38.2. List all schema versions

A GET request will list all the schema versions visible to the currently logged in user.

38.2.1. Curl request

$ curl 'http://api.example.com/schema_versions' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

38.2.2. HTTP request

GET /schema_versions HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

38.2.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 31173

{
  "_embedded" : {
    "schema_versions" : [ {
      "version" : "0.0.1",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Rand\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
      "avro" : true,
      "uid" : "069858d56942b916a8053480e138s2f6",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "io.axual.qa.general.Rand",
          "type" : "AVRO",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "description" : "Rand schema",
          "uid" : "069a916a808584253e138s2e4d480569",
          "created_at" : "2018-09-20T00:00:00",
          "modified_at" : "2018-09-20T00:00:00",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v1",
      "schemaBody" : "schemaBody1",
      "avro" : true,
      "uid" : "0aa818df699847d08c24f75a4a7399ed",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.value-schema2",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "dae551f956af48c1baa53281b5edca00",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "0.0.2",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
      "avro" : true,
      "uid" : "1b6f4c0e1aa74c7c874074c4852c9123",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-avro-schema3",
          "type" : "AVRO",
          "owners" : null,
          "description" : "Tenanta schema 3",
          "uid" : "b58073b2caeb4474aa3c6e8c269d919e",
          "created_at" : "2018-09-20T00:00:00",
          "modified_at" : "2018-09-20T00:00:00",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "0.0.2",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random1\",\"type\":\"string\",\"doc\":\"The random1 value.\"},{\"name\":\"random2\",\"type\":\"string\",\"doc\":\"The random2 value.\"},{\"name\":\"random3\",\"type\":\"string\",\"doc\":\"The random3 value.\"},{\"name\":\"random4\",\"type\":\"string\",\"doc\":\"The random4 value.\"}]}",
      "avro" : true,
      "uid" : "3e185a805069b91639428d480568s2f69423",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "io.axual.general.Random",
          "type" : "AVRO",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "description" : "Random schema",
          "uid" : "a8085842069a91653e138s2e4d480569",
          "created_at" : "2018-09-20T00:00:00",
          "modified_at" : "2018-09-20T00:00:00",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "V1",
      "schemaBody" : "keySchemaBodyV1",
      "avro" : false,
      "uid" : "480dffd4cff042e4a50317b7e4c3eae2",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-proto-schema-no-stream",
          "type" : "PROTOBUF",
          "owners" : null,
          "description" : "Tenanta Protobuf Schema",
          "uid" : "561d5e1e9aaa4b1ea4281144d707b1e3",
          "created_at" : "2023-09-20T00:00:00",
          "modified_at" : "2023-09-20T00:00:00",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v1",
      "schemaBody" : "schemaBody",
      "avro" : true,
      "uid" : "5162f72742cd4c6db07b9a71a825fe4f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-schema2",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "a32ead9183734d838e32c8454af9f3f5",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v2.1",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Key\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Key.\",\"fields\":[{\"name\":\"keyName\",\"type\":\"string\",\"doc\":\"The Key.\"}]}",
      "avro" : true,
      "uid" : "5322f72742cd4c6db07b9a71a825fe4f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-schema1",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "4edccfd6aa744e698542da36f1f01114",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "0.0.1",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
      "avro" : true,
      "uid" : "555d4805694eee9b916a8053e138asde",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenantb.Random",
          "type" : "AVRO",
          "owners" : null,
          "description" : "Random schema",
          "uid" : "092d480569fe069aef6a8053e138s0de",
          "created_at" : "2018-09-20T00:00:00",
          "modified_at" : "2018-09-20T00:00:00",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "0.0.2",
      "schemaBody" : "keySchemaBody2",
      "avro" : false,
      "uid" : "5e5d2c630bab450e917a202b5f7366cf",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-proto-schema1",
          "type" : "PROTOBUF",
          "owners" : null,
          "description" : "Tenanta Protobuf Schema",
          "uid" : "480a4c8bc786468dac90a0a90277f93e",
          "created_at" : "2023-09-20T00:00:00",
          "modified_at" : "2023-09-20T00:00:00",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "0.0.1",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
      "avro" : true,
      "uid" : "659d8cc539c743ec8c052700dae3a081",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-avro-schema3",
          "type" : "AVRO",
          "owners" : null,
          "description" : "Tenanta schema 3",
          "uid" : "b58073b2caeb4474aa3c6e8c269d919e",
          "created_at" : "2018-09-20T00:00:00",
          "modified_at" : "2018-09-20T00:00:00",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v2",
      "schemaBody" : "schemaBody",
      "avro" : true,
      "uid" : "8152f72742cd4c6db07b9a71a825fe4f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-schema2",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "a32ead9183734d838e32c8454af9f3f5",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "0.0.1",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Random\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
      "avro" : true,
      "uid" : "858d48056942069b916a8053e138s2f6",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "io.axual.qa.general.Random",
          "type" : "AVRO",
          "owners" : null,
          "description" : "Demo schema",
          "uid" : "858d48056942069a916a8053e138s2e4",
          "created_at" : "2018-09-20T00:00:00",
          "modified_at" : "2018-09-20T00:00:00",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v2",
      "schemaBody" : "schemaBody1",
      "avro" : true,
      "uid" : "9bb518df699847d08c24f75a4a7399ed",
      "created_at" : "2018-06-07T23:14:23",
      "modified_at" : "2018-06-07T23:14:23",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.value-schema2",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "dae551f956af48c1baa53281b5edca00",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "0.0.2",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Rand\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Random value. This should be used when the Key is irrelevant.\",\"fields\":[{\"name\":\"random\",\"type\":\"string\",\"doc\":\"The random value.\"}]}",
      "avro" : true,
      "uid" : "a805069b9163e1858d480568s2f69423",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "io.axual.qa.general.Rand",
          "type" : "AVRO",
          "owners" : {
            "_links" : {
              "managers" : {
                "href" : "...",
                "templated" : true
              },
              "resourceManagers" : {
                "href" : "...",
                "templated" : true
              },
              "members" : [ {
                "href" : "...",
                "templated" : true,
                "title" : "Users belonging to this group"
              } ],
              "self" : {
                "href" : "...",
                "templated" : true,
                "title" : "URI pointing to current request"
              }
            },
            "name" : "Environment-tenAenv1",
            "emailAddress" : null,
            "uid" : "aac290536035440e9a85f193e4affeb3",
            "created_at" : "2018-06-07T23:16:23",
            "modified_at" : "2018-06-07T23:16:23",
            "created_by" : null,
            "modified_by" : null
          },
          "description" : "Rand schema",
          "uid" : "069a916a808584253e138s2e4d480569",
          "created_at" : "2018-09-20T00:00:00",
          "modified_at" : "2018-09-20T00:00:00",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v1",
      "schemaBody" : "schemaBody1",
      "avro" : true,
      "uid" : "ab51545971cd461c8c74250907bfac93",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenantb.value-schema1",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "af8f33ce859a47bd9a92fa3b052e7069",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v1",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Key\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Key.\",\"fields\":[{\"name\":\"key\",\"type\":\"string\",\"doc\":\"The Key.\"}]}",
      "avro" : true,
      "uid" : "b5c0a6b2fdd94d64925fd2fadb367891",
      "created_at" : "2018-06-07T23:12:23",
      "modified_at" : "2018-06-07T23:12:23",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-schema1",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "4edccfd6aa744e698542da36f1f01114",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v1.02",
      "schemaBody" : "schemaBody",
      "avro" : true,
      "uid" : "b5c0a6b2fdd94d64925fd2fadb367892",
      "created_at" : "2018-06-07T23:14:24",
      "modified_at" : "2018-06-07T23:14:24",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-schema1",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "4edccfd6aa744e698542da36f1f01114",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v2",
      "schemaBody" : "schemaBody",
      "avro" : true,
      "uid" : "b5c0a6b2fdd94d64925fd2fadb367f2d",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-schema1",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "4edccfd6aa744e698542da36f1f01114",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v1",
      "schemaBody" : "schemaBody",
      "avro" : true,
      "uid" : "bb0f727f05dc4ce7aa32ec1ca1c90933",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : null,
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenantb.key-schema1",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "8e37406569d64f32bf7cfb837993dc77",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "V1",
      "schemaBody" : "keyJsonSchemaBody1",
      "avro" : false,
      "uid" : "byokjsonkeyschema_version001",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : "2018-09-20T00:00:00",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "byok.tenant.key-json-schema1",
          "type" : "JSON_SCHEMA",
          "owners" : null,
          "description" : "Tenanta JSON Schema",
          "uid" : "b90f502e4ab24b1b9476ff3236eefdb4",
          "created_at" : "2023-09-20T00:00:00",
          "modified_at" : "2023-09-20T00:00:00",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 34,
    "totalPages" : 2,
    "number" : 0
  }
}

38.3. List all schema versions only

Sometimes, fetching the schema versions might be enough instead of fetching the complete object. For e.g. in displaying drop-down forms. To get schema versions only, use the same GET call as above but add a parameter projection with value versions. The Last modified date is also included to help determine the latest version.

38.3.1. Query parameters

Parameter Description

projection

Only 1 valid value: versions

38.3.2. Curl request

$ curl 'http://api.example.com/schema_versions?projection=versions' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

38.3.3. HTTP request

GET /schema_versions?projection=versions HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

38.3.4. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 10163

{
  "_embedded" : {
    "schema_versions" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "0.0.1",
      "modifiedAt" : "2018-09-20T00:00:00",
      "uid" : "069858d56942b916a8053480e138s2f6"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "v1",
      "modifiedAt" : "2018-06-07T23:16:23",
      "uid" : "0aa818df699847d08c24f75a4a7399ed"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "0.0.2",
      "modifiedAt" : "2018-09-20T00:00:00",
      "uid" : "1b6f4c0e1aa74c7c874074c4852c9123"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "0.0.2",
      "modifiedAt" : "2018-09-20T00:00:00",
      "uid" : "3e185a805069b91639428d480568s2f69423"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "V1",
      "modifiedAt" : "2018-09-20T00:00:00",
      "uid" : "480dffd4cff042e4a50317b7e4c3eae2"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "v1",
      "modifiedAt" : "2018-06-07T23:16:23",
      "uid" : "5162f72742cd4c6db07b9a71a825fe4f"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "v2.1",
      "modifiedAt" : "2018-06-07T23:16:23",
      "uid" : "5322f72742cd4c6db07b9a71a825fe4f"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "0.0.1",
      "modifiedAt" : "2018-09-20T00:00:00",
      "uid" : "555d4805694eee9b916a8053e138asde"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "0.0.2",
      "modifiedAt" : "2018-09-20T00:00:00",
      "uid" : "5e5d2c630bab450e917a202b5f7366cf"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "0.0.1",
      "modifiedAt" : "2018-09-20T00:00:00",
      "uid" : "659d8cc539c743ec8c052700dae3a081"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "v2",
      "modifiedAt" : "2018-06-07T23:16:23",
      "uid" : "8152f72742cd4c6db07b9a71a825fe4f"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "0.0.1",
      "modifiedAt" : "2018-09-20T00:00:00",
      "uid" : "858d48056942069b916a8053e138s2f6"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "v2",
      "modifiedAt" : "2018-06-07T23:14:23",
      "uid" : "9bb518df699847d08c24f75a4a7399ed"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "0.0.2",
      "modifiedAt" : "2018-09-20T00:00:00",
      "uid" : "a805069b9163e1858d480568s2f69423"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "v1",
      "modifiedAt" : "2018-06-07T23:16:23",
      "uid" : "ab51545971cd461c8c74250907bfac93"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "v1",
      "modifiedAt" : "2018-06-07T23:12:23",
      "uid" : "b5c0a6b2fdd94d64925fd2fadb367891"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "v1.02",
      "modifiedAt" : "2018-06-07T23:14:24",
      "uid" : "b5c0a6b2fdd94d64925fd2fadb367892"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "v2",
      "modifiedAt" : "2018-06-07T23:16:23",
      "uid" : "b5c0a6b2fdd94d64925fd2fadb367f2d"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "v1",
      "modifiedAt" : "2018-06-07T23:16:23",
      "uid" : "bb0f727f05dc4ce7aa32ec1ca1c90933"
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      },
      "version" : "V1",
      "modifiedAt" : "2018-09-20T00:00:00",
      "uid" : "byokjsonkeyschema_version001"
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "next" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    },
    "search" : {
      "href" : "...",
      "title" : "Search endpoints for this entity"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 34,
    "totalPages" : 2,
    "number" : 0
  }
}

38.4. Retrieve a schema version

The /schema_versions/{id} resource is used to retrieve an individual schema version.

A GET request will retrieve the details of a schema.

38.4.1. HTTP request

GET /schema_versions/b5c0a6b2fdd94d64925fd2fadb367891 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com

38.4.2. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 878

{
  "id" : "b5c0a6b2fdd94d64925fd2fadb367891",
  "version" : "v1",
  "schemaBody" : "{\"type\":\"record\",\"name\":\"Key\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Key.\",\"fields\":[{\"name\":\"key\",\"type\":\"string\",\"doc\":\"The Key.\"}]}",
  "schema" : {
    "id" : "4edccfd6aa744e698542da36f1f01114",
    "name" : "nl.tenanta.key-schema1",
    "description" : "",
    "type" : "AVRO",
    "owners" : null
  },
  "createdAt" : "2018-06-07T23:12:23",
  "modifiedAt" : "2018-06-07T23:12:23",
  "createdByFullName" : "tenAdmin middleName TenantA",
  "_links" : {
    "create" : {
      "href" : "...",
      "title" : "URL to create an entity"
    },
    "transferOwnership" : {
      "href" : "..."
    },
    "delete" : {
      "href" : "...",
      "title" : "Indication that this entity can be deleted"
    }
  }
}

38.5. Schema Versions search endpoint

38.5.1. /schema_versions/search/findAllBySchema

Returns the schema versions of the given Schema.

Query parameters
Parameter Description

schema

A valid URI of an existing Schema
Curl request
$ curl 'http://api.example.com/schema_versions/search/findAllBySchema?schema=http%3A%2F%2Flocalhost%2Fschemas%2F4edccfd6aa744e698542da36f1f01114' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /schema_versions/search/findAllBySchema?schema=http%3A%2F%2Flocalhost%2Fschemas%2F4edccfd6aa744e698542da36f1f01114 HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 5576

{
  "_embedded" : {
    "schema_versions" : [ {
      "version" : "v2.1",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Key\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Key.\",\"fields\":[{\"name\":\"keyName\",\"type\":\"string\",\"doc\":\"The Key.\"}]}",
      "avro" : true,
      "uid" : "5322f72742cd4c6db07b9a71a825fe4f",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-schema1",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "4edccfd6aa744e698542da36f1f01114",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v2",
      "schemaBody" : "schemaBody",
      "avro" : true,
      "uid" : "b5c0a6b2fdd94d64925fd2fadb367f2d",
      "created_at" : "2018-06-07T23:16:23",
      "modified_at" : "2018-06-07T23:16:23",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-schema1",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "4edccfd6aa744e698542da36f1f01114",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v1.02",
      "schemaBody" : "schemaBody",
      "avro" : true,
      "uid" : "b5c0a6b2fdd94d64925fd2fadb367892",
      "created_at" : "2018-06-07T23:14:24",
      "modified_at" : "2018-06-07T23:14:24",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-schema1",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "4edccfd6aa744e698542da36f1f01114",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    }, {
      "version" : "v1",
      "schemaBody" : "{\"type\":\"record\",\"name\":\"Key\",\"namespace\":\"io.axual.qa.general\",\"doc\":\"Object type that is supposed to be filled with a Key.\",\"fields\":[{\"name\":\"key\",\"type\":\"string\",\"doc\":\"The Key.\"}]}",
      "avro" : true,
      "uid" : "b5c0a6b2fdd94d64925fd2fadb367891",
      "created_at" : "2018-06-07T23:12:23",
      "modified_at" : "2018-06-07T23:12:23",
      "created_by" : "tenadmin@tenanta.nl",
      "modified_by" : null,
      "_embedded" : {
        "schema" : {
          "_links" : {
            "self" : {
              "href" : "...",
              "templated" : true,
              "title" : "URI pointing to current request"
            }
          },
          "name" : "nl.tenanta.key-schema1",
          "type" : "AVRO",
          "owners" : null,
          "description" : "",
          "uid" : "4edccfd6aa744e698542da36f1f01114",
          "created_at" : "2018-06-07T23:16:23",
          "modified_at" : "2018-06-07T23:16:23",
          "created_by" : null,
          "modified_by" : null
        }
      },
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "schemaVersion" : {
          "href" : "...",
          "templated" : true
        },
        "schema" : {
          "href" : "...",
          "templated" : true,
          "title" : "A schema"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    }
  }
}

38.5.2. Delete schema version constraints

A GET request is used to get the constraints for deleting SchemaVersion.

Curl request
$ curl 'http://api.example.com/schema_versions/bb0f727f05dc4ce7aa32ec1ca1c90933/deletion-constraints' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta'
HTTP request
GET /schema_versions/bb0f727f05dc4ce7aa32ec1ca1c90933/deletion-constraints HTTP/1.1
Authorization: Bearer token
realm: tenanta
Host: api.example.com
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 283

{
  "canDelete" : false,
  "activeStreamConfigsCount" : 1,
  "activeStreamConfigs" : [ {
    "streamId" : "c152a212ace0472fa4e59c69fa71e37d",
    "streamName" : "tenantb-stream1",
    "environmentId" : "2fd4e2046dad49468e0848571982a4a5",
    "environmentName" : "tenantbenv1"
  } ]
}

38.6. Delete a schema version

A DELETE request deletes the schema version. If the schema being deleted is the only version present and is not associated with any streams, then the schema itself will also be deleted.

38.6.1. Curl request

$ curl 'http://api.example.com/schema_versions/b5c0a6b2fdd94d64925fd2fadb367f2d' -i -X DELETE \
    -H 'X-XSRF-TOKEN: XSRF-TOKEN' \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    --cookie 'XSRF-TOKEN=XSRF-TOKEN'

38.6.2. HTTP request

DELETE /schema_versions/b5c0a6b2fdd94d64925fd2fadb367f2d HTTP/1.1
X-XSRF-TOKEN: XSRF-TOKEN
Authorization: Bearer token
realm: tenanta
Host: api.example.com
Cookie: XSRF-TOKEN=XSRF-TOKEN

38.6.3. HTTP response

HTTP/1.1 204 No Content

39. Support Tier

Support Tier can be assigned to instances and is used to determine the support plan chosen for the instance.

39.1. List all support tiers

A GET request will list all the support tiers.

39.1.1. Curl request

$ curl 'http://api.example.com/support_tiers' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

39.1.2. HTTP request

GET /support_tiers HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

39.1.3. HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Content-Length: 1338

{
  "_embedded" : {
    "support_tiers" : [ {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "supportTier" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "GOLD",
      "description" : "This is gold",
      "uid" : "14cadc6238fc4695916a8053302743f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null
    }, {
      "_links" : {
        "self" : {
          "href" : "...",
          "title" : "URI pointing to current request"
        },
        "supportTier" : {
          "href" : "...",
          "templated" : true
        }
      },
      "name" : "SILVER",
      "description" : "This is silver",
      "uid" : "14cadc6238fc4695916a8053413843f5",
      "created_at" : "2018-09-20T00:00:00",
      "modified_at" : null,
      "created_by" : null,
      "modified_by" : null
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "...",
      "title" : "URI pointing to current request"
    },
    "profile" : {
      "href" : "...",
      "title" : "Endpoints for schema metadata in ALPS/JSON Schema format"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

40. Usage

The Usage stats of all the tenants can be accessed .

40.1. View Usage

A GET request which will return the usage stats for all the tenants across instances. Only BILLING_INTERNAL user has access to this endpoint.

40.1.1. Curl request

$ curl 'http://api.example.com/usage' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

40.1.2. HTTP request

GET /usage HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

40.1.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 3940

[ {
  "name" : "supertenant",
  "groups" : 1,
  "instance" : [ {
    "name" : "test",
    "streamConfigsCount" : 0,
    "supportTier" : "SILVER",
    "clustersNames" : [ "LimitedBYOKClusterForCC" ]
  } ]
}, {
  "name" : "clntntcc",
  "groups" : 0,
  "instance" : [ ]
}, {
  "name" : "BYOKtenant",
  "groups" : 1,
  "instance" : [ {
    "name" : "BYOKCC",
    "streamConfigsCount" : 1,
    "supportTier" : "GOLD",
    "clustersNames" : [ "BYOKClusterForCC" ]
  }, {
    "name" : "BYOKAIVEN",
    "streamConfigsCount" : 2,
    "supportTier" : "GOLD",
    "clustersNames" : [ "BYOKClusterForAiven" ]
  }, {
    "name" : "BYOKKAFKA",
    "streamConfigsCount" : 1,
    "supportTier" : "GOLD",
    "clustersNames" : [ "BYOKClusterForAiven", "BYOKClusterForApacheKafka" ]
  }, {
    "name" : "CCnoEnv",
    "streamConfigsCount" : 0,
    "supportTier" : "GOLD",
    "clustersNames" : [ "BYOKClusterForApacheKafka", "BYOKClusterForCC" ]
  }, {
    "name" : "oldinst",
    "streamConfigsCount" : 0,
    "supportTier" : "GOLD",
    "clustersNames" : [ "BYOKClusterForAiven" ]
  }, {
    "name" : "BYOKReplica",
    "streamConfigsCount" : 3,
    "supportTier" : "GOLD",
    "clustersNames" : [ "BYOKReplica2ForApacheKafka", "BYOKReplica1ForApacheKafka" ]
  }, {
    "name" : "BYOKAIVEN2",
    "streamConfigsCount" : 0,
    "supportTier" : "GOLD",
    "clustersNames" : [ "BYOKClusterForAiven" ]
  }, {
    "name" : "BYOKMULTI",
    "streamConfigsCount" : 0,
    "supportTier" : "GOLD",
    "clustersNames" : [ "BYOKClusterForAiven", "BYOKClusterForCC" ]
  }, {
    "name" : "aivenkafka",
    "streamConfigsCount" : 0,
    "supportTier" : "GOLD",
    "clustersNames" : [ "BYOKClusterForAiven", "BYOKReplica1ForApacheKafka" ]
  }, {
    "name" : "kafka",
    "streamConfigsCount" : 0,
    "supportTier" : "GOLD",
    "clustersNames" : [ "BYOKReplica1ForApacheKafka" ]
  } ]
}, {
  "name" : "LmtBYOKtnt",
  "groups" : 1,
  "instance" : [ {
    "name" : "LMTBYOKCC",
    "streamConfigsCount" : 1,
    "supportTier" : "GOLD",
    "clustersNames" : [ "LimitedBYOKClusterForCC" ]
  } ]
}, {
  "name" : "clntnt",
  "groups" : 0,
  "instance" : [ ]
}, {
  "name" : "tenNoEnv",
  "groups" : 1,
  "instance" : [ {
    "name" : "BYOKAIVEN2",
    "streamConfigsCount" : 0,
    "supportTier" : "GOLD",
    "clustersNames" : [ "ClusterWithNoEnv" ]
  }, {
    "name" : "INSTDELETE",
    "streamConfigsCount" : 0,
    "supportTier" : "GOLD",
    "clustersNames" : [ ]
  } ]
}, {
  "name" : "tenantS",
  "groups" : 9,
  "instance" : [ {
    "name" : "ActiveSubs",
    "streamConfigsCount" : 0,
    "supportTier" : "GOLD",
    "clustersNames" : [ ]
  } ]
}, {
  "name" : "tenantSC",
  "groups" : 0,
  "instance" : [ ]
}, {
  "name" : "tenanta",
  "groups" : 15,
  "instance" : [ {
    "name" : "ota",
    "streamConfigsCount" : 23,
    "supportTier" : "GOLD",
    "clustersNames" : [ "Zone2ClusterOTA", "Zone1ClusterOTA" ]
  }, {
    "name" : "lst",
    "streamConfigsCount" : 1,
    "supportTier" : "SILVER",
    "clustersNames" : [ "Zone2ClusterOTA" ]
  }, {
    "name" : "ota2",
    "streamConfigsCount" : 1,
    "supportTier" : "GOLD",
    "clustersNames" : [ "Zone2ClusterOTA" ]
  }, {
    "name" : "prod",
    "streamConfigsCount" : 2,
    "supportTier" : "SILVER",
    "clustersNames" : [ "Zone1ClusterPROD" ]
  }, {
    "name" : "ksmlinst",
    "streamConfigsCount" : 1,
    "supportTier" : "GOLD",
    "clustersNames" : [ "singleClusterKsmlCluster" ]
  }, {
    "name" : "multiClstrKsmlInst",
    "streamConfigsCount" : 0,
    "supportTier" : "GOLD",
    "clustersNames" : [ "multiClusterKsmlCluster00", "multiClusterKsmlCluster01" ]
  } ]
}, {
  "name" : "tenantb",
  "groups" : 4,
  "instance" : [ {
    "name" : "prod",
    "streamConfigsCount" : 1,
    "supportTier" : "GOLD",
    "clustersNames" : [ "Zone2ClusterPROD" ]
  }, {
    "name" : "ota",
    "streamConfigsCount" : 0,
    "supportTier" : null,
    "clustersNames" : [ "Zone2ClusterLST" ]
  } ]
} ]

40.2. View Instance info

A GET request which will return the instance’s info for all the tenants. Only BILLING_INTERNAL user has access to this endpoint.

40.2.1. Curl request

$ curl 'http://api.example.com/usage/instances' -i -X GET \
    -H 'Authorization: Bearer token' \
    -H 'realm: tenanta' \
    -H 'Accept: application/hal+json'

40.2.2. HTTP request

GET /usage/instances HTTP/1.1
Authorization: Bearer token
realm: tenanta
Accept: application/hal+json
Host: api.example.com

40.2.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 3122

[ {
  "instanceShortName" : "BYOKAIVEN2",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "BYOKtenant"
}, {
  "instanceShortName" : "ActiveSubs",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "tenantS"
}, {
  "instanceShortName" : "BYOKAIVEN2",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "tenNoEnv"
}, {
  "instanceShortName" : "ota2",
  "connectUrls" : "https://connect3.url,https://connect4.url",
  "connectEnabled" : true,
  "tenantShortName" : "tenanta"
}, {
  "instanceShortName" : "BYOKAIVEN",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "BYOKtenant"
}, {
  "instanceShortName" : "BYOKMULTI",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "BYOKtenant"
}, {
  "instanceShortName" : "oldinst",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "BYOKtenant"
}, {
  "instanceShortName" : "INSTDELETE",
  "connectUrls" : "https://connect.com",
  "connectEnabled" : false,
  "tenantShortName" : "tenNoEnv"
}, {
  "instanceShortName" : "BYOKCC",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "BYOKtenant"
}, {
  "instanceShortName" : "ota",
  "connectUrls" : "https://connect1.url,https://connect2.url",
  "connectEnabled" : true,
  "tenantShortName" : "tenanta"
}, {
  "instanceShortName" : "BYOKKAFKA",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "BYOKtenant"
}, {
  "instanceShortName" : "LMTBYOKCC",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "LmtBYOKtnt"
}, {
  "instanceShortName" : "prod",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "tenantb"
}, {
  "instanceShortName" : "prod",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "tenanta"
}, {
  "instanceShortName" : "test",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "supertenant"
}, {
  "instanceShortName" : "ota",
  "connectUrls" : null,
  "connectEnabled" : true,
  "tenantShortName" : "tenantb"
}, {
  "instanceShortName" : "lst",
  "connectUrls" : "https://connect1.url,https://connect2.url",
  "connectEnabled" : false,
  "tenantShortName" : "tenanta"
}, {
  "instanceShortName" : "aivenkafka",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "BYOKtenant"
}, {
  "instanceShortName" : "multiClstrKsmlInst",
  "connectUrls" : "https://connect000.url,https://connect001.url",
  "connectEnabled" : false,
  "tenantShortName" : "tenanta"
}, {
  "instanceShortName" : "BYOKReplica",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "BYOKtenant"
}, {
  "instanceShortName" : "kafka",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "BYOKtenant"
}, {
  "instanceShortName" : "ksmlinst",
  "connectUrls" : "https://connect000.url,https://connect001.url",
  "connectEnabled" : false,
  "tenantShortName" : "tenanta"
}, {
  "instanceShortName" : "CCnoEnv",
  "connectUrls" : null,
  "connectEnabled" : false,
  "tenantShortName" : "BYOKtenant"
} ]

41. API changelog

All notable changes to this project are listed below. === 10.1.0 - 2025-06-25

Added

  • Clean up Kafka Streams internal topics when app.id changes

  • Clean up Consumer Groups ACLs when delete app principals

  • Added a new endpoint /instances/search/findByAttributes for Instance

  • The validateCredentials logic is included as part of the Update Cluster (PATCH)

  • Audit the Cluster Create/Update/Delete actions

  • Audit the Environment Create/Update/Delete actions

  • Audit the Grant Request/Approve/Deny/Cancel/Revoke actions

  • Audit the Topic Create/Update/Delete actions

  • Audit the Application Principal Create/Delete actions

  • Audit the Application Credential Create/Delete actions

  • Added a custom controller endpoint for DELETE /environments

  • Group Overview sort Users

  • Audit the Application Deployment Configured

  • Audit the Application Unconfigured action

  • Audit the Application STARTED/STOPPED/RESTARTED actions

  • Audit the Application Reset action for Consumer Offset

  • Audit the Application Reset action of Kafka Streams Application

  • Refactored the TopicBrowse audit event

  • Audit the Application RESET action for Connector Application

  • Persist ApplicationDeployment config restart_policy

  • Add searching logic of audit history for second and third level resources

  • Pass DeploymentType to KSML Provisioner

  • Audit the Topic Configured action

  • Audit the Topic Unconfigured action

  • Add event summary to the auditHistory response

  • Audit the Group Browse Permission Granted action

  • Audit the Group Browse Permission Revoked action

  • Audit the User Browse Permission Revoked action

  • Audit the User Browse Permission Granted action

  • Add audit fields to response of the GET /stream_configs/{id}/permissions?type=browse API

  • Rely on application_deployments._links to show action buttons

BugFixes

  • Fix the Pod Name leakage in the notification email’s header

  • Prevent other instances from using cert of tenant-protected instance

  • Connector 404 handled as unauthorized

  • Edit Cluster requires broker credentials (privateKey/password)

  • Fix Audit history filtering issue when searching for deleted resources

  • Axual config topic.pattern collides with KSML app config topic.

  • Remove Axual Client code

  • refreshDeploymentState for connectors only

  • Can’t import schemas without namespaces

  • Deleting Topic without Schemas results in a call to Schema Registry

  • Fix Hibernate Lazy Loading Exception while creating SASL Credentials

  • Fix missing authorization check for create link generation for listing groups

  • Fix test_restart_task and appDeploymentCount failing tests on the pipeline

  • Prefixed ACL collision bugfix

41.1. 10.0.0 - 2025-03-24

This version of the Platform Manager removes support for:

  • Deployment with the Instance API

  • Browsing a Kafka Topic with the Stream Browse

  • OAuth2 authentication and relies on the API Gateway OAuth2 authentication

  • Uploading of a Schema Jar

  • Create Schema with POST /schemas

  • Update Schema with PATCH /schemas/{id}

  • Check Schema Version with POST /schemas/check

  • Create Schema Version with POST /schema_versions

  • Update Schema Version with POST /schema_versions/{id}

Added

  • Resource Manager role and rules added to permissions

  • Removed selection of SR for create/update Instance operations

  • Improved Grants Overview

  • Hide sensitive fields when retrieving Instance information

  • Introduce Delete Constraint Endpoint for Schema

  • KafkaStreams based reset

  • Allow changing just the SchemaRegistry Listeners/Properties without changing Credentials

  • Add Auth0 support in Organization Management module

  • Introduce Delete Constraint Endpoint for Schema Version

  • Audit the Application Resource

  • Audit the Instance Resource

  • Allow SR password regeneration for Self Managed KSML and Kafka Streams application

  • Add a new type of Retention Type for compact,delete

  • Delete internal topics when deleting a "Kafka Streams"-based application

  • Filter Grant by Access Type

  • Manage SR credentials for Axual Managed KSML application when creating/deleting application_deployment

  • Add authentication support in KSML flows

  • Add only-resource-manager-can-update toggle on the Tenant settings

  • Self approving for application grand should not be possible

  • Allows selecting Resource Manager in a Group

  • View the audit history

  • Starting an already started connector fails

BugFixes

  • InstanceCluster couldn’t be saved without SR details

  • SR Keycloak Details weren’t saving during Instance Edit

  • Allow sending null properties for the topic apply

  • Removed the circular dependency between kms and clusterImporter modules

  • Renamed SchemaDeleteConstraints fields

  • Deleting user from UI also deletes from Keycloak

  • Permissions for Owning Group by default browsing group not toggleable per tenant

  • Fix Truststore Apicurio Configuration

  • Fix for notification not sent while connector fails

  • Simplify SchemaRegistry truststore configuration

  • Add timeUnit translation to milliseconds for essential topic configs when using K-Lib

  • Not Topic Owner can see view masking fields button

  • Fix the generic error message when proving invalid retentionPolicy

  • Fixed issue while updating a topicConfig having unsupported property

  • Importing an existing Kafka Cluster with SchemaRegistry doesn’t work

  • Fixed issue while importing an existing SSL ACL from Kafka cluster

  • Regular user can’t see instances

  • Disabled URLs in the Notifications emails

  • Creating a Tenant with /tenants should result in a WizardCompleted tenant

  • Marked the unused endpoint GET/POST/PATCH/DELETE /groups/{uid}/members as deprecated

  • Fixed issue when creating instance with invalid connectUrl

  • Updating an Instance removes the srType, srVersion, distributionConfig and KSML overrides

41.2. 9.1.1 - 2024-12-24

BugFixes

  • NPE when getting masking-fields for a AVRO/non-AVRO Topic

41.3. 9.1.0 - 2024-12-23

Added

  • Consumer app offset reset

  • Tenant properties are made JSON column

  • Allow to Stop Distribution

  • Masking_fields support for schema

  • Add Kafka Streams custom application type

  • Make the schema-roles-enforce a Tenant setting

  • Store Apicurio’s Keycloak details per Instance Cluster

  • Audit the Application Create action

  • Masking_fields support for Topic Config

  • Allow to configure strict masking toggle for an Environment

  • Allow app owners to create Schema Registry credentials in Apicurio’s Keycloak

  • Allow app owners to delete Schema Registry credentials in Apicurio’s Keycloak

  • Unmask the masking_fields for a Topic Config Browse

  • Create KafkaStreams prefixed ACLs on credential and principal creation

  • Enhance Keycloak client registration error handling with a fallback scenario

  • Delete KafkaStreams prefixed ACLs on credential and principal deletion

  • KafkaStreams based application.id modification should trigger collision-detection/delete/create Prefixed ACLs

  • Trigger KafkaStreams based prefixed ACL collision detection on credential/principal/topic creation

BugFixes

  • Don’t delete permission groups when Granular Browse gets disabled for an Instance

  • Schema registry secrets location fix

  • Uploading a new schema-version with a different type is allowed

  • Block creation of an Instance with existing short-name in the same Tenant

  • Don’t allow dropping Schema Registry from InstanceClusters when topics are deployed

  • Update SchemaRegistryUrls for old architecture Instances

  • EnvOwner & EnvAdmin cannot delete private environment if app-auth defined by others

  • Connector configs and grouping disappears

  • Fixing an issue when creating a topic for the first time

  • Simplify logic to retrieve StreamConfig allowed Kafka Properties

  • Make KSML only working with Schema Registry in confluent mode

  • Not a resource owner can take ownership of resources

  • Added the missing owners field to the response of the /schema_versions/search/findAllBySchema API

  • Fixed issue for topic owners can browse their own topic

  • Resolved an issue where users without ownership of any resources could view all appAccessGrants

41.4. 9.0.0 - 2024-10-01

Added

  • KSML Applications support

  • JSON SCHEMA support

  • Removed "notificationsEnabled" field from /me, /tenant and /user endpoints. [BREAKING CHANGE]

  • a POST endpoint to create distribution config for an instance cluster

  • Allow Tagging streams

  • a PATCH endpoint to create distribution config for an instance cluster

  • A GET endpoint to retrieve the distribution config for an instance cluster

  • Hide Sensitive fields when retrieving Cluster information & validate credentials when updating Cluster

  • a GET endpoint to retrieve distribution overview of an instance

  • Add tag to the search attributes of the Stream entity

  • Distribution API improvements

  • Allow to Start a Distribution

  • Get distribution status

  • Added a validation to disallow SSL auth creation if any auth exists (principal or credential) for the app and environment

  • Updated shortName in Tenant/Instance/Environment resource to have min length 1

  • Allow user to update provider info fields while updating Kafka cluster

  • Create/Update a topic using JSON Schema

  • Create Schema ownership

  • Create/Delete JSON Schema topic config

  • Delete environment|topic|application should identify active child-resources

  • Support connector logging

Bugfixes

  • Protobuf schemas without package (namespace) were saved with a starting dot "."

  • Topic delete idempotency

  • Cluster SASL mechanism update getting invalid protocol type error

  • Forbid removing Instance from Environment

  • Added validation for BYOK clusters to provide a user-friendly message in case the SR is not configured for AVRO/PROTOBUF topic

  • Fixed /application_access_grants/search/findByAttributes API sorting issue

  • Added Transactional annotation to fix hibernate lazy loading exception

  • Fix NPE issues encountered during deployment status retrieval

  • Fix update Instance issue regarding storing the Instance credentials as Cluster credentials

  • VaultTemplates bean is not part of the Spring Lifecycle

  • Fix to resolve the distribution config path in vault service using correct delimiters

  • Fix the get all and one Group to not load the Tenant

  • Cannot delete private environment with KSML deployment

  • When setting the default enabledAuthenticationMethods for an instance, the collection is immutable

  • Return privateKey uploaded for KSML and Connector Applications

  • Fetch the stream.tags when searching stream by name containing /streams/search/findByNameContaining

  • Fix validateCredentials behaviour which requires everything to be sent

  • Update the logic of validating credentials in PATCH distributionConfig

  • When using SASL as super-user, Topic-Browse fails

  • When updating an Instance, the secrets are not replaced/removed

  • Fixed fetch all streams when the tag is empty string

  • Updating application ID is case-insensitive which should not be

  • Instance Edit page is not handling 403 errors

  • Hibernate LazyLoadingException when refreshing PluginsInfo

  • Can save sslAuthMode in Cluster table as a JSON column

  • Add a self-link to the application.owner resource

  • Migrating an instance removes the schema-registry-slave urls

  • The key/value type is not visible for PROTOBUF/JSON_SCHEMA topic

  • Fixed duplicated self-link of the group resource by introducing custom APIs for POST and PATCH /groups/{uid}

  • Allow Cluster Name to contain _-. symbols

  • Fix double _links.self in /api/application_deployments/xxx/status endpoint

  • Added HAL_JSON_VALUE Accept header to the post and patch /groups APIS and fixed duplicated self-link of the SDR API

41.5. 8.6.0 - 2024-06-27

Added

  • Delete Kafka Topic with Protobuf Schemas

  • Create Kafka Topic with Protobuf Schemas

  • View, Delete Protobuf Schema in the Self-Service

  • Trigger emails based on events for Connector Owners

  • Trigger emails based on events for application Owners

  • Enable Tenant Notification

  • Disable User Notification

  • Add Owners field to Environment findByAttributes API

  • Provide the SchemaRegistry Type in the Instance-Cluster

  • Support multi-cluster for ApplicationAuthentication creation

  • Enable/Disable KSML support for an Instance

  • Application Principal for KSML Application

  • Create KSML application

  • Add KSML Application Deployment

  • Add Application Lifecycle interface

  • Define Viewer Group for Environment

  • Define Viewer Group for Streams

  • Define Viewer Group for Application

  • Allow stream-owner to add group to the PermissionGroup

  • Create Group Managers to manage group’s members

  • Made the tenant in Group entity LAZY to resolve hibernate memory overload issue

Bugfixes

  • Fix Cascade delete for a stream not removing Kafka Topics

  • Fix Cascade delete for an application not removing Kafka Topics ACLs

  • Fix Cascade delete for an environment not removing Kafka Topics

  • Fix Private Environment cascade delete issue regarding removing ApplicationAccess

  • Add audit logs for application access grant status changes

  • When a cluster has billingCloudEnabled=true, that value should not change if it’s not present in a

  • Add 'Axl-Sr-Type-ApacheKafka' in Provider Config

  • Updated the AuditLogger’s log method to remove debug handling for ApplicationDeployment instances

  • Remove HubSpot related code

  • Fix force apply for AVRO and Protobuf

  • Missing namespace when uploading a Protobuf with defined package

  • Changed Boolean parsing for handling old migration values (1,0) as (true, false)

  • Partial match on searching for ApplicationID

  • NPE when instance setting does not include CERTIFICATE_REUSE_PREVENTION

  • Unhandled data layer exception when creating an application with a duplicate name/shortName

  • Fix for private environments are visible to normal users and TENANT_ADMIN

  • Application Access Grants are not visible to Admin when myteams=true

  • Allow multiple principals with the same DN and different fingerprint irrespective of the certificateReusePrevention value

41.6. 8.5.0 - 2024-04-12

Added

  • Implement the Notification Service with SMTP

  • View Protobuf schema in the Self-Service

  • Add SchemaRegistry Type to the TopicBrowse Config

  • Validate and upload Protobuf

Bugfixes

  • Fix returning inconsistent dataType for application access grant members

41.7. 8.4.0 - 2024-03-25

Added

  • Added search by owner to Applications, Streams, and Environments

  • Handle the refresh certificate scenario with no downtime in Kafka ACL

Bugfixes

  • Save Apache-Kafka secrets when importing an existing Apache-Kafka cluster

  • Fixed update cluster issue when the topic/group/transactional pattern is provided in patch request but not modified

  • Fixed the /me endpoint issue when VaultService is not available

  • Fixed issue when updating an instance with property.value=NULL

41.8. 8.3.0 - 2024-03-13

Added

  • Filter the system-topics from the /wizard/topics

  • Added DB scheduler configuration for distributed scheduling of connector cron jobs

Bugfixes

  • Fixed issue while updating onboarded default instance

  • Removed usage of`updateTopic` to fix issue adding a cluster makes existing things fail

  • Added SSL configuration to HashicorpVault

  • Fixed fetching the secrets when the cluster or instance Name have Capital letters

  • Fixed to restrict updating patterns on external cluster when mapped to a topic

41.9. 8.2.0 - 2024-02-29

Added

  • Add properties field to Application and Group APIs

  • Off-boarding of a ConfluentCloud cluster

  • Allow downloading CSV file for Topics, Applications, and Environments

  • Add extraInitContainers, extraVolumes, extraVolumeMounts, and extraContainers to Helm Charts

  • Cascade delete Application, Environment, Topic

  • Prevent reuse of SSL principal

  • Added a new field settings to Instance entity

  • Add monitoring_information for API Gateway

  • Add validation to block changing cluster ownership

Bugfixes

  • Fixed PATCH /clusters/{id} API to allow migrating old arch cluster to a shared apache-kafka cluster

  • Changes to add namespace property to governance.vault

  • Fix creating first environment on single-environment cluster

  • Changing environment to PRIVATE is blocked by REVOKED access grants.

  • A deleted instance is still present in the list of managed instance

  • Fixed PATCH /instances/{id} API to allow instance migration

  • Added default instanceSettings while onboarding new tenant

  • Refactored the logic of setting value for isSchemaRegistryEnabled field of /me API

  • Fixed issue when deleting an instance with connect enabled

  • Fixed issue with search on topic with findByAttributes

  • Cannot create the first environment in a Tenant

  • Fixed issue when selecting AVRO and then switching back during topic creation

  • Fixed HATEOAS links pointing to the wrong resources

41.10. 8.1.0 - 2024-01-30

Added

  • Add provider info to the Instance entity

  • Handled Duplicated CAs internally instead of returning validation error when creating or updating an instance

  • Add Cluster validation when creating/updating the entity

  • Set server.forward-headers-strategy: framework as default

  • Add new API to get the Kafka connectivity Information per application

  • Add the properties to the StreamProjections

  • Allow Stream owner and Stream admin to create applicationAccessGrant

  • Add delete /schemas endpoint to delete the Schema with related SchemaVersions

Bugfixes

  • Add validation fields for Instance PATCH endpoint

  • Fixed cluster.name update issue of ignoring case sensitivity when interacting with vault

  • remove phone number validation for the user entity

  • Fix overwriting issue of SR and Kafka listeners when performing a patch

  • Fix bypassing the APPLICATION_ACCESS_GRANT_CREATE rule for createApplicationAccessGrant API

41.11. 8.0.1 - 2023-12-13

Bugfixes

  • Create an Admin group when bootstrapping the Tenant/User

41.12. 8.0.0 - 2023-12-13

Added

  • Upgrade Spring Boot to 3.1.0

  • Replace Spring Sleuth with Micrometer to fix distributed tracing

  • Get rid of all deprecated endpoints as 6.x & 7.x version

  • Add Broker mTLS cert/privateKey validation in the Wizard

  • Add Broker SASL username/password validation in the Wizard

  • Add SR BasicAuth username/password validation in the Wizard

  • Add SR mTLS cert/privateKey to Wizard

  • Add provider info in the cluster page

  • Allow skipping onboarding after user signup

  • Added validation while creating an environment to check if Instance has any multi-environment cluster

  • Unify logging pattern

Bugfixes

  • Improve performance of getAllWithLatestSchemaVersion endpoint

  • Hide sensitive fields in the audit logging

  • Make Error Human Readable

  • Remove phoneNumber pattern validation on group entity

41.13. 7.4.0 - 2023-10-09

Added

  • Don’t validate connector-logging certificate against the instance CAs

  • Added TRIALING status to reflect "active" state of the subscription

  • Add stream-config-browse config endpoint

  • Add Hashicorp Vault support

  • Upgraded Spring Kafka version to 3.0.10

  • Upgraded Kafka Clients version to 3.5.1

  • Upgraded Spring Hateoas version to 2.0.6

  • Upgraded Spring Security version to 6.1.4

  • Upgraded Keycloak Admin Client version to 22.0.3

  • Changed the /clusters endpoint to return Public and Owned clusters

  • Removed the endpoint /instances/{id}/clusters

  • Change to restrict creating Byok-Instance using the non-byok cluster and vice versa while creating instance

  • Introduce a multiInstance feature to control instance-creation

  • Ingest AOM features into Platform Manager

  • Show Private Key Uploaded in Principal

  • Add HashiCorp Vault support for storing connect secrets

  • Added links to the /clusters endpoint. Updated RBAC rule for cluster create,edit and delete

  • Add apache-kafka allowed topic-properties

  • Add tenantUid, topicBrowseEnabled, and schemaRegistryEnabled fields to /api/me

  • Added a new endpoint /tenants/{tenantUID}/onboard to onboard a tenant with shared cluster

  • Re-introduced segment.ms pickup from Instance’s properties

  • Use principalChain when creating Topic ACL for multi-tenant cluster and support multi-cluster for topic apply/delete

  • Delete public environment

  • Add tls support to PlatformManager helm-charts with external k8s secret only

  • Support multiple instanceConnect configuration at Deployment time

Bugfixes

  • Fix check on identifying external cluster in InstanceEventHandler

  • Changes to Allow Generating/Deleting SASL credentials for Plain/Strimzi provider

  • Fix change key/value of an unconfigured topic to AVRO

  • Allow deleting an applicationCredentials with the ResourceId as metadata in case clusterApiKey is empty

  • Return a tenant optional field when getting all Instances

  • Fix Schema Browser issue with null schemas in mgmt-api

  • Fix create/delete multiple schema versions

41.14. 7.3.0 - 2023-08-02

Added

  • Added configuration to enable/disable duplicate schema validation

  • Update importApplication to store ResourceID

  • Allow applying a topic on a Plain/Strimzi Cluster

  • Allow deleting a topic on a Plain/Strimzi Cluster

  • Upgraded Spring version to 6.0.11

  • Upgraded Spring Security version to 6.1.2

  • Changes to remove duplicated ACL when applying a topic

  • Updated the rule for APPLICATION_ACCESS_GRANT_VIEW similar to APPLICATION_ACCESS_VIEW

  • Add connector logging status to environments/search/findByApplication endpoint response

  • Add delete /schema_versions/{uid} endpoint

  • RollBack all the changes to resolve username on findByAttribute endpoint

Bugfixes

  • Uploading a schema-version for an existing schema gives error

  • Auto-create/delete topic configs when toggling connector logging state.

41.15. 7.2.0 - 2023-07-17

Added

  • Changes to create authentication on Confluent Cloud

  • Create/delete Connect log prefix ACLs when environment is saved/deleted

  • Create/delete ACLs when a Connect logging certificate is uploaded/deleted

  • Automatically create topic configurations as part of the connector logging support feature

  • Handle concurrency in creation of application_access

  • Support Headers based authentication

  • Set user fullName as createdBy/modifiedBy for myApplications and myTopics APIs

  • Allow onboarding a ConfluentCloud cluster as a CloudAdmin

  • Get /group endpoint returns sorted by name, add myTeams param to get /application_access_grants/search/findByAttributes endpoint

  • Allow to delete API Keys on Confluent Cloud

Bugfixes

  • Change topicConfig properties endpoint to use envID

  • If resource does not exist return 404 instead of 403 for all getById APIs

  • Expect a clusterName param for ConfluentCloud when getting the external topic details

  • fix /applications/search/findByAttributes and /streams/search/findByAttributes APIs returning duplicated items

41.16. 7.1.0 - 2023-06-15

Added

  • Add POST /application_authentications endpoint to create credentials for any provider

  • Create/delete prefix ACLs when instance is saved with connect logging enabled

Bugfixes

  • Improve error message of an unauthorized user attempting to browse a stream

  • Fix Hibernate Lazy Initialization on ConnectPluginInfo

41.17. 7.0.6 - 2023-06-09

Added

  • Added a toggle to enable/disable support for connector-logging.

Bugfixes

  • Fixed streamConfig update policy

  • Allow user to provide single character for firstname and lastname

41.18. 7.0.5 - 2023-06-05

Bugfixes

  • Fixes issue with topic apply on any newly created topic

41.19. 7.0.4 - 2023-05-30

Added

  • Eliminate the need for ApplicationAccess

  • Allow creating/updating kafka topic without optional kafka properties

  • Update HorizontalPodAutoscaler to autoscaling/v2 apiVersion in helm-chart

  • Delete /application_authentications endpoint to delete user on any provider

  • Fixed hibernate lazy initialization issue with asyncApi endpoint

  • Added a check to validate if an environment’s Authorization issue is Auto before browsing a stream

  • Updated findStreamConfigById in stream config repository to a custom query

  • Updated findById in stream config repository to a custom query

Bugfixes

  • Fix for Browsing a stream on a Public Environment with AUTO approval is denied

41.20. 7.0.3 - 2023-05-25

Bugfixes

  • User in permission-group but not owner of stream-config cannot browse

  • Fix issue on application_access_grants/search/findByAttributes returning other tenant resources

  • Remove api/streams/{uid}/browse-access endpoint

  • Remove unused Validator components

  • Fix for Requesting application-access for the first time results in no-ACL for AUTO Approval Environment

Hotfixes

  • Added custom queries for few methods in ApplicationAccess, Stream and Environment repositories to avoid hibernate lazy loading

41.21. 7.0.2 - 2023-05-11

Added

  • Add AsyncAPI specification for any StreamConfig in JSON or YAML format

41.22. 7.0.1 - 2023-04-18

Bugfixes

  • Fixed restriction of non-admin users and non-members from updating the group

  • Set TopicSchemas as null in case the topic key/value type is not Avro for External Providers

41.23. 7.0.0 - 2023-04-12

Added

  • Upgrade to Spring Boot 3.0.x

  • Added Stripe events integration

  • Added customer creation and subscription logic

  • Added subscription management database schema

  • Added subscription management module + pricing table endpoint

  • Added limitation of having just one active subscription

  • Added customer portal and checkout redirect

  • Added fallback value for products

  • Added Off-board customer from Stripe

  • Added Slack notification for Sales/Marketing when the user request a quote

  • Added organization Created event which is sent after Tenant creation

  • Added blocking clusters/groups creation upon reaching limit by client

  • Added subscription management module + pricing table endpoint

  • Added subscription management database schema

  • Exposed an endpoint to retrieve current customer’s usage and features

  • Added supporting multiple OIDC Provider

  • Exposed /me endpoint to return User and Tenant information

  • Added Aiven credentials validation and return Aiven services

  • Added Confluent Cloud credentials validation and return Confluent Cloud services

  • Exposed /wizard/topics endpoint to create base entities

  • Include topics, ACLs and Schemas as discovered resources for an external provider

  • Added fetching TopicDetails for available topics on a Kafka Provider

  • Added deleting stream browse permission groups when disabling granular browse permissions on the Instance

  • Added Streams/StreamConfigs, ACLs and Schemas import for an external provider

  • Added persisting secrets in Azure KeyVault for Aiven and ConfluentCloud providers

  • Added supporting Multiple owners to Search Application Grants by Attributes

  • Allow creating clusters with same name on different tenants

  • Delete topic via Provider Library added

  • Allowing imported topics to have any Kafka properties

  • Added apply topic and update existing topic via Provider Library

  • Exposed GET /schemas/findAllWithLatestVersion endpoint to list all schemas with the latest schema versions

  • Updated authMethods to match the external Kafka Providers

  • Added uid and comment to ApplicationAccessGrant Response

  • Added Cluster and Schema-Registry API/Secret to connect to ConfluentCloud provider

  • Converted custom initial_group claim into existing Group to add new user when converting an Auth0 JWT

  • Added Off-board an Axual Governance Organization and its resources

  • Added Filter out topic properties which are topic fields

  • Allow ConfluentCloud applications to manage their AccountID

Bugfixes

  • Fixed creation of browse permission group for Auto environment

  • Fixed NPE when getting subscription info on Auth0 authentication

  • Added Instance.apiUrl as part of the response when getting an Environment

  • Added delete link to GET /clusters/{uid} endpoint

  • Fixed issues with the endpoint /users/search/searchUser

  • Updated the application.adoc mentioning _ are allowed for applicationId

  • Make all error responses consistent

  • Added /instance/{uid}/clusters to return only owned cluster in case the Instance is using an external Kafka cluster

  • Add SASL_PLAIN to GET /authentication_methods to support tenant update with SASL_PLAIN

  • Fixed /deletion-constraints endpoint to return 404 instead of 403

  • Change application_id type to store long applicationId coming from Confluent-Cloud

  • Set default value of create-stream.disable-time to 0 minutes

  • Changed imported stream description

  • Fixed issue on application_access_grants/search/findByAttributes returning other tenant resources

  • Fix issue of not passing partitionCount and set proper SchemaType when no schema is present

  • Remove username prefix from imported applications name for Aiven provider

  • Allow updating Stream and Application owners by TENANT_ADMIN

  • Allow AxualAuditorAware to work with anonymous user and anonymous authentication token

  • Subscriptions shouldn’t be deleted

Deprecated

  • MySQL 5.7 support has been removed and connecting to a MySQL 5.7 DB won’t work with Platform Manager 7.x

41.24. 6.20.4 - 2022-01-19

Bugfixes

  • Fix for instance setting being ignored when there is no stream browse permission group

41.25. 6.20.3 - 2022-01-18

Bugfixes

  • Setting max size limit of pagination to 9999

41.26. 6.20.2 - 2023-01-16

Bugfixes

  • Change default value for Instance.environmentMapping to true

41.27. 6.20.1 - 2022-01-10

Bugfixes

  • Fix for Environment filter issue on application-access-grant search

41.28. 6.20.0 - 2022-12-15

Added

  • Check schema compatibility only when schema versions have changed

  • Remove schema compatibility check when schema key/value versions are not changed

  • Introduce a new endpoint to simplify the creation of an ApplicationAccessGrant

  • Mark search endpoints in Application Access as deprecated

  • New search endpoints for Application Access Grant

41.29. 6.19.0 - 2022-11-17

Added

Bugfixes

  • Delete certificate/privateKey when deleting a connector application

  • Deactivate connector plugin when they are removed from Axual Connect

  • Fix /connect_plugins to return only active connector plugins

41.30. 6.18.1 - 2022-11-07

Bugfixes

  • Fix NPE thrown when validating certificate without correct extension

41.31. 6.18.0 - 2022-11-02

Added

BugFixes

  • Fix /tenant endpoint to expose updated tenant’s value

41.32. 6.17.0 - 2022-10-21

Added

Bugfixes

  • Fix connector’s cert-uri when Vault.Namespace is provided

41.33. 6.16.1 - 2022-10-13

Bugfixes

  • Fix Environments without a color to have a default color

41.34. 6.16.0 - 2022-09-30

Bugfixes

  • Fix fetching pluginConfigs when updating ConnectorPluginInfo ConnectPlugins

41.35. 6.15.1 - 2022-09-13

Bugfixes

41.36. 6.15.0 - 2022-08-24

Added

41.37. 6.14.0 - 2022-08-16

Added

Bugfixes

41.38. 6.13.0 - 2022-07-25

Added

Bugfixes

41.39. 6.12.1 - 2022-07-12

Added

  • Made Stream Value Type, Key Type, Retention Time, Schema(if AVRO) editable Update a stream

41.40. 6.12.0 - 2022-06-15

Added

Bugfixes

  • Fix API to provide proper HTTP error response when Vault is unavailable

  • Fix User profile to display group membership /groups/search/findByMembersContains

  • When creating a stream-config and instance without segment.ms property, load it from Management API defaults Create stream config endpoints

  • Fix issue while uploading LF certificate and private-key to Vault

41.41. 6.11.0 - 2022-05-19

Added

41.42. 6.10.0 - 2022-04-14

Added

41.43. 6.9.2 - 2022-03-29

Bugfixes

  • Fix generation of connector certUri when storing security on Vault

41.44. 6.9.1 - 2022-03-09 (NOT VALID FOR DEPLOYMENT)

Added

Bugfixes

  • Fix NPE when the connector returns a null ConfigValue

41.45. 6.9.0 - 2022-02-23 (NOT VALID FOR DEPLOYMENT)

Added

Bugfixes

41.46. 6.8.0 - 2021-12-16

Added

Bugfixes

41.47. 6.7.1 - 2021-11-11

Added

41.48. 6.7.0 - 2021-10-21

Added

  • Use environment connector plugin version

41.49. 6.6.0 - 2021-10-07

Added

41.50. 6.5.0 - 2021-09-14

Added

Bugfixes

  • Fix inconsistency between Axual Connect state and self-service state

  • Management API cannot create new cluster Create a cluster

41.51. 6.4.0 - 2021-08-12

Added

  • Include cluster names to InstanceUsage returned to Billing View Usage

Bugfixes

41.52. 6.3.0 - 2021-07-15

Added

Bugfixes

41.53. 6.2.0 - 2021-06-17

Added

  • Disable changing an environment’s instance or shortName when stream configs exist Update an environment

41.54. 6.1.0 - 2021-06-10

Added

Bugfixes

  • Uploading the PEM file with the cert + intermediate CA + root CA gives error when saving principal Create Application Principal

  • Support windows line ending for PK/certificate/schema upload

41.55. 6.0.1 - 2021-04-22

Added

41.56. 6.0.0 - 2021-03-22

Added

  • Add support for exactly once semantics in Producers.

42. Deprecated APIs

All the deprecated APIs and their alternatives are listed below. These deprecated endpoints will be removed as part of next major release

Deprecated API Alternative API Deprecated since version Removed since version

GET /instances/search/findByName

/instances/search/findByAttributes

10.1.0

Not removed yet

GET /instances/search/findByNameContaining

/instances/search/findByAttributes

10.1.0

Not removed yet

POST /groups/{uid}/members

Update a Group

10.0.0

Not removed yet

GET /groups/{uid}/members

Retrieve a group

10.0.0

Not removed yet

PUT /groups/{uid}/members

Update a Group

10.0.0

Not removed yet

DELETE /groups/{uid}/members/{uid}

Update a Group

10.0.0

Not removed yet

POST /application_credentials

Create Credential on Apache Kafka

9.1.2

10.0.0

DELETE /application_credentials

Delete User on any Providers

9.1.2

10.0.0

GET /streams/{uid}/browse-config

Topic browse config

9.1.2

Not removed yet

GET /schemas/getAllWithLatestSchemaVersion

List all schemas with the latest schema versions and links

8.7.0

Not removed yet

POST /schemas

Upload schemas

8.6.2

10.0.0

PATCH /application_principals/{uid}

Create Application Principal Delete application principal

8.4.0

Not removed yet

DELETE /application_access/{uid}/grants

Revoke/Deny an authorization request for an ApplicationAccessGrant

7.0.4

Not removed yet

GET /application_access_grants/search/findActionable

Searching grants by Attributes

7.0.4

Not removed yet

GET /application_access_grants/search/findInformative

Searching grants by Attributes

7.0.4

Not removed yet

GET /application_access_grants/search/findAllInformative

Searching grants by Attributes

7.0.4

Not removed yet

GET streams/{uid}/browse-access

Use StreamBrowse

7.0.3

Not removed yet

GET /application_access/{uid}

6.20.0

Not removed yet

GET /application_access/search/findByApplication

6.20.0

Not removed yet

GET /application_access/search/findByStream

6.20.0

Not removed yet

GET /application_access/search/findByApplicationAndStream

6.20.0

Not removed yet

GET /application_access/search/findByEnvironment

6.20.0

Not removed yet

POST /application_access

Create an ApplicationAccessGrant

6.20.0

Not removed yet

POST /application_access/{uid}/grants

Create an ApplicationAccessGrant

6.20.0

Not removed yet

GET /application_access_grants/search/findByStream

Searching grants by Attributes

6.20.0

Not removed yet

POST /schema_versions

Upload schemas

6.14.0

10.0.0

GET /applications/search/findByName

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findByShortName

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findByNameIgnoreCase

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findByApplicationType

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findByApplicationIds

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findAll

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /applications/search/findByNameContaining

/applications/search/findByAttributes

6.14.0

Not removed yet

GET /auth/billing

Auth

6.9.0

10.0.0

GET /auth/subscription

Auth

6.9.0

10.0.0

POST /schemas/check

Check and Parse a schema

6.3.0

10.0.0

GET streams/{uid}/browse

Use StreamBrowse

4.5.0

10.0.0

43. Inconsistent Errors

All error responses will be made consistent with the Errors. Some scenarios were listed below.

Scenario Incompatible Error (Sample Response) Compatible Error (Sample Response) Available since api version

While creating any resource with invalid value, the service throws a 400-BAD_REQUEST exception with the compatible error format.

 
{
"errors": [
  {
   "entity": "Application",
   "property": "type",
   "invalidValue": null,
   "message": "Type must be provided."
  }
 ]
}
 
{
   "status": "BAD_REQUEST",
   "message": "Bad request",
   "errors": [
     "Type must be provided."
   ],
   "subErrors": [
    {
      "field": "Application.type",
      "rejectedValue": null,
      "recommendedValues": null,
      "errors": [
        "Type must be provided."
      ]
    }
   ]
}

7.0.0

While updating any resource with invalid value, the service throws a 400-BAD_REQUEST exception with the compatible error format.

 
{
  "errors": [
  {
   "entity": "Application",
   "property": "applicationIds",
   "invalidValue": [
    "nl.tenanta.app2"
   ],
   "message": "Duplicate applicationId"
  }
 ]
}
 
{
   "status": "BAD_REQUEST",
   "message": "Bad request",
   "errors": [
     "Type must be provided."
   ],
   "subErrors": [
    {
     "field": "Application.type",
     "rejectedValue": null,
     "recommendedValues": null,
     "errors": [
       "Type must be provided."
     ]
    }
   ]
}

7.0.0

When performing a GET on the resource either when it is not available or if you do not have access to, the service throws a 404-NOT_FOUND exception with the compatible error format.

 
empty response body
 
{
   "status": "NOT_FOUND",
   "message": "Resource not found or you do not have permissions to access it.",
   "errors": [
     "EntityRepresentationModel not found!"
   ],
   "subErrors": null
}

7.0.0

While updating streamConfig with an incompatible key/value schema version, the service throws a 502-BAD_GATEWAY exception. This scenario had been returning 403-FORBIDDEN HTTP status before the change.

 
ApiError(status=403
FORBIDDEN,
message=Request
processing failed;
nested exception is
io.axual.flux.core.exception.
InstanceClientCreateException:
Failed topic creation
for stream tenanta-stream1
on tenantaenv1 for instance
http//aeb-ota.local;
nested exception is
org.springframework.web
.client.HttpClientError
Exception$UnprocessableEntity:
422 Unprocessable Entity,
errors=null, subErrors=null)
 
{
   "status": "BAD_GATEWAY",
   "message": "Failed to apply stream. The key schema you are trying to apply is incompatible with latest key schema version.",
   "errors": [
     "422 Unprocessable Entity"
   ],
   "subErrors": null
}

7.0.0

Breaking Changes

This document lists all the breaking changes introduced in each major version. Please review the changes for each version to ensure compatibility with your existing systems.

44. Version 9.0.0

44.1. Cleanup of notificationsEnabled field

Response structure for /user and /tenant has changed:

...
"settings" : {
  "notificationEnabled" : "true"
},
"notificationEnabled" : "true" // removed
...

Also, notificationEnabled field was removed from the response of /me endpoint.

API references: Retrieve user and Retrieve tenant