Class: Seam::Resources::AcsAccessGroup

Inherits:
BaseResource show all
Defined in:
lib/seam/resources/acs_access_group.rb

Overview

Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.

Some access control systems use access group, which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.

To learn whether your access control system supports access groups, see the corresponding system integration guide.

Defined Under Namespace

Classes: AccessSchedule, Errors, PendingMutations, Warnings

Instance Attribute Summary collapse

Attributes inherited from BaseResource

#client, #data

Instance Method Summary collapse

Methods inherited from BaseResource

#[], aliased_accessor, attribute_aliases, date_accessor, discriminated_by, #initialize, #inspect, load_from_response, resource_accessor, resource_accessors, resource_list_accessor, resource_list_accessors, #update_from_response

Constructor Details

This class inherits a constructor from Seam::Resources::BaseResource

Instance Attribute Details

#access_group_type ⇒ String

Deprecated.

Use external_type.

Known values:

  • pti_unit
  • pti_access_level
  • salto_ks_access_group
  • brivo_group
  • salto_space_group
  • dormakaba_community_access_group
  • dormakaba_ambiance_access_group
  • avigilon_alta_group
  • kisi_access_group
  • akiles_member_group

Returns:

  • (String) 


156
157
158
 
# File 'lib/seam/resources/acs_access_group.rb', line 156

def access_group_type
  @access_group_type
end

#access_group_type_display_name ⇒ String

Deprecated.

Use external_type_display_name.

Returns:

  • (String) 


159
160
161
 
# File 'lib/seam/resources/acs_access_group.rb', line 159

def access_group_type_display_name
  @access_group_type_display_name
end

#acs_access_group_id ⇒ String

ID of the access group.

Returns:

  • (String) 


162
163
164
 
# File 'lib/seam/resources/acs_access_group.rb', line 162

def acs_access_group_id
  @acs_access_group_id
end

#acs_system_id ⇒ String

ID of the access control system that contains the access group.

Returns:

  • (String) 


165
166
167
 
# File 'lib/seam/resources/acs_access_group.rb', line 165

def acs_system_id
  @acs_system_id
end

#connected_account_id ⇒ String

ID of the connected account that contains the access group.

Returns:

  • (String) 


168
169
170
 
# File 'lib/seam/resources/acs_access_group.rb', line 168

def 
  @connected_account_id
end

#display_name ⇒ String

Display name for the access group.

Returns:

  • (String) 


171
172
173
 
# File 'lib/seam/resources/acs_access_group.rb', line 171

def display_name
  @display_name
end

#external_type ⇒ String

Brand-specific terminology for the access group type. Known values:

  • pti_unit
  • pti_access_level
  • salto_ks_access_group
  • brivo_group
  • salto_space_group
  • dormakaba_community_access_group
  • dormakaba_ambiance_access_group
  • avigilon_alta_group
  • kisi_access_group
  • akiles_member_group

Returns:

  • (String) 


185
186
187
 
# File 'lib/seam/resources/acs_access_group.rb', line 185

def external_type
  @external_type
end

#external_type_display_name ⇒ String

Display name that corresponds to the brand-specific terminology for the access group type.

Returns:

  • (String) 


188
189
190
 
# File 'lib/seam/resources/acs_access_group.rb', line 188

def external_type_display_name
  @external_type_display_name
end

#is_managed ⇒ TrueClass

Indicates whether Seam manages the access group.

Returns:

  • (TrueClass) 


191
192
193
 
# File 'lib/seam/resources/acs_access_group.rb', line 191

def is_managed
  @is_managed
end

#name ⇒ String

Name of the access group.

Returns:

  • (String) 


194
195
196
 
# File 'lib/seam/resources/acs_access_group.rb', line 194

def name
  @name
end

#workspace_id ⇒ String

ID of the workspace that contains the access group.

Returns:

  • (String) 


197
198
199
 
# File 'lib/seam/resources/acs_access_group.rb', line 197

def workspace_id
  @workspace_id
end

Instance Method Details

#access_schedule ⇒ AccessSchedule?

starts_at and ends_at timestamps for the access group's access.

Returns:



133
 
# File 'lib/seam/resources/acs_access_group.rb', line 133

resource_accessor :access_schedule, AccessSchedule

#created_at ⇒ Time

Date and time at which the access group was created.

Returns:

  • (Time) 


201
 
# File 'lib/seam/resources/acs_access_group.rb', line 201

date_accessor :created_at

#errors ⇒ Array<Errors>

Errors associated with the acs_access_group.

Returns:



136
 
# File 'lib/seam/resources/acs_access_group.rb', line 136

resource_list_accessor :errors, Errors

#pending_mutations ⇒ Array<PendingMutations>

Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.

Returns:



139
 
# File 'lib/seam/resources/acs_access_group.rb', line 139

resource_list_accessor :pending_mutations, PendingMutations

#warnings ⇒ Array<Warnings>

Warnings associated with the acs_access_group.

Returns:



142
 
# File 'lib/seam/resources/acs_access_group.rb', line 142

resource_list_accessor :warnings, Warnings