+
Bypassing 2FA
+
Where workspaces have two-factor authentication (2FA) enabled,
-participants cannot use the API unless they have been given permission
-to bypass 2FA. Permission to bypass 2FA is given at a workspace level,
-and can only be granted by the workspace owner.
-
To check which participants are allowed to bypass 2FA, run
+participants won’t be able to use the API unless they have been given
+permission to bypass 2FA.
+
To check which participants have permission to bypass 2FA, run
participants() using your workspace UUID, and inspect the
bypass_2fa column in the returned data frame.
-
The following guidance is for workspace owners. If you are not the
-workspace owner, you will need to ask them to provide you with bypass
-permissions.
+
To set up 2FA bypassing in your workspace, you’ll need the help of
+both your workgroup administrator and your workspace owner. There are
+three main steps to complete this process:
+
These steps only need to be carried out once before you can use objr
(or the API in general) for the first time.
+
Before you start, you’ll need the name and UUID for both your
+workgroup and workspace. More information on how to find these UUIDs can
+be found on the Getting
+Started page.
+
+
A note for non R users
+
+
Some of the required changes can only be made via the API (and not in
+the Objective
+Connect browser interface). If the user required to make these
+changes is not an R user, they can use the API via it’s interactive
+documentation instead of using objr.
+
Before using the interactivity, set up API authentication by clicking
+the the ‘Authorise’ button and entering your Objective Connect username
+and password.
+
Links to relevant sections of the interactive documentation will be
+provided for each step below.
+
+
-
Allowing other participants to bypass 2FA
+Permssion for other participants
-
As you (the workspace owner) can now bypass 2FA, you can now provide
-the same bypassing permissions to other workspace members. This can be
-done in the same way as above; by using
-participant_bypass_2fa() and providing the relevant
-members’ participant UUID.
-
For Scottish Government Objective Connect workspaces, these
-permissions should be limited to Scottish Government staff and not
-external participants.
+
These steps must be completed by the workspace
+owner.
+
+-
+
In R, give participants permission to bypass 2FA using
+participant_bypass_2fa(). You will need the relevant
+members’ participant UUID, which can be found using
+participants().
+
+Non R users can use the interactive documentation to find the
+relevant participant
+UUID and to allow
+participant 2FA bypassing.
+
+
+
+
+For Scottish Government Objective Connect workspaces, bypassing
+permissions should be limited to Scottish Government staff and not given
+to external workspace participants.
+
If you wish to revoke permissions to bypass 2FA, use
participant_bypass_2fa() and set
allow_bypass = FALSE.
diff --git a/articles/workgroup-2fa.png b/articles/workgroup-2fa.png
new file mode 100644
index 0000000..e461914
Binary files /dev/null and b/articles/workgroup-2fa.png differ
diff --git a/articles/workspace-2fa.png b/articles/workspace-2fa.png
new file mode 100644
index 0000000..090a4f2
Binary files /dev/null and b/articles/workspace-2fa.png differ
diff --git a/authors.html b/authors.html
index 9e959ba..4516d5f 100644
--- a/authors.html
+++ b/authors.html
@@ -7,7 +7,7 @@
objr
-
0.0.0.9004
+
0.0.0.9005