REST APIs

User

Each user in the system is represented by a User Resource. This resource can be used to retrieve the state of the user.

The following methods are supported: GET, HEAD.

GET /api/users/id

Returns a User Object that contains the state of the user.

Example Request:

GET http://<hostname>/api/users/196
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"

{
    "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"
    }
}

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