REST Resource: networks.users

Resource: User

The User resource.

JSON representation
{
  "name": string,
  "userId": string,
  "displayName": string,
  "email": string,
  "role": string,
  "active": boolean,
  "externalId": string,
  "serviceAccount": boolean,
  "ordersUiLocalTimeZone": string
}
Fields
name

string

Identifier. The resource name of the User. Format: networks/{networkCode}/users/{userId}

userId

string (int64 format)

Output only. User ID.

displayName

string

Required. The name of the User. It has a maximum length of 128 characters.

email

string

Required. The email or login of the User. In order to create a new user, you must already have a Google Account.

role

string

Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.

active

boolean

Output only. Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations.

externalId

string

Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters.

serviceAccount

boolean

Output only. Whether the user is an OAuth2 service account user. Service account users can only be added through the UI.

ordersUiLocalTimeZone

string

Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.

Methods

get

API to retrieve a User object.