Join device to workspace

Motivation

Joins a device to a workspace. The device must be created before it could be joined to a workspace.

Functional design

• POST /api/v2/apps/{owner}/{app}/workspaces/{wsid}/commands/sys.JoinDevice

Headers

Key	Value
Authorization	Bearer {PrincipalToken}
Content-Type	application/json

Body

{
  "args": {
    "ProfileWSID": {profile-wsid},
    "Roles": "{roles}"
  }
}

Parameters

Parameter	Type	Description
Query
owner	string	name of a user who owns the application
app	string	name of an application
wsid	int64	the ID of workspace
Headers
PrincipalToken	string	Token returned by login
Body
profile-wsid	int64	profile WSID of the registered device
roles	string	comma-separated roles to assign to device within the workspace

Result

Code	Description	Body
200	OK	Device joined
400	Bad Request	error object
401	Unauthorized	error object
403	Forbidden	error object
429	Too Many Requests	error object
500	Internal Server Error	error object
503	Service Unavailable	error object

Perimssions

• By default granted to sys.WorkspaceOwner

Technical design

Components

• pkg/sys

• ~cmp.sysJoinDevice~❓ command which joins a device to a workspace

  • Roles varchar(1024) NOT NULL

  • ProfileWSID int64 NOT NULL

  • Grant execution sys.JoinDevice to sys.WorkspaceOwner role

• pkg/sys/it

  • ~it.TestJoinDevice~❓: integration test for joining device to workspace