Solace DocsDeveloper HubSolace Community
API Reference

Get a list of client username reference configurations

get
https://api.solace.cloud/api/v2/architecture/designer/configuration/solaceClientUsernameReferences

Get a list of client username reference configurations for event broker connections from an application in Event Portal.

Your token must have one of the permissions listed in the Token Permissions.


Token Permissions: [ event_designer:access ]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
1 to 100
Defaults to 20

The number of client username Reference configurations to return per page.

int32
≥ 1
Defaults to 1

The page number to retrieve.

eventBrokerIds
array of strings

The unique identifiers of the event brokers, separated by commas, to retrieve client username reference configurations from.

eventBrokerIds
ids
array of strings

The unique identifiers of the client username reference configurations to retrieve, separated by commas.

ids
entityIds
array of strings

The unique identifiers of designer entities, separated by commas, to retrieve client username configurations from.

entityIds
string

The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.
Define the sort order using the following string: fieldname:asc/desc where:

  • fieldname — The field name of the query parameter to sort by.
  • asc — Sort the selected field name in ascending order.
  • desc — Sort the selected field name in descending order.

If the direction is not specified, the default is ascending.

You can use multiple query parameters to refine the sorting order.

Headers
string
enum
Defaults to application/json;charset=UTF-8

Generated from available response content types

Allowed:
Responses

Updated 9 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json;charset=UTF-8
application/json

Updated 9 months ago