AWS Documentation » Amazon MQ » REST API Reference » Resources » User

User

An ActiveMQ user is a person or an application that can access the queues and topics of an ActiveMQ broker. For more information, see User in the Amazon MQ Developer Guide.

You can configure to have specific permissions. For example, you can allow some users to access the ActiveMQ Web Console.

A user can belong to a group. You can configure which users belong to which groups and which groups have permission to send to, receive from, and administer specific queues and topics.

Important

Making changes to a user does not apply the changes to the user immediately. To apply your changes, you must wait for the next maintenance window or reboot the broker.

URI

/v1/brokers/broker-id/users/username

HTTP Methods

DELETE

Deletes an ActiveMQ user.

Path

Name	Type	Description
broker-id	string	The unique ID that Amazon MQ generates for the broker.
username	string	The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Response

Status Code	Schema	Description
200	None	HTTP Status Code 200: OK.

GET

Returns information about an ActiveMQ user.

Path

Name	Type	Description
broker-id	string	The unique ID that Amazon MQ generates for the broker.
username	string	The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Response

Status Code	Schema	Description
200	DescribeUserOutput	HTTP Status Code 200: OK.

POST

Creates an ActiveMQ user.

Body

Name	Type	Description
CreateUserInput	CreateUserInput	Creates a new ActiveMQ user.

Path

Name	Type	Description
broker-id	string	The unique ID that Amazon MQ generates for the broker.
username	string	The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Response

Status Code	Schema	Description
200	None	HTTP Status Code 200: OK.

PUT

Updates the information for an ActiveMQ user.

Body

Name	Type	Description
UpdateUserInput	UpdateUserInput	Updates the information for an ActiveMQ user.

Path

Name	Type	Description
broker-id	string	The unique ID that Amazon MQ generates for the broker.
username	string	Required The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Response

Status Code	Schema	Description
200	None	HTTP Status Code 200: OK.

Errors

Errors

Status Code	Schema	Description
400	Error	HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
403	Error	HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
404	Error	HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
409	Error	HTTP Status Code 409: Conflict. Retrying your request might resolve the issue.
500	Error	HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

Schemas

Request Schemas

Example UpdateUserInput

{
    "password": "MyPassword789",
    "consoleAccess": false,
    "groups": [
        "support"
    ]
}

Example CreateUserInput

{
    "password": "MyPassword456",
    "consoleAccess": true,
    "groups": [
        "admins"
    ]
}

Response Schemas

Example DescribeUserOutput

{
    "brokerId" : "b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9",
    "username": "jane.doe",
    "consoleAccess": true,
    "groups": [
        "support"
    ],
    "pending": {
        "pendingChange": "CREATE",
        "consoleAccess": true,
        "groups": [
            "admins"
        ]
    }
}

Example Error

{
    "errorAttribute": "TheAttributeWhichCausedTheError",
    "message": "This is the description of the error and the steps to resolve the issue."
}

Attributes

UpdateUserInput

Attribute	Type	Description
consoleAccess	Boolean	Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
groups	array	The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
password	string (password)	The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.

CreateUserInput

Attribute	Type	Description
consoleAccess	Boolean	Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
groups	array	The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
password	string (password)	Required The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.

DescribeUserOutput

Attribute	Type	Description
brokerId	string	Required The unique ID that Amazon MQ generates for the broker.
consoleAccess	Boolean	Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
groups	array	The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
pending	UserPendingChanges	The status of the changes pending for the ActiveMQ user.
username	string	Required The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

UserPendingChanges

Attribute	Type	Description
consoleAccess	Boolean	Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
groups	array	The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
pendingChange	enum	Required The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE

Error

Attribute	Type	Description
errorAttribute	string	The attribute which caused the error.
message	string	The explanation of the error.