REST Resource: organizations.sites.resource-entitlements

Resource: ResourceEntitlement

JSON representation
{
  "data": {
    object (ResourceEntitlementData)
  },
  "errorCode": string,
  "message": string,
  "requestId": string,
  "status": string
}
Fields
data

object (ResourceEntitlementData)

Details of the entitlement.

errorCode

string

ID that can be used to find errors in the log files.

message

string

Description of the operation.

requestId

string

ID that can be used to find request details in the log files.

status

string

Status of the operation.

ResourceEntitlementData

JSON representation
{
  "explicitAudiences": [
    {
      object (AudienceEntitlement)
    }
  ],
  "isPublic": boolean,
  "authEntitled": boolean
}
Fields
explicitAudiences[]

object (AudienceEntitlement)

List of explicit audience entitlements.

isPublic

boolean

Boolean flag that specifies whether the resource is public.

authEntitled

boolean

Boolean flag that specifies whether the resource is available to all registered users.

AudienceEntitlement

JSON representation
{
  "audience": {
    object (Audience)
  },
  "entitled": boolean
}
Fields
audience

object (Audience)

Details of the audience.

entitled

boolean

Boolean flag that specifies whether the audience is entitled.

Audience

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

string

ID of the audience.

membershipType

enum (MembershipType)

Type of membership.

name

string

Name of audience.

resources[]

string

List of resources assigned to the audience.

teams[]

object (ConsumerTeam)

List of teams assigned to the audience.

users[]

object (UserData)

List of users assigned to the audience.

created

string (int64 format)

Time the audience was created in milliseconds since epoch.

description

string

Description of the audience.

MembershipType

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

ConsumerTeam

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

object (ConsumerTeamMembership)

List of team members.

pointOfContact

string

Point of contact for the team.

audiences[]

object (Audience)

Audiences to which the team is assigned.

description

string

Description of the team.

id

string

ID of the team.

users[]

object (UserData)

List of users that are members of the team.

apps[]

object (PortalApp)

List of apps associated with the team.

created

string (int64 format)

Time the team was created in milliseconds since epoch.

name

string

Name of the team.

memberCount

integer

Number of members on the team.

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.

UserData

JSON representation
{
  "isActive": integer,
  "lastModified": string,
  "name": string,
  "password": string,
  "verified": boolean,
  "customFieldValues": [
    {
      object (CustomFieldValue)
    }
  ],
  "email": string,
  "id": string,
  "lastLogonTime": string
}
Fields
isActive

integer

Flag that specifies whether user is active.

lastModified

string (int64 format)

Time the user was last modified in milliseconds since epoch.

name

string

Name of user.

password

string

Password for user.

verified

boolean

Boolean flag that specifies whether the user account was verified.

customFieldValues[]

object (CustomFieldValue)

List of custom fields and values.

email

string

Email address for user.

id

string

ID of user.

lastLogonTime

string (int64 format)

Time the user last signed in to the portal in milliseconds since epoch.

CustomFieldValue

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

string

Name of the custom field.

fieldValue

string

Value of the custom field.

PortalApp

JSON representation
{
  "id": string,
  "name": string,
  "status": string,
  "owner": string,
  "ownerType": enum (OwnerType),
  "description": string,
  "displayName": string,
  "created": string,
  "modified": string,
  "credentials": [
    {
      object (Credential)
    }
  ],
  "apiProducts": [
    {
      object (ApiProductRef)
    }
  ],
  "callbackUrl": string,
  "apiProductsFromCredentials": [
    {
      object (Credential)
    }
  ]
}
Fields
id

string

ID of the app.

name

string

Name of the app.

status

string

Status of the app.

owner

string

Owner of the app.

ownerType

enum (OwnerType)

Type of owner, team or user.

description

string

Description of the app.

displayName

string

User-friendly name of the app used in the UI.

created

string (int64 format)

Time the app was created in milliseconds since epoch.

modified

string (int64 format)

Time the app was last modified in milliseconds since epoch.

credentials[]

object (Credential)

List of credentials.

apiProducts[]

object (ApiProductRef)

List of API products associated with the app.

callbackUrl

string

Callback URL.

apiProductsFromCredentials[]

object (Credential)

List of credentials.

OwnerType

Enums
team Team owner.
user User owner.

Methods

get

Note: This API is not supported by Apigee hybrid at this time.

updateResourceEntitlement

Note: This API is not supported by Apigee hybrid at this time.