Create a client username configuration for event broker connections in an application in Event Portal.
Client usernames are used by client applications to authenticate with Solace event brokers. A client username configuration
defines the credentials that your runtime application uses to connect to an event broker when the application is promoted
to an environment in Event Portal. You associate a client profile and an ACL profile with an application by assigning the client
profile to the client username that the application uses to connect to the event broker.
Prerequisites
- The application must already exist in Event Portal.
- The API token must have appropriate token permissions.
- The event broker must be configured and available.
Validation Rules
The request body schema enforces the following validation rules:
Client Username:
- Must be unique within the Message VPN
- Can contain up to 189 printable ASCII characters (range 0x20 - 0x7e)
- Case-sensitive
- Must not contain question mark (?) or asterisk (*) characters
Pattern: ^[^\?*\x00-\x1F\x7F-\xFF]+$
Password:
- Must contain 1 to 128 non-null characters
- Must not contain the following special characters: :()";'<>,`&|
- Encrypted using one-way encryption before being saved
Pattern: ^[^:()";'<>,`\&|]+$
Important Notes:
- If internal authentication is enabled but no password is assigned to a client username, authentication will fail.
- Changing a password does not affect connections that were already authenticated using the old password.
- Client usernames are specific to a Message VPN and may be used to make multiple client connections, which allows
applications to horizontally scale without additional configuration on the event broker.
For more information, see: