Skip to end of metadata
Go to start of metadata

User Service

"User" refers to people or groups able to log in to the AppNexus UI and API. Users are classified by a user_type, which determines what type of information they have access to. This service allows member-level users to create other users, as well as modify and retrieve information about existing users.

On This Page

User Types

Once a user has been created, the user_type cannot be changed. To grant someone a new user_type, you must create a new user for that person. Also, if you create a user through the Console UI, the api_login field is set to false by default (i.e., that user will not have access to the API). You may only change the value of the api_login field for a user via the API.

User Type

Description

member

Network-level user with access to all aspects of the member's account (Advertisers, Publishers, Apps, etc.).

member_advertiser

Somewhat limited network-level user with access to a subset of advertisers. No API access by AppNexus policy.

member_publisher

Somewhat limited network-level user with access to a subset of publishers. No API access by AppNexus policy.

advertiser

Very limited user with access to one advertiser (mainly for reporting, available in both the UI and API). You must specify an advertiser_id when you create this user.

publisher

Very limited user with access to one publisher (mainly for reporting, available in both the UI and API). You must specify a publisher_id when you create this user.

Mapping of UI terms to API terms

For more information on UI terms, see Managing User Logins and Permissions (Customer login required).

UI user role

API user_type

Read_only

Network

member

false

Network Observer

member

true

Network Advertiser Manager

member_advertiser

false

Network Publisher Manager

member_publisher

false

Advertiser

advertiser

false

Publisher

publisher

false

REST API

Add a new user:

Modify an existing user:

View all users associated with this member:

View a specific user:

View multiple users by ID using a comma-separated list:

View the current user:

Find out which fields you can filter and sort by:

JSON Fields

Field

Type

Description

Default

Required On

id

int

The internal ID associated with the user.

 

PUT, in query string

state

string

The state of the user. Possible values:

  • "active"
  • "inactive"

"active"

 

username

string

The login name of the user.

Note: The username should not contain any special characters such as $, #, and ". Additionally, after a user is created, the username cannot be changed.

 

POST

password

string

The password used to authenticate the user. Not shown on GET requests.

 

POST

email

string

The email address of the user.

 

POST

first_name

string

The user's first name.

 

POST

last_name

string

The user's last name.

 

POST

custom data

string

Any information relevant to the user can be entered here.

  

phone

string

The user's contact phone number.

  

user_type

enum

The type of user. Possible values:

  • "member"
  • "bidder"
  • "publisher"
  • "advertiser"
  • "member_advertiser"
  • "member_publisher"

See User Types table above for more details on each user type.

Note: This field cannot be modified on PUT. To change a user's user_type, you must add a new user.

 

POST

read_only

boolean

If true, the user is not allowed to make changes via the API.

false

 

api_login

boolean

Admin-only. If true, the user can access and use the API.

false

 

entity_id

int

The ID of the entity (member or bidder) to which the user belongs. Note that the entity_id is the same as the member_id, which is used in other services.

 

POST,
if user_type is "member"

entity_name

string

The name of the entity (member or bidder) to which the user belongs.

  

publisher_id

int

The ID of the publisher with which the user is associated, if user_type is "publisher".

 

POST,
if user_type is "publisher"

advertiser_id

int

The ID of the advertiser with which the user is associated, if user_type is "advertiser".

 

POST,
if user_type is "advertiser"

advertiser_access

array

The advertiser(s) that the user can access, if user_type is "member_advertiser".

 

POST,
if user_type is "member_advertiser"

publisher_access

array

The publisher(s) that the user can access, if user_type is "member_publisher".

 

POST,
if user_type is "member_publisher"

reporting_decimal_type

enum

The character used for decimals in reporting. Possible values:

  • "comma"
  • "decimal" (period)

This setting can be overridden at the report level (see reporting_decimal_type in the Report Service).

reporting_decimal_type from member

 

decimal_mark

enum

The character separating the integer part from the fractional part of a number. Possible values:

  • "period"
  • "comma"

This character must be different than the character used for thousand_separator.

Note: This field controls how the user enters and views numbers in the UI only. It does not affect numbers in the API.

"period"

 

thousand_separator

enum

The character separating digit groups in a number. Possible values:

  • "comma"
  • "space"
  • "period"

This character must be different than the character used for decimal_mark.

Note: This setting controls how the user enters and views digit groups in the UI only. It does not affect digit groups in the API.

"comma"

 

send_safety_budget_notifications

boolean

If true, the user will receive email notifications when the daily safety budget threshold is approached. For more details, see the daily_budget field on the Member Service.

false

 

is_developer

boolean

Read-only. This flag gives a user rights to access certain developer-focused services such as the Plugin and Plugin Instance services, which are used by apps. It is set to true by an AppNexus admin on a case-by-case basis.

false

 

last_modified

timestamp

The date and time when the user was last modified.

  
timezonestringThe user's timezone.  
password_expires_ontimestampWhen the user's password expires.  
password_last_changed_ontimestampThe last time the user's password was changed.  
entity_reporting_decimal_typeenum

Whether number values are separated by a comma or a decimal in reports. If this field is set to decimal, the value returned would be formatted like this: 1234.56. Whereas, if this field is set to comma, the value returned would be formatted like this: 1234.56.

Possible values:

  • decimal
  • comma

 

"decimal" 

Examples

Add a network user
Add a network observer user
Add a publisher user
Add an advertiser user
View the current user