Getting Started

Using PubSub+ Cloud REST APIs
Legacy v0/v1 REST APIs for PubSub+ Cloud

Using API Management

API Management in PubSub+ Event Portal

MISSION CONTROL

Broker Configuration Using SEMP Proxy
Client Profiles
Environments
- (Beta) Get details of an environment in Mission Controlget
- (Beta) Update details for an environment in Mission Controlpatch
Event Broker Services
Server Certificates

Event Portal - Designer

Application Domain Operations
- Create change application domain operationpost
- Get a change application domain operation's detailsget
Application Domains
Application Version Event Access Requests
Applications
Configuration Templates
Configuration Types
- (Beta) Get a list of configuration typesget
- (Beta) Get a configuration typeget
Consumers
Custom Attribute Definitions
Designer Configurations
Enums
Event API Products
Event APIs
Event Access Requests
Event Access Reviews
Event Portal Usage Stats
- (EA) Get event portal usage statsget
Events
Schemas
States
- Get a list of lifecycle statesget
Topic Domains

Event Portal - Runtime

Application Configuration Push Job
- Get a list of configuration push jobs by application identifierget
Application Deployments
- (EA) Create a preview of the application deploymentpost
- Create an application deploymentpost
Audit Results
- Get a list of audit resultsget
- Get the details of a single audit resultget
Environments
Event Management Agents
Event Meshes
Event Portal Usage Stats
- (EA) Get event portal usage statsget
Messaging Service Scan Data
- Get a list of messaging service scan dataget
- Get a messaging service scan dataget
Messaging Service Scan Logs
- Get a list of messaging service scan logsget
Messaging Service Scans
Messaging Services
Modeled Event Broker
- Get a list of basic information for all model event brokersget

Event Portal - API Management

Event API Products
Registrations
Gateways

Platform

Environments
Roles
- (Beta) Get a list of rolesget
Access Control
- (Beta) Get the role- and resource-based assignmentsget
- (Beta) Add or replace the role and resource assignmentsput
Single Sign-On
- (Beta) Get the assigned claimsget
- (Beta) Add or replace the claim mappingsput
User Groups
Users
- (Beta) Get a list of users in your accountget

Billing

Usage

Micro-Integrations

Micro-Integrations
Micro-Integration Types

Getting Started

Using PubSub+ Cloud REST APIs
Legacy v0/v1 REST APIs for PubSub+ Cloud

Using API Management

API Management in PubSub+ Event Portal

MISSION CONTROL

Broker Configuration Using SEMP Proxy
Client Profiles
Environments
- (Beta) Get details of an environment in Mission Controlget
- (Beta) Update details for an environment in Mission Controlpatch
Event Broker Services
Server Certificates

Event Portal - Designer

Application Domain Operations
- Create change application domain operationpost
- Get a change application domain operation's detailsget
Application Domains
Application Version Event Access Requests
Applications
Configuration Templates
Configuration Types
- (Beta) Get a list of configuration typesget
- (Beta) Get a configuration typeget
Consumers
Custom Attribute Definitions
Designer Configurations
Enums
Event API Products
Event APIs
Event Access Requests
Event Access Reviews
Event Portal Usage Stats
- (EA) Get event portal usage statsget
Events
Schemas
States
- Get a list of lifecycle statesget
Topic Domains

Event Portal - Runtime

Application Configuration Push Job
- Get a list of configuration push jobs by application identifierget
Application Deployments
- (EA) Create a preview of the application deploymentpost
- Create an application deploymentpost
Audit Results
- Get a list of audit resultsget
- Get the details of a single audit resultget
Environments
Event Management Agents
Event Meshes
Event Portal Usage Stats
- (EA) Get event portal usage statsget
Messaging Service Scan Data
- Get a list of messaging service scan dataget
- Get a messaging service scan dataget
Messaging Service Scan Logs
- Get a list of messaging service scan logsget
Messaging Service Scans
Messaging Services
Modeled Event Broker
- Get a list of basic information for all model event brokersget

Event Portal - API Management

Event API Products
Registrations
Gateways

Platform

Environments
Roles
- (Beta) Get a list of rolesget
Access Control
- (Beta) Get the role- and resource-based assignmentsget
- (Beta) Add or replace the role and resource assignmentsput
Single Sign-On
- (Beta) Get the assigned claimsget
- (Beta) Add or replace the claim mappingsput
User Groups
Users
- (Beta) Get a list of users in your accountget

Billing

Usage

Micro-Integrations

Micro-Integrations
Micro-Integration Types

(Beta) Create a user group

post https://api.solace.cloud/api/v2/platform/userGroups

Create a user group. You can assign roles when creating the user group. Users who belong to the user group inherit the group's assigned roles and entitlements.

Token Permissions: [ iam_user_group:write ]

URL Expired

The URL for this request expired after 30 days.

Body Params

name

string

required

length between 1 and 50

The name of the user group.

description

string

length between 0 and 255

A description of the user group.

roles

array of strings

A collection of unique identifiers representing the roles assigned to the user group.

roles

Responses

Response body

object

data

object

uuid

The unique identifier for the user group.

organizationId

string

The unique identifier for the account (organization).

name

string

The name of the user group.

description

string

A description of the user group.

roles

array of strings

A collection of unique identifiers representing the roles assigned to the user group.

roles

meta

object

The metadata about the response, which can include:

Pagination data, such as page number, page size, etc. for GET operations that return large amount of response data. For more information, see Pagination.
Timestamp information, such as current time, or the time create or update operation occurred for CREATE, PUT, POST operations.

included

array of objects

included

object

Response body

object

message

string

A user-friendly message that describes the error.

errorId

string

The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.

meta

object

validationDetails

object

When applicable, these are the details of issues with the fields provided for the REST call.

Response body

object

message

string

A user-friendly message that describes the error.

errorId

string

The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.

meta

object

validationDetails

object

When applicable, these are the details of issues with the fields provided for the REST call.

Response body

object

message

string

A user-friendly message that describes the error.

errorId

string

The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.

meta

object

validationDetails

object

When applicable, these are the details of issues with the fields provided for the REST call.

Response body

object

message

string

A user-friendly message that describes the error.

errorId

string

The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.

meta

object

validationDetails

object

When applicable, these are the details of issues with the fields provided for the REST call.

Updated over 1 year ago

(Beta) Get a list of user groups

(Beta) Get a specific user group by identifier

Did this page help you?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.solace.cloud/api/v2/platform/userGroups \
3
     --header 'accept: */*' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

Updated over 1 year ago

(Beta) Get a list of user groups

(Beta) Get a specific user group by identifier

Did this page help you?

Getting Started
Using PubSub+ Cloud REST APIs
SEMP Objects
Error Handling
Authentication
Filtering
Pagination
Versioning
Legacy v0/v1 REST APIs for PubSub+ Cloud

Using API Management
API Management in PubSub+ Event Portal
Reference - Managed Configuration on Event Brokers
Application Registration Credentials Management
Pagination in the API Management Dev Portal
Filtering with RSQL queries
API Walkthrough of the APIM/DevPortal
Getting Started with API Management Dev Portal

MISSION CONTROL
Broker Configuration Using SEMP Proxy
(Beta) Update a resource object on an event broker service using a SEMP PATCHpatch
(Beta) Delete a resource object on an event broker service by object path using a SEMP DELETEdelete
(Beta) Create a resource object for an event broker service using a SEMP POSTpost
(Beta) Replace a resource object on an event broker service using a SEMP PUTput
(Beta) Get a specific resource object for an event broker service by the object path using a SEMP GETget
Client Profiles
Update a client profilepatch
Delete a client profiledelete
Replace a client profileput
Get a specific client profile for event broker service by nameget
Create a client profilepost
Get a list of client profilesget
Environments
(Beta) Update details for an environment in Mission Controlpatch
(Beta) Get details of an environment in Mission Controlget
Event Broker Services
Get a specific service class by identifierget
Get a list of service classesget
(Beta) Get the organization message spool expansion informationget
(Beta) Update whether an event broker service allows basic authentication for management accessput
Get the status of a service operationget
Update the event broker service message spool sizepatch
Create a clone of an existing event broker servicepost
Update an event broker servicepatch
Delete an event broker servicedelete
Get a specific event broker service by identifierget
Create an event broker servicepost
Get a list of event broker servicesget
(Beta) Get event broker versionsget
Get a list of available software event broker versionsget
Update a datacenter's environmentpatch
Get a specific datacenter by identifierget
Get a list of datacentersget
Server Certificates
(Beta) Initiate installation of a server certificate by its IDpost
(Beta) Delete a server certificate by its IDdelete
(Beta) Get a server certificate by its IDget
(Beta) Initiate an upload of a server certificatepost
(Beta) Get all server certificatesget

Event Portal - Designer
Application Domain Operations
Get a change application domain operation's detailsget
Create change application domain operationpost
Application Domains
Update an application domainpatch
Delete an application domaindelete
Get an application domainget
(Beta) Create application domains and their entities from importpost
(Beta) Get application domains and their entities for exportget
Create an application domainpost
Get a list of the application domainsget
Application Version Event Access Requests
(EA) Create missing event access requests for application version id and send notifications to reviewerspost
(EA) Get event access requests by application version idget
(EA) Get expected event access requests by application version idget
Applications
Update an applicationpatch
Delete an applicationdelete
Get an applicationget
Create an applicationpost
Get a list of applicationsget
Update the state of an application versionpatch
Replace messaging service association for an application versionput
Update an application versionpatch
Delete an application versiondelete
Get an application versionget
(Beta) Get the AsyncAPI specification for an application versionget
Get the AsyncAPI specification for an application versionget
Create an application versionpost
Get a list of application versionsget
(EA) Get a list of basic information for all applicationsget
Configuration Templates
(EA) Update a Solace queue configuration templatepatch
(EA) Delete a Solace queue configuration templatedelete
(EA) Get a specific Solace queue configuration templateget
(EA) Create a Solace queue configuration templatepost
(EA) Get a list of Solace queue configuration templatesget
(EA) Update a client profile name configuration templatepatch
(EA) Delete a client profile name configuration templatedelete
(EA) Get a specific client profile name configuration templateget
(EA) Create a client profile name configuration templatepost
(EA) Get a list of client profile name configuration templatesget
Configuration Types
(Beta) Get a configuration typeget
(Beta) Get a list of configuration typesget
Consumers
Update a consumerpatch
Delete a consumerdelete
Get a consumerget
Create a consumerpost
Get a list of consumersget
Custom Attribute Definitions
Update a custom attribute definitionpatch
Delete a custom attribute definitiondelete
Get a custom attribute definitionget
Create a custom attribute definitionpost
Get a list of custom attribute definitionsget
Update a custom attribute definition for provided application domainpatch
Delete a custom attribute definition of provided application domaindelete
Delete a custom attribute definition of provided application domaindelete
Create a custom attribute definition for provided application domainpost
Get a list the custom attribute definitions of provided application domainget
Designer Configurations
Delete a queue configurationdelete
Get a specific queue configurationget
Create a queue configurationpost
Get a list of queue configurationsget
Delete a client username configurationdelete
Get a specific client username configurationget
Create a client username configurationpost
Get a list of client username configurationsget
Delete a client profile name configurationdelete
Get a specific client profile name configurationget
Create a client profile name configurationpost
Get a list of client profile name configurationsget
Delete an LDAP authorization group configurationdelete
Get a specific LDAP authorization group configurationget
Create an LDAP authorization group configurationpost
Get a list of LDAP authorization group configurationsget
Enums
Update an enumerationpatch
Delete an enumerationdelete
Get an enumerationget
Create an enumerationpost
Get a list of enumerationsget
Get an enumeration versionget
Update the state of an enumeration versionpatch
Update an enumeration versionpatch
Delete an enumeration versiondelete
Create an enumeration versionpost
Get a list of enumeration versionsget
Event API Products
Update an Event API Productpatch
Delete an Event API Productdelete
Get an Event API Productget
Create an Event API Productpost
Get a List of Event API Productsget
Update the State of an Event API Product Version by IDpatch
Update an Event API Product Version To Be Publishedpatch
(Beta) Update an Event API Product Version by Version IDpatch
(Beta) Delete an Event API Product Version by IDdelete
(Beta) Get an Event API Product Versionget
(Beta) Delete an Association Between a Gateway Messaging Service and an Event API Product Versiondelete
(Beta) Create an Association Between a Gateway Messaging Service and an Event API Product Versionpost
(Beta) Create an Event API Product Versionpost
(Beta) Get a List of Event API Product Versionsget
(Beta) Delete an Association Between a Gateway Messaging Service and an Event API Product Version by Association IDdelete
Event APIs
Update an Event APIpatch
Delete an Event APIdelete
Get an Event APIget
Create an Event APIpost
Get a List of Event APIsget
Update the State of an Event API Version by Event API Version IDpatch
Update an Event API by Event API Version IDpatch
Delete an Event API Versiondelete
Get an Event API Versionget
(Beta) Get the AsyncAPI Specification for an Event API Versionget
Get the AsyncAPI Specification for an Event API Versionget
Create an Event API Versionpost
Get a List of Event API Versionsget
Event Access Requests
(EA) Update an event access request to be declinedpost
(EA) Update an event access request to be approvedpost
(EA) Update an event access requestpatch
(EA) Get event access request by idget
(EA) Get event access requestsget
Event Access Reviews
(EA) Update an event access reviewpatch
(EA) Delete an event access reviewdelete
(EA) Get event access review by idget
(EA) Create an event access reviewpost
(EA) Get a list of event access reviewsget
Event Portal Usage Stats
(EA) Get event portal usage statsget
Events
Update an eventpatch
Delete an eventdelete
Get an eventget
Create an eventpost
Get a list of eventsget
Update the state of an event versionpatch
Replace messaging service association for an event versionput
Update an event versionpatch
Delete an event versiondelete
Get an event versionget
Create an event versionpost
Get a list of event versionsget
Schemas
Update a schemapatch
Delete a schemadelete
Get a schemaget
Create a schemapost
Get a list of schemasget
Get a schema versionget
Update the state of a schema versionpatch
Update a schema versionpatch
Delete a schema versiondelete
Create a schema versionpost
Get a list of schema versionsget
States
Get a list of lifecycle statesget
Topic Domains
Delete a topic domaindelete
Get a topic domainget
Create a topic domainpost
Get a list of the topic domainsget

Event Portal - Runtime
Application Configuration Push Job
Get a list of configuration push jobs by application identifierget
Application Deployments
Create an application deploymentpost
(EA) Create a preview of the application deploymentpost
Audit Results
Get the details of a single audit resultget
Get a list of audit resultsget
Environments
Update environment runtime configurationpatch
Get an environmentget
Get a list of environmentsget
Get a list of basic environment informationget
Event Management Agents
Get the raw configs in string format for an EMA objectget
Update an EMA objectpatch
Delete an EMA objectdelete
Get an EMA objectget
Create an EMA objectpost
Get a list of EMAsget
Event Meshes
Update a modeled event meshpatch
Delete a modeled event meshdelete
Get a modeled event meshget
Create a modeled event meshpost
Get a list of modeled event meshesget
(EA) Get entities with warnings associated with the specified modeled event meshget
Get a list of basic information for all modeled event meshesget
Event Portal Usage Stats
(EA) Get event portal usage statsget
Messaging Service Scan Data
Get a messaging service scan dataget
Get a list of messaging service scan dataget
Messaging Service Scan Logs
Get a list of messaging service scan logsget
Messaging Service Scans
Delete a messaging service scandelete
Get a messaging service scanget
Get a list of messaging service scansget
Messaging Services
Initiate a scan request to run against a messaging serviceput
Remove an association between an messaging service and the requested entityput
Update a messaging servicepatch
Delete a messaging servicedelete
Get a messaging serviceget
Create a messaging servicepost
Get a list of messaging servicesget
Modeled Event Broker
Get a list of basic information for all model event brokersget

Event Portal - API Management
Event API Products
(Early Access) Returns the Async APi specification associated with the Event API Product and Planget
(Early Access) Returns a list of the APIs associated with the Event API Product and Planget
(Early Access) Returns the requested plan of the Event API Productget
(Early Access) Returns a list of plans of the Event API Productget
(Early Access) Deletes the specified attribute from the Event API Productdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the Event API Productget
(Early Access) Adds an attribute to the Event API Productpost
(Early Access) Returns attributes of the Event API Productget
(Early Access) Returns the version of an Event API Productget
(Early Access) Returns a list of versions of an Event API Product.get
(Early Access) Returns the requested Event API Productget
(Early Access) Returns a list of published Event API Productsget
Registrations
(Early Access) Returns the config state of an application registrationget
(Early Access) Deletes the specified webhook registration from the App Registration (Coming Soon)delete
(Early Access) Updates the specified webhook registration on the App Registration (Coming Soon)patch
(Early Access) Returns the specified webhook registration from the App Registration (Coming Soon)get
(Early Access) Creates a new webhook registration on the App Registration (Coming Soon)post
(Early Access) Returns a list of webhook registrations (Coming Soon)get
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Returns the Async API specification associated with the Access Request.get
(Early Access) Returns a list of all Event APIs associated with the Access Requestget
(Early Access) Deletes the specified Access Request form the App Registrationdelete
(Early Access) Updates the Access Request associated with the Application Registrationpatch
(Early Access) Returns the requested Access Request associated with the specified App Registrationget
(Early Access) Creates a new Access Request.post
(Early Access) Returns a list of Access Requests associated with the App Registrationget
(Early Access) Deletes the credentials with the specified Consumer Key from the App Registrationdelete
(Early Access) Updates the credentials with the specified Consumer Keypatch
(Early Access) Returns the Credentials with the specified Consumer Keyget
(Early Access) Requests new credentials for the App Registrationpost
(Early Access) Returns a list of all Credentials issued for the App Registrationget
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Deletes the specified attribute from the App Registrationdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the App Registrationget
(Early Access) Adds an attribute to the App Registrationpost
(Early Access) Returns attributes of the App Registrationget
(Early Access) Returns the Async API specification associated with the App Registration.get
(Early Access) Returns a list of all Event APIs associated with the App Registrationget
(Early Access) Deletes the specified App Registrationdelete
(Early Access) Updates the specified App Registrationpatch
(Early Access) Returns the requested App Registrationget
(Early Access) Creates a new App Registrationpost
(Early Access) Returns a list of Application Registrationsget
Gateways
(Early Access) Returns the status of the Gateway Broker Serviceget
(Early Access) Sets or updates the SEMPv2 secret used to connect to the Gateway Brokerpatch
(Early Access) Returns the specified Gateway Broker Serviceget
(Early Access) Set the authentication mode for the Event Broker Gatewayspost
(Early Access) Returns a list of all available Gateway Event Brokersget

Platform
Environments
Update an environment's attributespatch
Delete an environmentdelete
Update an environment's attributesput
Get an environmentget
Create an environmentpost
Get list of environmentsget
Roles
(Beta) Get a list of rolesget
Access Control
(Beta) Add or replace the role and resource assignmentsput
(Beta) Get the role- and resource-based assignmentsget
Single Sign-On
(Beta) Add or replace the claim mappingsput
(Beta) Get the assigned claimsget
User Groups
(Beta) Delete a specific user group by identifierdelete
(Beta) Update a user groupput
(Beta) Get a specific user group by identifierget
(Beta) Create a user grouppost
(Beta) Get a list of user groupsget
Users
(Beta) Get a list of users in your accountget

Billing
Usage
Get usage aggregates for your organizationget
Get service usage for your organizationget
Get the usage summary for your organizationget
Get the usage summary for your organizationget

Micro-Integrations
Micro-Integrations
(Beta) Update the state of a Micro-Integrationpatch
(Beta) Initiate a clone of a Micro-Integrationpost
(Beta) Update a Micro-Integrationpatch
(Beta) Delete a Micro-Integrationdelete
(Beta) Get a Micro-Integrationget
(Beta) Create a Micro-Integrationpost
(Beta) Get a list of Micro-Integrationsget
Micro-Integration Types
(Beta) Get a list of Micro-Integration templatesget
(Beta) Get a Micro-Integration typeget
(Beta) Get a list of Micro-Integration typesget

Getting Started
Using PubSub+ Cloud REST APIs
SEMP Objects
Error Handling
Authentication
Filtering
Pagination
Versioning
Legacy v0/v1 REST APIs for PubSub+ Cloud

Using API Management
API Management in PubSub+ Event Portal
Reference - Managed Configuration on Event Brokers
Application Registration Credentials Management
Pagination in the API Management Dev Portal
Filtering with RSQL queries
API Walkthrough of the APIM/DevPortal
Getting Started with API Management Dev Portal

MISSION CONTROL
Broker Configuration Using SEMP Proxy
(Beta) Update a resource object on an event broker service using a SEMP PATCHpatch
(Beta) Delete a resource object on an event broker service by object path using a SEMP DELETEdelete
(Beta) Create a resource object for an event broker service using a SEMP POSTpost
(Beta) Replace a resource object on an event broker service using a SEMP PUTput
(Beta) Get a specific resource object for an event broker service by the object path using a SEMP GETget
Client Profiles
Update a client profilepatch
Delete a client profiledelete
Replace a client profileput
Get a specific client profile for event broker service by nameget
Create a client profilepost
Get a list of client profilesget
Environments
(Beta) Update details for an environment in Mission Controlpatch
(Beta) Get details of an environment in Mission Controlget
Event Broker Services
Get a specific service class by identifierget
Get a list of service classesget
(Beta) Get the organization message spool expansion informationget
(Beta) Update whether an event broker service allows basic authentication for management accessput
Get the status of a service operationget
Update the event broker service message spool sizepatch
Create a clone of an existing event broker servicepost
Update an event broker servicepatch
Delete an event broker servicedelete
Get a specific event broker service by identifierget
Create an event broker servicepost
Get a list of event broker servicesget
(Beta) Get event broker versionsget
Get a list of available software event broker versionsget
Update a datacenter's environmentpatch
Get a specific datacenter by identifierget
Get a list of datacentersget
Server Certificates
(Beta) Initiate installation of a server certificate by its IDpost
(Beta) Delete a server certificate by its IDdelete
(Beta) Get a server certificate by its IDget
(Beta) Initiate an upload of a server certificatepost
(Beta) Get all server certificatesget

Event Portal - Designer
Application Domain Operations
Get a change application domain operation's detailsget
Create change application domain operationpost
Application Domains
Update an application domainpatch
Delete an application domaindelete
Get an application domainget
(Beta) Create application domains and their entities from importpost
(Beta) Get application domains and their entities for exportget
Create an application domainpost
Get a list of the application domainsget
Application Version Event Access Requests
(EA) Create missing event access requests for application version id and send notifications to reviewerspost
(EA) Get event access requests by application version idget
(EA) Get expected event access requests by application version idget
Applications
Update an applicationpatch
Delete an applicationdelete
Get an applicationget
Create an applicationpost
Get a list of applicationsget
Update the state of an application versionpatch
Replace messaging service association for an application versionput
Update an application versionpatch
Delete an application versiondelete
Get an application versionget
(Beta) Get the AsyncAPI specification for an application versionget
Get the AsyncAPI specification for an application versionget
Create an application versionpost
Get a list of application versionsget
(EA) Get a list of basic information for all applicationsget
Configuration Templates
(EA) Update a Solace queue configuration templatepatch
(EA) Delete a Solace queue configuration templatedelete
(EA) Get a specific Solace queue configuration templateget
(EA) Create a Solace queue configuration templatepost
(EA) Get a list of Solace queue configuration templatesget
(EA) Update a client profile name configuration templatepatch
(EA) Delete a client profile name configuration templatedelete
(EA) Get a specific client profile name configuration templateget
(EA) Create a client profile name configuration templatepost
(EA) Get a list of client profile name configuration templatesget
Configuration Types
(Beta) Get a configuration typeget
(Beta) Get a list of configuration typesget
Consumers
Update a consumerpatch
Delete a consumerdelete
Get a consumerget
Create a consumerpost
Get a list of consumersget
Custom Attribute Definitions
Update a custom attribute definitionpatch
Delete a custom attribute definitiondelete
Get a custom attribute definitionget
Create a custom attribute definitionpost
Get a list of custom attribute definitionsget
Update a custom attribute definition for provided application domainpatch
Delete a custom attribute definition of provided application domaindelete
Delete a custom attribute definition of provided application domaindelete
Create a custom attribute definition for provided application domainpost
Get a list the custom attribute definitions of provided application domainget
Designer Configurations
Delete a queue configurationdelete
Get a specific queue configurationget
Create a queue configurationpost
Get a list of queue configurationsget
Delete a client username configurationdelete
Get a specific client username configurationget
Create a client username configurationpost
Get a list of client username configurationsget
Delete a client profile name configurationdelete
Get a specific client profile name configurationget
Create a client profile name configurationpost
Get a list of client profile name configurationsget
Delete an LDAP authorization group configurationdelete
Get a specific LDAP authorization group configurationget
Create an LDAP authorization group configurationpost
Get a list of LDAP authorization group configurationsget
Enums
Update an enumerationpatch
Delete an enumerationdelete
Get an enumerationget
Create an enumerationpost
Get a list of enumerationsget
Get an enumeration versionget
Update the state of an enumeration versionpatch
Update an enumeration versionpatch
Delete an enumeration versiondelete
Create an enumeration versionpost
Get a list of enumeration versionsget
Event API Products
Update an Event API Productpatch
Delete an Event API Productdelete
Get an Event API Productget
Create an Event API Productpost
Get a List of Event API Productsget
Update the State of an Event API Product Version by IDpatch
Update an Event API Product Version To Be Publishedpatch
(Beta) Update an Event API Product Version by Version IDpatch
(Beta) Delete an Event API Product Version by IDdelete
(Beta) Get an Event API Product Versionget
(Beta) Delete an Association Between a Gateway Messaging Service and an Event API Product Versiondelete
(Beta) Create an Association Between a Gateway Messaging Service and an Event API Product Versionpost
(Beta) Create an Event API Product Versionpost
(Beta) Get a List of Event API Product Versionsget
(Beta) Delete an Association Between a Gateway Messaging Service and an Event API Product Version by Association IDdelete
Event APIs
Update an Event APIpatch
Delete an Event APIdelete
Get an Event APIget
Create an Event APIpost
Get a List of Event APIsget
Update the State of an Event API Version by Event API Version IDpatch
Update an Event API by Event API Version IDpatch
Delete an Event API Versiondelete
Get an Event API Versionget
(Beta) Get the AsyncAPI Specification for an Event API Versionget
Get the AsyncAPI Specification for an Event API Versionget
Create an Event API Versionpost
Get a List of Event API Versionsget
Event Access Requests
(EA) Update an event access request to be declinedpost
(EA) Update an event access request to be approvedpost
(EA) Update an event access requestpatch
(EA) Get event access request by idget
(EA) Get event access requestsget
Event Access Reviews
(EA) Update an event access reviewpatch
(EA) Delete an event access reviewdelete
(EA) Get event access review by idget
(EA) Create an event access reviewpost
(EA) Get a list of event access reviewsget
Event Portal Usage Stats
(EA) Get event portal usage statsget
Events
Update an eventpatch
Delete an eventdelete
Get an eventget
Create an eventpost
Get a list of eventsget
Update the state of an event versionpatch
Replace messaging service association for an event versionput
Update an event versionpatch
Delete an event versiondelete
Get an event versionget
Create an event versionpost
Get a list of event versionsget
Schemas
Update a schemapatch
Delete a schemadelete
Get a schemaget
Create a schemapost
Get a list of schemasget
Get a schema versionget
Update the state of a schema versionpatch
Update a schema versionpatch
Delete a schema versiondelete
Create a schema versionpost
Get a list of schema versionsget
States
Get a list of lifecycle statesget
Topic Domains
Delete a topic domaindelete
Get a topic domainget
Create a topic domainpost
Get a list of the topic domainsget

Event Portal - Runtime
Application Configuration Push Job
Get a list of configuration push jobs by application identifierget
Application Deployments
Create an application deploymentpost
(EA) Create a preview of the application deploymentpost
Audit Results
Get the details of a single audit resultget
Get a list of audit resultsget
Environments
Update environment runtime configurationpatch
Get an environmentget
Get a list of environmentsget
Get a list of basic environment informationget
Event Management Agents
Get the raw configs in string format for an EMA objectget
Update an EMA objectpatch
Delete an EMA objectdelete
Get an EMA objectget
Create an EMA objectpost
Get a list of EMAsget
Event Meshes
Update a modeled event meshpatch
Delete a modeled event meshdelete
Get a modeled event meshget
Create a modeled event meshpost
Get a list of modeled event meshesget
(EA) Get entities with warnings associated with the specified modeled event meshget
Get a list of basic information for all modeled event meshesget
Event Portal Usage Stats
(EA) Get event portal usage statsget
Messaging Service Scan Data
Get a messaging service scan dataget
Get a list of messaging service scan dataget
Messaging Service Scan Logs
Get a list of messaging service scan logsget
Messaging Service Scans
Delete a messaging service scandelete
Get a messaging service scanget
Get a list of messaging service scansget
Messaging Services
Initiate a scan request to run against a messaging serviceput
Remove an association between an messaging service and the requested entityput
Update a messaging servicepatch
Delete a messaging servicedelete
Get a messaging serviceget
Create a messaging servicepost
Get a list of messaging servicesget
Modeled Event Broker
Get a list of basic information for all model event brokersget

Event Portal - API Management
Event API Products
(Early Access) Returns the Async APi specification associated with the Event API Product and Planget
(Early Access) Returns a list of the APIs associated with the Event API Product and Planget
(Early Access) Returns the requested plan of the Event API Productget
(Early Access) Returns a list of plans of the Event API Productget
(Early Access) Deletes the specified attribute from the Event API Productdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the Event API Productget
(Early Access) Adds an attribute to the Event API Productpost
(Early Access) Returns attributes of the Event API Productget
(Early Access) Returns the version of an Event API Productget
(Early Access) Returns a list of versions of an Event API Product.get
(Early Access) Returns the requested Event API Productget
(Early Access) Returns a list of published Event API Productsget
Registrations
(Early Access) Returns the config state of an application registrationget
(Early Access) Deletes the specified webhook registration from the App Registration (Coming Soon)delete
(Early Access) Updates the specified webhook registration on the App Registration (Coming Soon)patch
(Early Access) Returns the specified webhook registration from the App Registration (Coming Soon)get
(Early Access) Creates a new webhook registration on the App Registration (Coming Soon)post
(Early Access) Returns a list of webhook registrations (Coming Soon)get
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Returns the Async API specification associated with the Access Request.get
(Early Access) Returns a list of all Event APIs associated with the Access Requestget
(Early Access) Deletes the specified Access Request form the App Registrationdelete
(Early Access) Updates the Access Request associated with the Application Registrationpatch
(Early Access) Returns the requested Access Request associated with the specified App Registrationget
(Early Access) Creates a new Access Request.post
(Early Access) Returns a list of Access Requests associated with the App Registrationget
(Early Access) Deletes the credentials with the specified Consumer Key from the App Registrationdelete
(Early Access) Updates the credentials with the specified Consumer Keypatch
(Early Access) Returns the Credentials with the specified Consumer Keyget
(Early Access) Requests new credentials for the App Registrationpost
(Early Access) Returns a list of all Credentials issued for the App Registrationget
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Deletes the specified attribute from the App Registrationdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the App Registrationget
(Early Access) Adds an attribute to the App Registrationpost
(Early Access) Returns attributes of the App Registrationget
(Early Access) Returns the Async API specification associated with the App Registration.get
(Early Access) Returns a list of all Event APIs associated with the App Registrationget
(Early Access) Deletes the specified App Registrationdelete
(Early Access) Updates the specified App Registrationpatch
(Early Access) Returns the requested App Registrationget
(Early Access) Creates a new App Registrationpost
(Early Access) Returns a list of Application Registrationsget
Gateways
(Early Access) Returns the status of the Gateway Broker Serviceget
(Early Access) Sets or updates the SEMPv2 secret used to connect to the Gateway Brokerpatch
(Early Access) Returns the specified Gateway Broker Serviceget
(Early Access) Set the authentication mode for the Event Broker Gatewayspost
(Early Access) Returns a list of all available Gateway Event Brokersget

Platform
Environments
Update an environment's attributespatch
Delete an environmentdelete
Update an environment's attributesput
Get an environmentget
Create an environmentpost
Get list of environmentsget
Roles
(Beta) Get a list of rolesget
Access Control
(Beta) Add or replace the role and resource assignmentsput
(Beta) Get the role- and resource-based assignmentsget
Single Sign-On
(Beta) Add or replace the claim mappingsput
(Beta) Get the assigned claimsget
User Groups
(Beta) Delete a specific user group by identifierdelete
(Beta) Update a user groupput
(Beta) Get a specific user group by identifierget
(Beta) Create a user grouppost
(Beta) Get a list of user groupsget
Users
(Beta) Get a list of users in your accountget

Billing
Usage
Get usage aggregates for your organizationget
Get service usage for your organizationget
Get the usage summary for your organizationget
Get the usage summary for your organizationget

Micro-Integrations
Micro-Integrations
(Beta) Update the state of a Micro-Integrationpatch
(Beta) Initiate a clone of a Micro-Integrationpost
(Beta) Update a Micro-Integrationpatch
(Beta) Delete a Micro-Integrationdelete
(Beta) Get a Micro-Integrationget
(Beta) Create a Micro-Integrationpost
(Beta) Get a list of Micro-Integrationsget
Micro-Integration Types
(Beta) Get a list of Micro-Integration templatesget
(Beta) Get a Micro-Integration typeget
(Beta) Get a list of Micro-Integration typesget

201Created.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.