/users

GET
A GET request can always be filtered by the get parameters defined in the introduction section of the API documentation.
Example GET request:
1
GET https://api.adnuntius.com/api/v1/users?context=<context>
Copied!
in order to see HIDDEN objects you will need to send includeHidden=trueas a parameter to the GET query
POST
Example POST object:
1
POST https://api.adnuntius.com/api/v1/users/<id>?context=<context>
Copied!
1
{
2
    "objectState": "ACTIVE",
3
    "username": "[email protected]",
4
    "name": "Mikael Lundin",
5
    "displayName": "mikael.lundin",
6
    "userRoles": {
7
        "rolesByNetwork": [
8
            {
9
                "network": {
10
                    "id": "adnuntius",
11
                },
12
                "roles": [
13
                    {
14
                        "role": {
15
                            "id": "adopsrole",
16
                        }
17
                    }
18
                ]
19
            }
20
        ]
21
    },
22
    "locale": "en",
23
    "externalReference": "",
24
}
Copied!
Name
Required
Restriction
Description
objectState
Yes
ACTIVE, INACTIVE, HIDDEN
State of the object, will disable or delete the object.
username
Yes
String
The means for which a user logs in, recommended would be the email address to simplify sending reports.
name
​
String
The name of the user.
displayName
​
String
A name that will be displayed in the UI once a user is logged in.
userRoles
​
Object
Defines the roles a user has.
rolesByNetwork
​
Array
A list of all networks and roles associated with this user.
network
​
Object
Specifies the current scoped network.
roles
​
Object
Specifies one or more roles for the scoped network.
role
​
Object
Defines the id of the role to apply to the user.
locale
​
String
The language for the user.
externalReference
​
String
A custom string that can be used to find this user's id in an external system or something similar.

/tiers

Next - Adnuntius Advertising

Requesting Ads

Last modified 3mo ago

Copy link

Contents

GET

POST