class ZoomUs::Roles
Attributes
Public Class Methods
# File lib/zoom_us/roles.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Assign a Role to Members User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to [assign a role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control#h_748b6fd8-5057-4cf4-bbfd-787909c09db0) to members. Scopes: `role:write:admin`
Prerequisites:
* A Pro or a higher plan. @param role_id The role ID @param body Role members @param [Hash] opts the optional parameters @return [InlineResponse20115]
# File lib/zoom_us/roles.rb, line 28 def add_role_members(role_id, body, opts = {}) data, _status_code, _headers = add_role_members_with_http_info(role_id, body, opts) data end
Assign a Role to Members User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to [assign a role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control#h_748b6fd8-5057-4cf4-bbfd-787909c09db0) to members. Scopes: `role:write:admin`<br> <br> Prerequisites:<br> * A Pro or a higher plan. @param role_id The role ID @param body Role members @param [Hash] opts the optional parameters @return [Array<(InlineResponse20115, Fixnum, Hash)>] InlineResponse20115 data, response status code and response headers
# File lib/zoom_us/roles.rb, line 39 def add_role_members_with_http_info(role_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.add_role_members ...' end # verify the required parameter 'role_id' is set if @api_client.config.client_side_validation && role_id.nil? fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.add_role_members" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling RolesApi.add_role_members" end # resource path local_var_path = '/roles/{roleId}/members'.sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20115') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#add_role_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a Role Each Zoom user automatically has a role which can either be owner, administrator, or a member. Pre-requisite:
* Pro or higher plan. * For setting the initial role, you must be the Account Owner.
* For subsequent role management, you must be the Account Owner or user with role management permissions.
Scopes: `role:write:admin`
@param [Hash] opts the optional parameters @option opts [Body28] :body @return [Object]
# File lib/zoom_us/roles.rb, line 87 def create_role(opts = {}) data, _status_code, _headers = create_role_with_http_info(opts) data end
Create a Role Each Zoom user automatically has a role which can either be owner, administrator, or a member. Pre-requisite:<br> * Pro or higher plan. * For setting the initial role, you must be the Account Owner.<br> * For subsequent role management, you must be the Account Owner or user with role management permissions.<br> Scopes: `role:write:admin`<br> @param [Hash] opts the optional parameters @option opts [Body28] :body @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/roles.rb, line 97 def create_role_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.create_role ...' end # resource path local_var_path = '/roles' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Object') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#create_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a Role Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to delete a role.
Pre-requisite:
* A Pro or higher plan.
* For role management and updates, you must be the Account Owner or user with role management permissions. Scopes: `role:write:admin`
@param role_id Role Id. @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/roles.rb, line 137 def delete_role(role_id, opts = {}) delete_role_with_http_info(role_id, opts) nil end
Delete a Role Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to delete a role.<br> Pre-requisite:<br> * A Pro or higher plan.<br> * For role management and updates, you must be the Account Owner or user with role management permissions. Scopes: `role:write:admin`<br> @param role_id Role Id. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/roles.rb, line 147 def delete_role_with_http_info(role_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.delete_role ...' end # verify the required parameter 'role_id' is set if @api_client.config.client_side_validation && role_id.nil? fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.delete_role" end # resource path local_var_path = '/roles/{roleId}'.sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#delete_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Role Information Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges. Use this API to get information including specific privileges assigned to a [role](
# File lib/zoom_us/roles.rb, line 190
def get_role_information(role_id, opts = {})
data, _status_code, _headers = get_role_information_with_http_info(role_id, opts)
data
end
Get Role Information Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges. Use this API to get information including specific privileges assigned to a [role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control).<br> Pre-requisite:<br> * A Pro or higher plan.<br> * For role management and updates, you must be the Account Owner or user with role management permissions. Scopes: `role:read:admin`<br> @param role_id Role Id. @param [Hash] opts the optional parameters @return [Array<(InlineResponse20071, Fixnum, Hash)>] InlineResponse20071 data, response status code and response headers
# File lib/zoom_us/roles.rb, line 200 def get_role_information_with_http_info(role_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.get_role_information ...' end # verify the required parameter 'role_id' is set if @api_client.config.client_side_validation && role_id.nil? fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.get_role_information" end # resource path local_var_path = '/roles/{roleId}'.sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20071') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#get_role_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Unassign a Member's Role User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user's role. Scope: `role:write:admin`
Prerequisites:
* A Pro or a higher plan. @param role_id The role ID @param member_id Member's ID @param [Hash] opts the optional parameters @return [nil]
# File lib/zoom_us/roles.rb, line 245 def role_member_delete(role_id, member_id, opts = {}) role_member_delete_with_http_info(role_id, member_id, opts) nil end
Unassign a Member's Role User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user's role. Scope: `role:write:admin`<br> <br> Prerequisites:<br> * A Pro or a higher plan. @param role_id The role ID @param member_id Member's ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/zoom_us/roles.rb, line 256 def role_member_delete_with_http_info(role_id, member_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.role_member_delete ...' end # verify the required parameter 'role_id' is set if @api_client.config.client_side_validation && role_id.nil? fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.role_member_delete" end # verify the required parameter 'member_id' is set if @api_client.config.client_side_validation && member_id.nil? fail ArgumentError, "Missing the required parameter 'member_id' when calling RolesApi.role_member_delete" end # resource path local_var_path = '/roles/{roleId}/members/{memberId}'.sub('{' + 'roleId' + '}', role_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#role_member_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Members in a Role User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role. Scope: `role:read:admin`
Prerequisites:
* A Pro or a higher plan. @param role_id The role ID @param [Hash] opts the optional parameters @return [RoleMembersList]
# File lib/zoom_us/roles.rb, line 303 def role_members(role_id, opts = {}) data, _status_code, _headers = role_members_with_http_info(role_id, opts) data end
List Members in a Role User [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role. Scope: `role:read:admin`<br> <br>Prerequisites:<br> * A Pro or a higher plan. @param role_id The role ID @param [Hash] opts the optional parameters @return [Array<(RoleMembersList, Fixnum, Hash)>] RoleMembersList data, response status code and response headers
# File lib/zoom_us/roles.rb, line 313 def role_members_with_http_info(role_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.role_members ...' end # verify the required parameter 'role_id' is set if @api_client.config.client_side_validation && role_id.nil? fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.role_members" end # resource path local_var_path = '/roles/{roleId}/members'.sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RoleMembersList') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#role_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Roles
List [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account Scopes: `role:read:admin`
Prerequisites : * Pro or higher plan. * For setting the initial role, you must be the Account Owner. * For subsequent role management, you must be the Account Owner or user with role management permissions. @param [Hash] opts the optional parameters @return [Object]
# File lib/zoom_us/roles.rb, line 356 def roles(opts = {}) data, _status_code, _headers = roles_with_http_info(opts) data end
List Roles
List [roles](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account Scopes: `role:read:admin`<br> <br> Prerequisites : * Pro or higher plan. * For setting the initial role, you must be the Account Owner. * For subsequent role management, you must be the Account Owner or user with role management permissions. @param [Hash] opts the optional parameters @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/roles.rb, line 365 def roles_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.roles ...' end # resource path local_var_path = '/roles' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Object') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update Role Information Each Zoom user automatically has a [role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to change the privileges, name and description of a specific role.
Pre-requisite:
* A Pro or higher plan.
* For role management and updates, you must be the Account Owner or user with role management permissions.
Scopes: `role:write:admin`
@param role_id Role Id @param [Hash] opts the optional parameters @option opts [Body52] :body @return [Object]
# File lib/zoom_us/roles.rb, line 406 def update_role(role_id, opts = {}) data, _status_code, _headers = update_role_with_http_info(role_id, opts) data end
Update Role Information Each Zoom user automatically has a [role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to change the privileges, name and description of a specific role.<br> Pre-requisite:<br> * A Pro or higher plan.<br> * For role management and updates, you must be the Account Owner or user with role management permissions.<br>Scopes: `role:write:admin`<br> @param role_id Role Id @param [Hash] opts the optional parameters @option opts [Body52] :body @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/roles.rb, line 417 def update_role_with_http_info(role_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RolesApi.update_role ...' end # verify the required parameter 'role_id' is set if @api_client.config.client_side_validation && role_id.nil? fail ArgumentError, "Missing the required parameter 'role_id' when calling RolesApi.update_role" end # resource path local_var_path = '/roles/{roleId}'.sub('{' + 'roleId' + '}', role_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Object') if @api_client.config.debugging @api_client.config.logger.debug "API called: RolesApi#update_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end