---
updatedAt: 2026-07-28T13:51:34.000Z
---
# Get a specific client username configuration
Get a specific client username configuration for event broker connections from an application in Event Portal.
Use this endpoint to retrieve the details of a client username configuration, including the client username, associated
event broker, and the application (entity) it belongs to. This is useful for:
- Verifying configuration details before promoting an application to an environment
- Auditing existing client username configurations
- Retrieving configuration IDs for update or delete operations
**Note:** For security reasons, password values are not returned in the response. Only the configuration metadata
and client username are included.
For more information about client usernames, see:
- [Client Usernames on Operational Event Brokers](https://docs.solace.com/Cloud/client-profiles.htm)
- [Creating Runtime Configuration using the Event Portal UI
](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-apps-standard.htm#adding-runtime-configuration-to-a-standard-application)
- [Configuring Event Brokers in Event Portal](https://docs.solace.com/Cloud/Event-Portal/event-portal-runtime-config.htm)
Your token must have one of the permissions listed in the Token Permissions.
Token Permissions: [ `application:get:*` ]
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Event Portal - Designer",
"description": "REST API Concepts\n\nSolace Event Portal provides REST APIs that you can use to manage your data in Solace Cloud. \nThe REST APIs allow you to model your event-driven architectures from your own client applications.\n\nThe following document describes the public REST APIs available for use in Event Portal 2.0. Objects created in this \nversion will not be available in Event Portal 1.0. APIs that display (Beta) in their summary are provided as-is and \nare subject to change or removal. They may not be of the quality expected for generally available APIs and have no \nguaranteed forward compatibility with the generally available version of the API.\n\n",
"version": "2.13.2"
},
"servers": [
{
"url": "https://api.solace.cloud",
"description": "Solace PubSub+ Cloud US EAST Region"
},
{
"url": "https://api.solacecloud.com.au",
"description": "Solace PubSub+ Cloud AU Region"
},
{
"url": "https://api.solacecloud.eu",
"description": "Solace PubSub+ Cloud EU Region"
},
{
"url": "https://api.solacecloud.sg",
"description": "Solace PubSub+ Cloud SG Region"
}
],
"security": [
{
"APIToken": []
}
],
"tags": [
{
"name": "Designer Configurations"
}
],
"paths": {
"/api/v2/architecture/designer/configuration/solaceClientUsernames/{id}": {
"get": {
"tags": [
"Designer Configurations"
],
"summary": "Get a specific client username configuration",
"description": "Get a specific client username configuration for event broker connections from an application in Event Portal.\n\nUse this endpoint to retrieve the details of a client username configuration, including the client username, associated\nevent broker, and the application (entity) it belongs to. This is useful for:\n- Verifying configuration details before promoting an application to an environment\n- Auditing existing client username configurations\n- Retrieving configuration IDs for update or delete operations\n\n**Note:** For security reasons, password values are not returned in the response. Only the configuration metadata\nand client username are included.\n\nFor more information about client usernames, see:\n- [Client Usernames on Operational Event Brokers](https://docs.solace.com/Cloud/client-profiles.htm)\n- [Creating Runtime Configuration using the Event Portal UI\n](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-apps-standard.htm#adding-runtime-configuration-to-a-standard-application)\n- [Configuring Event Brokers in Event Portal](https://docs.solace.com/Cloud/Event-Portal/event-portal-runtime-config.htm)\n\nYour token must have one of the permissions listed in the Token Permissions.\n
Token Permissions: [ `application:get:*` ]",
"operationId": "getSolaceClientUsernameConfiguration",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier of the client username configuration.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/ConfigurationResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"501": {
"description": "Not Implemented",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Configuration": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"description": "The unique identifier of the configuration.",
"example": "xyz23mwec2g",
"readOnly": true
},
"contextType": {
"type": "string",
"description": "The type of the context that the configuration is for.",
"enum": [
"EVENT_BROKER"
],
"example": "EVENT_BROKER"
},
"contextId": {
"type": "string",
"description": "The unique identifier of the event broker that the client username configuration will be created on.",
"example": "acb2j5k3mly"
},
"configurationTypeId": {
"type": "string",
"description": "See Get a list of configuration types for detail.",
"example": "solaceClientUsername",
"readOnly": true
},
"entityType": {
"type": "string",
"description": "The type of the designer entity the configuration is for.",
"enum": [
"address",
"application",
"applicationVersion",
"audit",
"consumer",
"eventVersion",
"schema",
"schemaVersion",
"subscription"
],
"example": "consumer",
"readOnly": true
},
"entityId": {
"type": "string",
"description": "The unique identifier of the entity in Designer (such as an application or consumer) that the configuration is for.\nFor client username configurations, this is the ID of the application that uses the provided credentials\nto connect to the event broker.\n",
"example": "acb2j5k3mly"
},
"identifier": {
"type": "string",
"description": "The audit identifier of the designer entity the configuration is for.",
"example": "abc|123",
"readOnly": true
},
"templateId": {
"type": "string",
"description": "The unique identifier of the configuration template.",
"example": "acb2j5k3mly"
},
"resolvedValue": {
"type": "object",
"additionalProperties": {},
"description": "The final merged configuration value computed by combining the user-provided value with the configuration template.\n\nThis field is read-only and automatically generated by the system. When a configuration has both a template\n(referenced by templateId) and user-provided values (in the value field), the system merges them to create\nthe resolvedValue. User-provided values take precedence and override template defaults.\n\nThe resolvedValue represents the actual configuration that will be applied when the application is promoted\nto an environment. If no template is used, this field will match the user-provided value field.\n",
"example": "'object': { 'field': 'value' }",
"readOnly": true
},
"value": {
"type": "object",
"additionalProperties": {},
"description": "The configuration value in JSON format. The structure depends on the configuration type.",
"example": {
"clientUsername": "myapp-client-user",
"password": "SecureP@ssw0rd"
}
},
"workInProgress": {
"type": "boolean",
"default": false,
"description": "Set to true to mark this configuration as Work In Progress.\nWhen set to true, required fields (such as clientUsername and password for client username configurations)\nwill not be validated for presence, allowing you to save incomplete configurations.\nThis setting is useful when you want to create a configuration incrementally or save a draft.\n",
"example": true
},
"type": {
"type": "string",
"readOnly": true
}
},
"required": [
"contextId",
"contextType",
"entityId"
]
},
"ConfigurationResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Configuration"
},
"meta": {
"type": "object",
"additionalProperties": {}
}
}
},
"ErrorResponse": {
"type": "object",
"discriminator": {
"propertyName": "errorType"
},
"properties": {
"message": {
"type": "string",
"description": "A user-friendly message that describes the error.",
"example": "An error occurred."
},
"errorId": {
"type": "string",
"description": "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.",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"meta": {
"type": "object",
"additionalProperties": {},
"example": "'object': { 'field': 'description' }"
},
"validationDetails": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
},
"errorType": {
"type": "string",
"writeOnly": true
}
}
},
"InvalidNonStateReference": {
"type": "object",
"properties": {
"entityId": {
"type": "string"
},
"entityType": {
"type": "string"
}
}
},
"InvalidStateReference": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorResponse"
},
{
"type": "object",
"properties": {
"targetStateId": {
"type": "string"
},
"inboundInvalidNonStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidNonStateReference"
}
},
"inboundInvalidStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidStateReference"
}
},
"outboundInvalidStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidStateReference"
}
},
"errorType": {
"type": "string"
}
}
}
]
}
},
"securitySchemes": {
"APIToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```