ConsumerUser

JSON representation
{
  "id": string,
  "name": {
    object (ConsumerName)
  },
  "email": string,
  "passwordLastModified": string,
  "customFieldValues": [
    {
      object (CustomFieldValue)
    }
  ],
  "active": boolean,
  "verified": boolean,
  "teams": [
    {
      object (ConsumersTeam)
    }
  ],
  "apps": [
    {
      object (PortalApp)
    }
  ],
  "audiences": [
    {
      object (ConsumerAudience)
    }
  ]
}
Fields
id

string

ID of the user.

name

object (ConsumerName)

Name of the user.

email

string

Email address of the user.

passwordLastModified

string (int64 format)

Time the password was last modified in milliseconds since epoch.

customFieldValues[]

object (CustomFieldValue)

List of custom fields entered during user account registration.

active

boolean

Boolean flag that specifies whether the user account is active.

verified

boolean

Boolean flag that specifies whether the user account has been verified.

teams[]

object (ConsumersTeam)

List of teams to which the user is assigned.

apps[]

object (PortalApp)

List of apps associated with the user.

audiences[]

object (ConsumerAudience)

List of audiences to which the user is assigned.

ConsumerName

JSON representation
{
  "familyName": string,
  "givenName": string,
  "userName": string
}
Fields
familyName

string

Last name.

givenName

string

First name.

userName

string

Username.

CustomFieldValue

JSON representation
{
  "fieldName": string,
  "fieldValue": string
}
Fields
fieldName

string

Name of the custom field.

fieldValue

string

Value of the custom field.

ConsumersTeam

JSON representation
{
  "id": string,
  "name": string,
  "description": string,
  "pointOfContact": string,
  "memberships": [
    {
      object (ConsumerTeamMembership)
    }
  ],
  "created": string,
  "apps": [
    {
      object (PortalApp)
    }
  ],
  "users": [
    {
      object (ConsumerUser)
    }
  ],
  "memberCount": integer,
  "audiences": [
    {
      object (ConsumerAudience)
    }
  ]
}
Fields
id

string

ID of the team.

name

string

Name of the team.

description

string

Description of the team.

pointOfContact

string

Point of contact for the team.

memberships[]

object (ConsumerTeamMembership)

List of members and roles.

created

string (int64 format)

Time the team was created in milliseconds since epoch.

apps[]

object (PortalApp)

List of apps associated with the team.

users[]

object (ConsumerUser)

List of users assigned to the team.

memberCount

integer

audiences[]

object (ConsumerAudience)

List of audiences to which the team is assigned.

ConsumerTeamMembership

Roles supported for team membership.

JSON representation
{
  "role": enum (Role),
  "userId": string
}
Fields
role

enum (Role)

Role.

userId

string

ID of the user.

Role

Enums
ADMIN Owner.
APP_ADMIN App administrator.
VIEWER View only.

ConsumerAudience

JSON representation
{
  "id": string,
  "name": string,
  "description": string,
  "membershipType": enum (MembershipType),
  "created": string,
  "teams": [
    {
      object (ConsumersTeam)
    }
  ],
  "users": [
    {
      object (ConsumerUser)
    }
  ],
  "resources": [
    string
  ]
}
Fields
id

string

ID of the audience.

name

string

Name of the audience.

description

string

Description of the auidence.

membershipType

enum (MembershipType)

Type of membership.

created

string (int64 format)

Time the audience was created in milliseconds since epoch.

teams[]

object (ConsumersTeam)

List of teams assigned to the audience.

users[]

object (ConsumerUser)

List of users assigned to the audience.

resources[]

string

List of resource entitlements assigned to the audience.

MembershipType

Enums
explicit Explicit audience entitlement.
all_authenticated Accessible to all registered users.