Package com.ringcentral.paths.restapi.account.userrole

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.userrole.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	roleId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String roleId)

Method Summary

Modifier and Type	Method	Description
Index	bulkAssign()
Index	default1()
String	delete()
String	delete(DeleteCustomRoleParameters queryParams)	Deletes a custom user role by ID.
RoleResource	get()	Returns a user role assigned to the current account.
RolesCollectionResource	list()
RolesCollectionResource	list(ListUserRolesParameters queryParams)	Returns a list of account user roles.
String	path()
String	path(Boolean withParameter)
String	post(RoleResource roleResource)	Creates a custom user role.
String	put(RoleResource roleResource)	Updates a user role assigned to the current account by ID.

Methods inherited from class java.lang.Object

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

Field Details

rc

public RestClient rc

parent

public Index parent

roleId

public String roleId

Constructor Details

Index

public Index(Index parent,
 String roleId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public RolesCollectionResource list(ListUserRolesParameters queryParams)
                             throws RestException,
IOException

Returns a list of account user roles. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/user-role Rate Limit Group: Medium App Permission: ReadAccounts User Permission: ReadUserRoles

Throws:

RestException

IOException

list

public RolesCollectionResource list()
                             throws RestException,
IOException

Throws:

RestException

IOException

post

public String post(RoleResource roleResource)
            throws RestException,
IOException

Creates a custom user role. HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/user-role Rate Limit Group: Medium App Permission: RoleManagement User Permission: EditUserRoles

Throws:

RestException

IOException

get

public RoleResource get()
                 throws RestException,
IOException

Returns a user role assigned to the current account. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/user-role/{roleId} Rate Limit Group: Light App Permission: ReadAccounts User Permission: ReadUserRoles

Throws:

RestException

IOException

put

public String put(RoleResource roleResource)
           throws RestException,
IOException

Updates a user role assigned to the current account by ID. HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/user-role/{roleId} Rate Limit Group: Medium App Permission: RoleManagement User Permission: EditUserRoles

Throws:

RestException

IOException

delete

public String delete(DeleteCustomRoleParameters queryParams)
              throws RestException,
IOException

Deletes a custom user role by ID. HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/user-role/{roleId} Rate Limit Group: Medium App Permission: RoleManagement User Permission: EditUserRoles

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Throws:

RestException

IOException

default1

public Index default1()

bulkAssign

public Index bulkAssign()