assign_users_to_workspaces: Manager user assignment to a workspace

View source: R/workspaces.R

assign_users_to_workspacesR Documentation

Manager user assignment to a workspace

Description

Manage which users are present in which workspaces. For now, only headquarters and API users may be managed. Actions available: assign, add, and remove. The assign action moves a user to the target workspace (exclusively). The add action adds the user to the workspace while keeping them in previously assigned workspaces. The remove action removes them from the target workspace.

Usage

assign_users_to_workspaces(
  users,
  workspaces,
  action = "Assign",
  server = Sys.getenv("SUSO_SERVER"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

users

Character vector. GUID for user.

workspaces

Character vector. Name ID of workspace

action

Character. One of the following: Assign, Add, Remove.

server

Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)

user

Character. Admin user name

password

Character. Admin password

Details

Wrapper for ⁠POST ​/api​/v1​/workspaces​/assign⁠ endpoint.


arthur-shaw/susoapi documentation built on Oct. 15, 2024, 3:44 a.m.