Package com.ringcentral.definitions

Class RoleResource

java.lang.Object

com.ringcentral.definitions.RoleResource

public class RoleResource
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	custom	Specifies if a user role is custom
String	description	Role description Example: Primary company administrator role
String	displayName	Display name of a role Example: Super Admin
Boolean	hidden
String	id	Internal identifier of a role
String	lastUpdated	Format: date-time
PermissionIdResource[]	permissions
String	scope	Specifies resource for permission Enum: Account, AllExtensions, Federation, Group, NonUserExtensions, RoleBased, Self, UserExtensions
Boolean	siteCompatible	Site compatibility of a user role
String	uri	Link to a role resource Format: uri

Constructor Summary

Constructors

Constructor	Description
RoleResource()

Method Summary

Modifier and Type	Method	Description
RoleResource	custom(Boolean custom)
RoleResource	description(String description)
RoleResource	displayName(String displayName)
RoleResource	hidden(Boolean hidden)
RoleResource	id(String id)
RoleResource	lastUpdated(String lastUpdated)
RoleResource	permissions(PermissionIdResource[] permissions)
RoleResource	scope(String scope)
RoleResource	siteCompatible(Boolean siteCompatible)
RoleResource	uri(String uri)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

uri

public String uri

Link to a role resource Format: uri

id

public String id

Internal identifier of a role

displayName

public String displayName

Display name of a role Example: Super Admin

description

public String description

Role description Example: Primary company administrator role

siteCompatible

public Boolean siteCompatible

Site compatibility of a user role

custom

public Boolean custom

Specifies if a user role is custom

scope

public String scope

Specifies resource for permission Enum: Account, AllExtensions, Federation, Group, NonUserExtensions, RoleBased, Self, UserExtensions

hidden

public Boolean hidden

lastUpdated

public String lastUpdated

Format: date-time

permissions

public PermissionIdResource[] permissions

Constructor Details

RoleResource

public RoleResource()

Method Details

uri

public RoleResource uri(String uri)

id

public RoleResource id(String id)

displayName

public RoleResource displayName(String displayName)

description

public RoleResource description(String description)

siteCompatible

public RoleResource siteCompatible(Boolean siteCompatible)

custom

public RoleResource custom(Boolean custom)

scope

public RoleResource scope(String scope)

hidden

public RoleResource hidden(Boolean hidden)

lastUpdated

public RoleResource lastUpdated(String lastUpdated)

permissions

public RoleResource permissions(PermissionIdResource[] permissions)