Type alias GetRoleGroupAccessArg

Type declaration

• Optional bustCache?: boolean

  Whether to bypass the cache and get the latest data

• Optional canRead?: boolean

  Return only access for resources you can read

• Optional canUpdate?: boolean

  Return only access for resources you can update

• Optional createdBy?: string

  ID of the user who created the account

• Optional createdDate?: string

  Created date of items to return

• Optional created_date.gte?: string

• Optional created_date.lte?: string

• Optional desc?: boolean

  Whether to order results in descending order

• Optional device_permissions.can_create?: boolean

  Device membership create permissions

• Optional device_permissions.can_delete?: boolean

  Device membership delete permissions

• Optional device_permissions.can_read?: boolean

  Device membership read permissions

• Optional device_permissions.can_update?: boolean

  Device membership update permissions

• Optional groupDescription?: string

  Return access for groups with a specific description

• Optional groupName?: string

  Return access for groups with a specific name

• Optional groupTags?: string

  Return access for groups with specific tags

• Optional group_tags.contains?: string

• Optional group_tags.contains_any?: string

• Optional idsOnly?: boolean

  Return list(s) of IDs only

• Optional includeInactiveGroups?: boolean

  Return group access of inactive groups

• Optional isActive?: boolean

  (Admin only) Whether to only return active accounts

• Optional isAdmin?: boolean

  Only return group access with admin access

• Optional isDeleteProtected?: boolean

  Whether to only return delete-protected accounts

• Optional lastUpdatedBy?: string

  ID of the user who last updated the account

• Optional lastUpdatedDate?: string

  Last edited date of items to return

• Optional last_updated_date.gte?: string

• Optional last_updated_date.lte?: string

• Optional limit?: number

  Maximum number of objects to return

• Optional objectCount?: boolean

  Whether to only return the number of matching entries

• Optional orderBy?: string

  Field to order results by

• Optional page?: number

  Page number to return

• Optional pageCount?: boolean

  Whether to only return the number of pages

• Optional projectId?: string

  Only return group access under a specific project

• roleId: string

• Optional role_permissions.can_create?: boolean

  Role membership create permissions

• Optional role_permissions.can_delete?: boolean

  Role membership delete permissions

• Optional role_permissions.can_read?: boolean

  Role membership read permissions

• Optional role_permissions.can_update?: boolean

  Role membership update permissions

• Optional search?: string

  Search term to filter accounts by

• Optional searchFields?: string

  Comma-delimited list of fields to search in

• Optional tags?: string

  Comma delimited list of tags on this account

• Optional tags.contains?: string

• Optional tags.contains_any?: string

• Optional user_permissions.can_create?: boolean

  User membership create permission

• Optional user_permissions.can_delete?: boolean

  User membership delete permission

• Optional user_permissions.can_read?: boolean

  User membership read permission

• Optional user_permissions.can_update?: boolean

  User membership update permission