class LosantRest::InstanceOrgMembers
Class containing all the actions for the Instance
Org
Members Resource
Public Class Methods
# File lib/losant_rest/instance_org_members.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Returns a collection of instance organization members
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgMembers.*, or instanceOrgMembers.get.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} orgId - ID associated with the organization
-
{string} sortField - Field to sort the results by. Accepted values are: email, role
-
{string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
-
{string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role
-
{string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
-
{string} losantdomain - Domain scope of request (rarely needed)
-
{boolean} _actions - Return resource actions in response
-
{boolean} _links - Return resource link in response
-
{boolean} _embedded - Return embedded resources in response
Responses:
-
200 - A collection of instance organization members (api.losant.com/#/definitions/instanceOrgMembers)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if instance was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_org_members.rb, line 60 def get(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId) query_params[:sortField] = params[:sortField] if params.has_key?(:sortField) query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection) query_params[:filterField] = params[:filterField] if params.has_key?(:filterField) query_params[:filter] = params[:filter] if params.has_key?(:filter) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/members" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Creates a new organization member
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceOrgMembers.*, or instanceOrgMembers.post.
Parameters:
-
{string} instanceId - ID associated with the instance
-
{string} orgId - ID associated with the organization
-
{hash} member - Object containing new member info (api.losant.com/#/definitions/instanceOrgMemberPost)
-
{string} losantdomain - Domain scope of request (rarely needed)
-
{boolean} _actions - Return resource actions in response
-
{boolean} _links - Return resource link in response
-
{boolean} _embedded - Return embedded resources in response
Responses:
-
200 - The newly created instance member (api.losant.com/#/definitions/instanceOrgMember)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if instance was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/instance_org_members.rb, line 111 def post(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId) raise ArgumentError.new("member is required") unless params.has_key?(:member) body = params[:member] if params.has_key?(:member) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/members" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end