User Management

getUserListByAccountId

Description: Get existing users by providing the account ID

Implementation: URL/pub/usr/acc/[accountId]

Method: GET

Json example

Method: 
    GET http://api.example.com/usr/acc/2

getUser

Description: Get existing user

Implementation: URL/usr/[userId]

Method: GET

Json example

Method: 
    GET http://api.example.com/usr/4

addUser

Description: Add new user

Implementation: URL/usr/new

Method: POST/PUT

Requested parameters

addUser
Name Description: Allowed Values Required / Optional Default
contactName name of the user string required
emailAddress email address string required
defaultAccountId id of the user’s default account int required
username username string required
password password password required
active is the user active 0/1 optional 1

Json example

Method: 
    POST http://api.example.com/usr/new
Request Header:
    Content-Type:text/javascript
Request Body:
    {
        "contactName":"John Doe",
        "emailAddress":"jhn.doe@example.com",
        "defaultAccountId":1,
        "username":"test",
        "password":"test"
    }

modifyUser

Description: Modify existing user

Implementation: URL/usr/[userId]

Method: POST/PUT

Requested parameters

modifyUser
Name Description: Allowed Values Required / Optional Default
contactName name of the user string optional null
emailAddress email address string optional null
defaultAccountId id of the user’s default account int optional null
username username string optional null
password password password optional null
active is the user active 0/1 optional null

Json example

Method: 
    POST http://api.example.com/usr/2
Request Header:
    Content-Type:text/javascript
Request Body:
    {
        "contactName":"John Doe modified",
        "emailAddress":"john.doe@example.com",
        "defaultAccountId":1,
        "username":"test",
        "password":"test",
        "active":"0"
    }

deleteUser

Description: Delete existing user

Implementation: URL/usr/[userId]

Method: DELETE

Json example

Method: 
    DELETE http://api.example.com/usr/2

Current version

The most recently released version of the Revive Adserver REST API is v4.2.0 (publication date July 12, 2017).

See Release Notes

Compatibility

Revive Adserver REST API is compatible with all versions of Revive Adserver v4.0 and higher. It may also be compatible with Revive Adserver v3.x (and also with OpenX Source v2.8 and higher), but this can not be guaranteed.

Revive Adserver REST API is compatible with all supported versions of PHP, including PHP7.

Also see Technical Requirements, Product Content, and Installation Instructions.