List Users
To return a list of the users under a database, performing a GET operation on the users resource of a particular database, i.e. the users URI path.
Request
| Method | Request URI | Description |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/users |
The {databaseaccount} is the name of the Azure Cosmos DB account created under your subscription. The {db-id} value is the user generated name/ID of the database, not the system generated ID (rid). |
Headers
See Common Azure Cosmos DB REST request headers for headers that are used by all Cosmos DB requests.
Body
None.
Response
Headers
See Common Azure Cosmos DB REST response headers for headers that are returned by all Cosmos DB responses.
Status codes
The following table lists common status codes returned by this operation. For a full list of status codes, see HTTP Status Codes.
| HTTP status code | Description |
|---|---|
| 200 Ok | The operation was successful. |
Body
| Property | Description |
|---|---|
| _rid | It is the resource ID for the database where the users have been created. |
| _count | This property shows the number of users returned as part of the list operation. |
| Users | It is the array containing the users returned as part of the list operation. Properties of the user resource |
| id | The unique user generated name for the user. |
| _rid | It is a system generated property. The resource ID (_rid) is a unique identifier that is also hierarchical per the resource stack on the resource model. It is used internally for placement of and navigation to the user resource. |
| _ts | It is a system generated property. It specifies the last updated timestamp of the resource. The value is a timestamp. |
| _self | It is a system generated property. It is the unique addressable URI for the resource. |
| _etag | It is a system generated property that represents the resource etag required for optimistic concurrency control. |
| _permissions | It is a system generated property that specifies the addressable path of the permissions resource. |
{
"_rid": "Sl8fAA==",
"Users": [{
"id": "a_user",
"_rid": "Sl8fAFEKCQA=",
"_ts": 1449603893,
"_self": "dbs\/Sl8fAA==\/users\/Sl8fAFEKCQA=\/",
"_etag": "\"00000b00-0000-0000-0000-566733350000\"",
"_permissions": "permissions\/"
}],
"_count": 1
}
Example
GET https://contosomarketing.documents.azure.com/dbs/volcanodb/users HTTP/1.1
x-ms-date: Tue, 08 Dec 2015 19:47:28 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3due2e%2fHxTsLU%2fEftrjRd176ku%2bKC5efuw8CHzy7B4%2bTc%3d
Cache-Control: no-cache
User-Agent: contoso/1.0
x-ms-version: 2015-08-06
Accept: application/json
Host: contosomarketing.documents.azure.com
Connection: Keep-Alive
HTTP/1.1 200 Ok
Cache-Control: no-store, no-cache
Pragma: no-cache
Content-Type: application/json
Content-Location: https://contosomarketing.documents.azure.com/dbs/volcanodb/users
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Sun, 29 Nov 2015 02:25:34.442 GMT
x-ms-resource-quota: users=500000;
x-ms-resource-usage: users=2;
x-ms-item-count: 1
x-ms-schemaversion: 1.1
x-ms-alt-content-path: dbs/volcanodb
x-ms-content-path: Sl8fAA==
x-ms-session-token: 862
x-ms-request-charge: 2
x-ms-serviceversion: version=1.5.57.3
x-ms-activity-id: ed9bf479-65fe-48f6-923f-572920b57c21
x-ms-gatewayversion: version=1.5.57.3
Date: Tue, 08 Dec 2015 19:47:28 GMT
Content-Length: 224
{
"_rid": "Sl8fAA==",
"Users": [{
"id": "a_user",
"_rid": "Sl8fAFEKCQA=",
"_ts": 1449603893,
"_self": "dbs\/Sl8fAA==\/users\/Sl8fAFEKCQA=\/",
"_etag": "\"00000b00-0000-0000-0000-566733350000\"",
"_permissions": "permissions\/"
}],
"_count": 1
}