= AMQ Online REST API


[[_overview]]
== Overview
This is the AMQ Online API specification.


=== Version information
[%hardbreaks]
__Version__ : 1.0.0


=== URI scheme
[%hardbreaks]
__Schemes__ : HTTPS


=== Tags

* addresses : Operating on Addresses.
* addressplans : Operating on AddressPlans.
* addressspaceplans : Operating on AddressSpacePlans.
* addressspaces : Operate on AddressSpaces
* brokeredinfraconfigs : Operating on BrokeredInfraConfigs.
* messagingusers : Operating on MessagingUsers.
* standardinfraconfigs : Operating on StandardInfraConfigs.


=== External Docs
[%hardbreaks]
__Description__ : Find out more about EnMasse
__URL__ : http://enmasse.io




[[_paths]]
== Paths

[[_createadminenmassev1alpha1namespacedaddressspaceplan]]
=== POST /apis/admin.enmasse.io/v1alpha1/namespaces/{namespace}/addressspaceplans

==== Description
create an AddressSpacePlan


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_admin_v1alpha1_addressspaceplan,io.enmasse.admin.v1alpha1.AddressSpacePlan>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_admin_v1alpha1_addressspaceplan,io.enmasse.admin.v1alpha1.AddressSpacePlan>>
|**201**|Created|<<_io_enmasse_admin_v1alpha1_addressspaceplan,io.enmasse.admin.v1alpha1.AddressSpacePlan>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspaceplan
* admin
* enmasse_v1alpha1


[[_listadminenmassev1alpha1namespacedaddresspaceplan]]
=== GET /apis/admin.enmasse.io/v1alpha1/namespaces/{namespace}/addressspaceplans

==== Description
list objects of kind AddressSpacePlan


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Query**|**labelSelector** +
__optional__|A selector to restrict the list of returned objects by their labels. Defaults to everything.|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_admin_v1alpha1_addressspaceplanlist,io.enmasse.admin.v1alpha1.AddressSpacePlanList>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaceplan
* admin
* enmasse_v1alpha1


[[_readadminenmassev1alpha1namespacedaddressspaceplan]]
=== GET /apis/admin.enmasse.io/v1alpha1/namespaces/{namespace}/addressspaceplans/{name}

==== Description
read the specified AddressSpacePlan


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of AddressSpacePlan to read.|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_admin_v1alpha1_addressspaceplan,io.enmasse.admin.v1alpha1.AddressSpacePlan>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspaceplan
* admin
* enmasse_v1alpha1


[[_replaceadminenmassev1alpha1namespacedaddressspaceplan]]
=== PUT /apis/admin.enmasse.io/v1alpha1/namespaces/{namespace}/addressspaceplans/{name}

==== Description
replace the specified AddressSpacePlan


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of AddressSpacePlan to replace.|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_admin_v1alpha1_addressspaceplan,io.enmasse.admin.v1alpha1.AddressSpacePlan>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_admin_v1alpha1_addressspaceplan,io.enmasse.admin.v1alpha1.AddressSpacePlan>>
|**201**|Created|<<_io_enmasse_admin_v1alpha1_addressspaceplan,io.enmasse.admin.v1alpha1.AddressSpacePlan>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaceplan
* admin
* enmasse_v1alpha1


[[_deleteadminenmassev1alpha1namespacedaddressspaceplan]]
=== DELETE /apis/admin.enmasse.io/v1alpha1/namespaces/{namespace}/addressspaceplans/{name}

==== Description
delete an AddressSpacePlan


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of AddressSpacePlan to delete.|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaceplan
* admin
* enmasse_v1alpha1


[[_createenmassev1alpha1namespacedaddress]]
=== POST /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addresses

==== Description
create an Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|**201**|Created|<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1alpha1


[[_listenmassev1alpha1namespacedaddress]]
=== GET /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addresses

==== Description
list objects of kind Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Query**|**labelSelector** +
__optional__|A selector to restrict the list of returned objects by their labels. Defaults to everything.|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_addresslist,io.enmasse.v1alpha1.AddressList>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1alpha1


[[_readenmassev1alpha1namespacedaddress]]
=== GET /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addresses/{name}

==== Description
read the specified Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of Address to read|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1alpha1


[[_replaceenmassev1alpha1namespacedaddress]]
=== PUT /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addresses/{name}

==== Description
replace the specified Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of Address to replace|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|**201**|Created|<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1alpha1


[[_deleteenmassev1alpha1namespacedaddress]]
=== DELETE /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addresses/{name}

==== Description
delete an Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of Address to delete|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1alpha1


[[_createenmassev1alpha1namespacedaddressspace]]
=== POST /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addressspaces

==== Description
create an AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_v1alpha1_addressspace,io.enmasse.v1alpha1.AddressSpace>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_addressspace,io.enmasse.v1alpha1.AddressSpace>>
|**201**|Created|<<_io_enmasse_v1alpha1_addressspace,io.enmasse.v1alpha1.AddressSpace>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1alpha1


[[_listenmassev1alpha1namespacedaddressspace]]
=== GET /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addressspaces

==== Description
list objects of kind AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Query**|**labelSelector** +
__optional__|A selector to restrict the list of returned objects by their labels. Defaults to everything.|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_addressspacelist,io.enmasse.v1alpha1.AddressSpaceList>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1alpha1


[[_createenmassev1alpha1addressspaceaddresses]]
=== POST /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses

==== Description
create Addresses in an AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**addressSpace** +
__required__|Name of AddressSpace|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__|AddressList object|<<_io_enmasse_v1alpha1_addresslist,io.enmasse.v1alpha1.AddressList>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspace_addresses
* enmasse_v1alpha1


[[_listenmassev1alpha1namespacedaddressspaceaddress]]
=== GET /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses

==== Description
list objects of kind Address in AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**addressSpace** +
__required__|Name of AddressSpace|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_addresslist,io.enmasse.v1alpha1.AddressList>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspace_addresses
* enmasse_v1alpha1


[[_readenmassev1alpha1namespacedaddressspaceaddress]]
=== GET /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses/{address}

==== Description
read the specified Address in AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**address** +
__required__|Name of Address|string
|**Path**|**addressSpace** +
__required__|Name of AddressSpace|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspace_addresses
* enmasse_v1alpha1


[[_replaceenmassev1alpha1namespacedaddressspaceaddress]]
=== PUT /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses/{address}

==== Description
replace Address in an AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**address** +
__required__|Name of address|string
|**Path**|**addressSpace** +
__required__|Name of AddressSpace|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__|Address object|<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|**201**|Created|<<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspace_addresses
* enmasse_v1alpha1


[[_deleteenmassev1alpha1namespacedaddressspaceaddress]]
=== DELETE /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses/{address}

==== Description
delete an Address in AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**address** +
__required__|Name of Address|string
|**Path**|**addressSpace** +
__required__|Name of AddressSpace|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspace_addresses
* enmasse_v1alpha1


[[_readenmassev1alpha1namespacedaddressspace]]
=== GET /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addressspaces/{name}

==== Description
read the specified AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of AddressSpace to read|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_addressspace,io.enmasse.v1alpha1.AddressSpace>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1alpha1


[[_replaceenmassev1alpha1namespacedaddressspace]]
=== PUT /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addressspaces/{name}

==== Description
replace the specified AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of AddressSpace to replace|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_v1alpha1_addressspace,io.enmasse.v1alpha1.AddressSpace>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1alpha1_addressspace,io.enmasse.v1alpha1.AddressSpace>>
|**201**|Created|<<_io_enmasse_v1alpha1_addressspace,io.enmasse.v1alpha1.AddressSpace>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1alpha1


[[_deleteenmassev1alpha1namespacedaddressspace]]
=== DELETE /apis/enmasse.io/v1alpha1/namespaces/{namespace}/addressspaces/{name}

==== Description
delete an AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of AddressSpace to delete|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1alpha1


[[_createauthenmassev1alpha1namespacedmessaginguser]]
=== POST /apis/user.enmasse.io/v1alpha1/namespaces/{namespace}/messagingusers

==== Description
create a MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_user_v1alpha1_messaginguser,io.enmasse.user.v1alpha1.MessagingUser>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_user_v1alpha1_messaginguser,io.enmasse.user.v1alpha1.MessagingUser>>
|**201**|Created|<<_io_enmasse_user_v1alpha1_messaginguser,io.enmasse.user.v1alpha1.MessagingUser>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1alpha1
* user


[[_listauthenmassev1alpha1namespacedmessaginguser]]
=== GET /apis/user.enmasse.io/v1alpha1/namespaces/{namespace}/messagingusers

==== Description
list objects of kind MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Query**|**labelSelector** +
__optional__|A selector to restrict the list of returned objects by their labels. Defaults to everything.|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_user_v1alpha1_messaginguserlist,io.enmasse.user.v1alpha1.MessagingUserList>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1alpha1
* user


[[_readauthenmassev1alpha1namespacedmessaginguser]]
=== GET /apis/user.enmasse.io/v1alpha1/namespaces/{namespace}/messagingusers/{name}

==== Description
read the specified MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of MessagingUser to read. Must include addressSpace and dot separator in the name (that is, 'myspace.user1').|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_user_v1alpha1_messaginguser,io.enmasse.user.v1alpha1.MessagingUser>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1alpha1
* user


[[_replaceauthenmassev1alpha1namespacedmessaginguser]]
=== PUT /apis/user.enmasse.io/v1alpha1/namespaces/{namespace}/messagingusers/{name}

==== Description
replace the specified MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of MessagingUser to replace. Must include addressSpace and dot separator in the name (that is, 'myspace.user1').|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_user_v1alpha1_messaginguser,io.enmasse.user.v1alpha1.MessagingUser>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_user_v1alpha1_messaginguser,io.enmasse.user.v1alpha1.MessagingUser>>
|**201**|Created|<<_io_enmasse_user_v1alpha1_messaginguser,io.enmasse.user.v1alpha1.MessagingUser>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1alpha1
* user


[[_deleteauthenmassev1alpha1namespacedmessaginguser]]
=== DELETE /apis/user.enmasse.io/v1alpha1/namespaces/{namespace}/messagingusers/{name}

==== Description
delete a MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of MessagingUser to delete. Must include addressSpace and dot separator in the name (that is, 'myspace.user1').|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1alpha1
* user




[[_definitions]]
== Definitions

[[_objectmeta]]
=== ObjectMeta
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.


[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**name** +
__required__|string
|**namespace** +
__optional__|string
|===


[[_status]]
=== Status
Status is a return value for calls that do not return other objects.


[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**code** +
__optional__|Suggested HTTP return code for this status, 0 if not set.|integer (int32)
|===


[[_io_enmasse_admin_v1alpha1_addressplan]]
=== io.enmasse.admin.v1alpha1.AddressPlan

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**addressType** +
__required__|string
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1alpha1)
|**displayName** +
__required__|string
|**displayOrder** +
__required__|integer
|**kind** +
__required__|enum (AddressPlan)
|**longDescription** +
__optional__|string
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**requiredResources** +
__required__|< <<_io_enmasse_admin_v1alpha1_addressplan_requiredresources,requiredResources>> > array
|**shortDescription** +
__required__|string
|**uuid** +
__required__|string
|===

[[_io_enmasse_admin_v1alpha1_addressplan_requiredresources]]
**requiredResources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**credit** +
__required__|number
|**name** +
__required__|string
|===


[[_io_enmasse_admin_v1alpha1_addressplanlist]]
=== io.enmasse.admin.v1alpha1.AddressPlanList

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1alpha1)
|**items** +
__required__|< <<_io_enmasse_admin_v1alpha1_addressplan,io.enmasse.admin.v1alpha1.AddressPlan>> > array
|**kind** +
__required__|enum (AddressPlanList)
|===


[[_io_enmasse_admin_v1alpha1_addressspaceplan]]
=== io.enmasse.admin.v1alpha1.AddressSpacePlan

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**addressPlans** +
__optional__|< string > array
|**addressSpaceType** +
__required__|string
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1alpha1)
|**displayName** +
__required__|string
|**displayOrder** +
__required__|integer
|**kind** +
__required__|enum (AddressSpacePlan)
|**longDescription** +
__optional__|string
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**resources** +
__required__|< <<_io_enmasse_admin_v1alpha1_addressspaceplan_resources,resources>> > array
|**shortDescription** +
__required__|string
|**uuid** +
__required__|string
|===

[[_io_enmasse_admin_v1alpha1_addressspaceplan_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**max** +
__required__|number
|**min** +
__required__|number
|**name** +
__required__|string
|===


[[_io_enmasse_admin_v1alpha1_addressspaceplanlist]]
=== io.enmasse.admin.v1alpha1.AddressSpacePlanList

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1alpha1)
|**items** +
__required__|< <<_io_enmasse_admin_v1alpha1_addressspaceplan,io.enmasse.admin.v1alpha1.AddressSpacePlan>> > array
|**kind** +
__required__|enum (AddressSpacePlanList)
|===


[[_io_enmasse_admin_v1alpha1_brokeredinfraconfig]]
=== io.enmasse.admin.v1alpha1.BrokeredInfraConfig

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1alpha1)
|**kind** +
__required__|enum (BrokeredInfraConfig)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_admin_v1alpha1_brokeredinfraconfigspec,io.enmasse.admin.v1alpha1.BrokeredInfraConfigSpec>>
|===


[[_io_enmasse_admin_v1alpha1_brokeredinfraconfiglist]]
=== io.enmasse.admin.v1alpha1.BrokeredInfraConfigList

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1alpha1)
|**items** +
__required__|< <<_io_enmasse_admin_v1alpha1_brokeredinfraconfig,io.enmasse.admin.v1alpha1.BrokeredInfraConfig>> > array
|**kind** +
__required__|enum (BrokeredInfraConfigList)
|===


[[_io_enmasse_admin_v1alpha1_brokeredinfraconfigspec]]
=== io.enmasse.admin.v1alpha1.BrokeredInfraConfigSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**admin** +
__optional__|<<_io_enmasse_admin_v1alpha1_brokeredinfraconfigspecadmin,io.enmasse.admin.v1alpha1.BrokeredInfraConfigSpecAdmin>>
|**broker** +
__optional__|<<_io_enmasse_admin_v1alpha1_brokeredinfraconfigspecbroker,io.enmasse.admin.v1alpha1.BrokeredInfraConfigSpecBroker>>
|**version** +
__required__|string
|===


[[_io_enmasse_admin_v1alpha1_brokeredinfraconfigspecadmin]]
=== io.enmasse.admin.v1alpha1.BrokeredInfraConfigSpecAdmin

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**resources** +
__optional__|<<_io_enmasse_admin_v1alpha1_brokeredinfraconfigspecadmin_resources,resources>>
|===

[[_io_enmasse_admin_v1alpha1_brokeredinfraconfigspecadmin_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**memory** +
__optional__|string
|===


[[_io_enmasse_admin_v1alpha1_brokeredinfraconfigspecbroker]]
=== io.enmasse.admin.v1alpha1.BrokeredInfraConfigSpecBroker

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**addressFullPolicy** +
__optional__|enum (PAGE, BLOCK, FAIL)
|**resources** +
__optional__|<<_io_enmasse_admin_v1alpha1_brokeredinfraconfigspecbroker_resources,resources>>
|===

[[_io_enmasse_admin_v1alpha1_brokeredinfraconfigspecbroker_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**memory** +
__optional__|string
|**storage** +
__optional__|string
|===


[[_io_enmasse_admin_v1alpha1_standardinfraconfig]]
=== io.enmasse.admin.v1alpha1.StandardInfraConfig

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1alpha1)
|**kind** +
__required__|enum (StandardInfraConfig)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_admin_v1alpha1_standardinfraconfigspec,io.enmasse.admin.v1alpha1.StandardInfraConfigSpec>>
|===


[[_io_enmasse_admin_v1alpha1_standardinfraconfiglist]]
=== io.enmasse.admin.v1alpha1.StandardInfraConfigList

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1alpha1)
|**items** +
__required__|< <<_io_enmasse_admin_v1alpha1_standardinfraconfig,io.enmasse.admin.v1alpha1.StandardInfraConfig>> > array
|**kind** +
__required__|enum (StandardInfraConfigList)
|===


[[_io_enmasse_admin_v1alpha1_standardinfraconfigspec]]
=== io.enmasse.admin.v1alpha1.StandardInfraConfigSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**admin** +
__optional__|<<_io_enmasse_admin_v1alpha1_standardinfraconfigspecadmin,io.enmasse.admin.v1alpha1.StandardInfraConfigSpecAdmin>>
|**broker** +
__optional__|<<_io_enmasse_admin_v1alpha1_standardinfraconfigspecbroker,io.enmasse.admin.v1alpha1.StandardInfraConfigSpecBroker>>
|**router** +
__optional__|<<_io_enmasse_admin_v1alpha1_standardinfraconfigspecrouter,io.enmasse.admin.v1alpha1.StandardInfraConfigSpecRouter>>
|**version** +
__required__|string
|===


[[_io_enmasse_admin_v1alpha1_standardinfraconfigspecadmin]]
=== io.enmasse.admin.v1alpha1.StandardInfraConfigSpecAdmin

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**resources** +
__optional__|<<_io_enmasse_admin_v1alpha1_standardinfraconfigspecadmin_resources,resources>>
|===

[[_io_enmasse_admin_v1alpha1_standardinfraconfigspecadmin_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**memory** +
__optional__|string
|===


[[_io_enmasse_admin_v1alpha1_standardinfraconfigspecbroker]]
=== io.enmasse.admin.v1alpha1.StandardInfraConfigSpecBroker

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**addressFullPolicy** +
__optional__|enum (PAGE, BLOCK, FAIL)
|**resources** +
__optional__|<<_io_enmasse_admin_v1alpha1_standardinfraconfigspecbroker_resources,resources>>
|===

[[_io_enmasse_admin_v1alpha1_standardinfraconfigspecbroker_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**memory** +
__optional__|string
|**storage** +
__optional__|string
|===


[[_io_enmasse_admin_v1alpha1_standardinfraconfigspecrouter]]
=== io.enmasse.admin.v1alpha1.StandardInfraConfigSpecRouter

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**linkCapacity** +
__optional__|string
|**resources** +
__optional__|<<_io_enmasse_admin_v1alpha1_standardinfraconfigspecrouter_resources,resources>>
|===

[[_io_enmasse_admin_v1alpha1_standardinfraconfigspecrouter_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**memory** +
__optional__|string
|===


[[_io_enmasse_user_v1alpha1_messaginguser]]
=== io.enmasse.user.v1alpha1.MessagingUser

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (user.enmasse.io/v1alpha1)
|**kind** +
__required__|enum (MessagingUser)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_user_v1alpha1_userspec,io.enmasse.user.v1alpha1.UserSpec>>
|===


[[_io_enmasse_user_v1alpha1_messaginguserlist]]
=== io.enmasse.user.v1alpha1.MessagingUserList

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (user.enmasse.io/v1alpha1)
|**items** +
__required__|< <<_io_enmasse_user_v1alpha1_messaginguser,io.enmasse.user.v1alpha1.MessagingUser>> > array
|**kind** +
__required__|enum (MessagingUserList)
|===


[[_io_enmasse_user_v1alpha1_userspec]]
=== io.enmasse.user.v1alpha1.UserSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**authentication** +
__optional__|<<_io_enmasse_user_v1alpha1_userspec_authentication,authentication>>
|**authorization** +
__optional__|< <<_io_enmasse_user_v1alpha1_userspec_authorization,authorization>> > array
|**username** +
__required__|string
|===

[[_io_enmasse_user_v1alpha1_userspec_authentication]]
**authentication**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**federatedUserid** +
__optional__|User id of the user to federate when 'federated' type is specified.|string
|**federatedUsername** +
__optional__|User name of the user to federate when 'federated' type is specified.|string
|**password** +
__optional__|Base64 encoded value of password when 'password' type is specified.|string
|**provider** +
__optional__|Name of provider to use for federated identity when 'federated' type is specified.|string
|**type** +
__required__||enum (password, federated)
|===

[[_io_enmasse_user_v1alpha1_userspec_authorization]]
**authorization**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**addresses** +
__optional__|< string > array
|**operations** +
__required__|< enum (send, receive, view, manage) > array
|===


[[_io_enmasse_v1alpha1_address]]
=== io.enmasse.v1alpha1.Address

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (enmasse.io/v1alpha1)
|**kind** +
__required__|enum (Address)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_v1alpha1_addressspec,io.enmasse.v1alpha1.AddressSpec>>
|**status** +
__optional__|<<_io_enmasse_v1alpha1_addressstatus,io.enmasse.v1alpha1.AddressStatus>>
|===


[[_io_enmasse_v1alpha1_addresslist]]
=== io.enmasse.v1alpha1.AddressList

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**apiVersion** +
__required__|**Default** : `"enmasse.io/v1alpha1"`|enum (enmasse.io/v1alpha1)
|**items** +
__required__||< <<_io_enmasse_v1alpha1_address,io.enmasse.v1alpha1.Address>> > array
|**kind** +
__required__||enum (AddressList)
|===


[[_io_enmasse_v1alpha1_addressspace]]
=== io.enmasse.v1alpha1.AddressSpace

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (enmasse.io/v1alpha1)
|**kind** +
__required__|enum (AddressSpace)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_v1alpha1_addressspacespec,io.enmasse.v1alpha1.AddressSpaceSpec>>
|**status** +
__optional__|<<_io_enmasse_v1alpha1_addressspacestatus,io.enmasse.v1alpha1.AddressSpaceStatus>>
|===


[[_io_enmasse_v1alpha1_addressspacelist]]
=== io.enmasse.v1alpha1.AddressSpaceList

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**apiVersion** +
__required__|**Default** : `"enmasse.io/v1alpha1"`|enum (enmasse.io/v1alpha1)
|**items** +
__required__||< <<_io_enmasse_v1alpha1_addressspace,io.enmasse.v1alpha1.AddressSpace>> > array
|**kind** +
__required__||enum (AddressSpaceList)
|===


[[_io_enmasse_v1alpha1_addressspacespec]]
=== io.enmasse.v1alpha1.AddressSpaceSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**authenticationService** +
__optional__|<<_io_enmasse_v1alpha1_addressspacespec_authenticationservice,authenticationService>>
|**endpoints** +
__optional__|< <<_io_enmasse_v1alpha1_addressspacespec_endpoints,endpoints>> > array
|**plan** +
__required__|string
|**type** +
__required__|<<_io_enmasse_v1alpha1_addressspacetype,io.enmasse.v1alpha1.AddressSpaceType>>
|===

[[_io_enmasse_v1alpha1_addressspacespec_authenticationservice]]
**authenticationService**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**details** +
__optional__|object
|**type** +
__optional__|string
|===

[[_io_enmasse_v1alpha1_addressspacespec_endpoints]]
**endpoints**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**cert** +
__optional__|<<_io_enmasse_v1alpha1_addressspacespec_cert,cert>>
|**host** +
__optional__|string
|**name** +
__optional__|string
|**service** +
__optional__|string
|**servicePort** +
__optional__|string
|===

[[_io_enmasse_v1alpha1_addressspacespec_cert]]
**cert**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**provider** +
__optional__|string
|**secretName** +
__optional__|string
|===


[[_io_enmasse_v1alpha1_addressspacestatus]]
=== io.enmasse.v1alpha1.AddressSpaceStatus

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**endpointStatuses** +
__optional__|< <<_io_enmasse_v1alpha1_addressspacestatus_endpointstatuses,endpointStatuses>> > array
|**isReady** +
__optional__|boolean
|**messages** +
__optional__|< string > array
|===

[[_io_enmasse_v1alpha1_addressspacestatus_endpointstatuses]]
**endpointStatuses**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**host** +
__optional__|string
|**name** +
__optional__|string
|**port** +
__optional__|integer
|**serviceHost** +
__optional__|string
|**servicePorts** +
__optional__|< <<_io_enmasse_v1alpha1_addressspacestatus_serviceports,servicePorts>> > array
|===

[[_io_enmasse_v1alpha1_addressspacestatus_serviceports]]
**servicePorts**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**name** +
__optional__|string
|**port** +
__optional__|integer
|===


[[_io_enmasse_v1alpha1_addressspacetype]]
=== io.enmasse.v1alpha1.AddressSpaceType
AddressSpaceType is the type of address space (standard, brokered). Each type supports different types of addresses and semantics for those types.

__Type__ : enum (standard, brokered)


[[_io_enmasse_v1alpha1_addressspec]]
=== io.enmasse.v1alpha1.AddressSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**address** +
__required__|string
|**plan** +
__required__|string
|**type** +
__required__|<<_io_enmasse_v1alpha1_addresstype,io.enmasse.v1alpha1.AddressType>>
|===


[[_io_enmasse_v1alpha1_addressstatus]]
=== io.enmasse.v1alpha1.AddressStatus

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**isReady** +
__optional__|boolean
|**messages** +
__optional__|< string > array
|**phase** +
__optional__|enum (Pending, Configuring, Active, Failed, Terminating)
|===


[[_io_enmasse_v1alpha1_addresstype]]
=== io.enmasse.v1alpha1.AddressType
Type of address (queue, topic, …). Each address type support different kinds of messaging semantics.

__Type__ : enum (queue, topic, anycast, multicast)





