REST APIs

User collection

The Collection of Users Resource contains all of the users present in the system.

Methods supported: GET

GET /api/users{?skip,take}

Retrieves the collection of users. The response contains a User Collection Object.

Chunking

If there are more users than can fit in a single chunk, a link is included to retrieve the next chunk.

Ranging

If the take parameter is specified, the number of users returned is limited to that parameter (up to 100). The skip parameter can also be included to further determine which range of users is returned.

Example Request:

GET http://<hostname>/api/users
Host: hostname
Accept: application/json

Example Response:

HTTP/1.1 200 OK
Content-Length: content length
Content-Type: application/json; charset=utf-8
ETag: "hash string"

{
    "items":[
    {
        "id": 196,
        "properties": {
        "Username": "M.Builtin.Creator",
        "Email": null,
        "Token": null,
        "FullName": null
        },
        "relations": {
            "UserGroupToUser": {
                "href": "http://m.local/api/entities/196/relations/UserGroupToUser"
            },
            "UserToUserAgreement": {
                "href": "http://m.local/api/entities/196/relations/UserToUserAgreement"
            },
            "UserToSavedSearch": {
                "href": "http://m.local/api/entities/196/relations/UserToSavedSearch"
            },
            "myuploads": {
                "href": "http://m.local/api/entities/196/relations/myuploads"
            },
            "AssetSelectionToUser": {
                "href": "http://m.local/api/entities/196/relations/AssetSelectionToUser"
            }
        },
        "created_by": {
            "href": "http://m.local/api/users/3",
            "title": "The user who created the entity"
        },
        "created_on": "2014-03-23T13:47:37.4501099Z",
        "modified_by": {
            "href": "http://m.local/api/users/3",
            "title": "The user who last modified the entity"
        },
        "modified_on": "2014-03-23T13:47:37.4501099Z",
        "entitydefinition": {
            "href": "http://m.local/api/entitydefinitions/User",
            "title": "The entity definition for this entity"
        },
        "copy": {
            "href": "http://m.local/api/users/196/copy",
            "title": "Copy this entity"
        },
        "permissions": {
            "href": "http://m.local/api/users/196/permissions",
            "title": "The permissions on this entity"
        },
        "lifecycle": {
            "href": "http://m.local/api/users/196/lifecycle",
            "title": "The lifecycle action for this entity."
        },
        "policy": {
            "href": "http://m.local/api/users/196/policy",
            "title": "The policy that applies to this user."
        },
        "self": {
            "href": "http://m.local/api/users/196",
            "title": "This entity"
        }
    },
        ...
    ],
    "total_items":38,
    "returned_items":25,
    "self":{
        "href":"http://<hostname>/api/users"
    },
    "next":{
        "href":"http://<hostname>/api/users?skip=25"
    }
}

If you have suggestions for improving this article, let us know!