Get a paginated list of users for an XMPP domain.
URL: /api/1.0/xmppdomains/<fqdn>/users
Arguments | Required | Purpose |
---|---|---|
fqdn | required | The fqdn of the XMPP domain |
Parameters | Required | Purpose |
---|---|---|
format | optional | specify the format of the response |
limit | optional | the maximum number of users to return, max 50 |
offset | optional | the user to start the list after |
Response | |
---|---|
HTTP Code | 200 |
Content-type | application/json |
Body | (see example below) |
GET /api/1.0/xmppdomains/example1.chatwith.it/users:
{
"meta": {
"limit": 2,
"next": "/api/1.0/xmppdomains/example.chatwith.it/users?limit=2&offset=23e39942-5e99-4a43-810f-3c6e4a56e222",
"offset": "23e39942-5e99-4a43-810f-3c6e4a56e222",
"previous": null,
"totalCount": 8
},
"objects": [
{
"enabled": true,
"jid": "0d950297-e977-48a3-becc-9aade33a1fe1@example.chatwith.it",
"password": "a6c886ad-32fe-4ade-a5fe-f3fb4f4406c9",
"resourceUri": "/api/1.0/xmppdomains/example.chatwith.it/users/0d950297-e977-48a3-becc-9aade33a1fe1?format=json",
"username": "0d950297-e977-48a3-becc-9aade33a1fe1",
"xmppDomain": "example.chatwith.it",
"xmppDomainUri": "/api/1.0/xmppdomains/example.chatwith.it?format=json",
"xmppUserAclUri": "/api/1.0/xmppdomains/example.chatwith.it/users/0d950297-e977-48a3-becc-9aade33a1fe1/acl?format=json"
},
{
"enabled": true,
"jid": "23e39942-5e99-4a43-810f-3c6e4a56e222@example.chatwith.it",
"password": "250f3af8-33a2-4815-aef1-d8a16988a25d",
"resourceUri": "/api/1.0/xmppdomains/example.chatwith.it/users/23e39942-5e99-4a43-810f-3c6e4a56e222?format=json",
"username": "23e39942-5e99-4a43-810f-3c6e4a56e222",
"xmppDomain": "example.chatwith.it",
"xmppDomainUri": "/api/1.0/xmppdomains/example.chatwith.it?format=json",
"xmppUserAclUri": "/api/1.0/xmppdomains/example.chatwith.it/users/23e39942-5e99-4a43-810f-3c6e4a56e222/acl?format=json"
}
]
}