diff --git a/reference/store_token.html b/reference/store_token.html
index 183bd51..50575af 100644
--- a/reference/store_token.html
+++ b/reference/store_token.html
@@ -20,6 +20,12 @@
diff --git a/search.json b/search.json
index e81bb3a..0d679d6 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"path":"https://scotgovanalysis.github.io/objectiveR/LICENCE.html","id":null,"dir":"","previous_headings":"","what":"MIT Licence","title":"MIT Licence","text":"Copyright (c) 2023 Crown Copyright (Scottish Government) Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Scottish Government Email Scottish Government> Scottish Government GitHub profile>. Copyright holder. Alice Byers Email Alice Byers> Alice Byers GitHub profile>. Author, maintainer.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Byers (2024). objectiveR: Wrapper Objective APIs. R package version 0.0.0.9000, https://ScotGovAnalysis.github.io/objectiveR, https://github.com/ScotGovAnalysis/objectiveR.","code":"@Manual{, title = {objectiveR: Wrapper for Objective APIs}, author = {Alice Byers}, year = {2024}, note = {R package version 0.0.0.9000, https://ScotGovAnalysis.github.io/objectiveR}, url = {https://github.com/ScotGovAnalysis/objectiveR}, }"},{"path":"https://scotgovanalysis.github.io/objectiveR/index.html","id":"objectiver","dir":"","previous_headings":"","what":"Wrapper for Objective APIs","title":"Wrapper for Objective APIs","text":"objectiveR R package wrapper Objective Connect API.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Wrapper for Objective APIs","text":"package can installed directly GitHub. Note method requires remotes package may work within Scottish Government network. Finally, package can also installed downloading zip repository running following code, replacing section marked <> (including arrows ) location downloaded zip:","code":"remotes::install_github( \"ScotGovAnalysis/objectiveR\", upgrade = \"never\", build_vignettes = TRUE ) remotes::install_local( \"
/objectiveR-main.zip\", upgrade = \"never\", build_vignettes = TRUE )"},{"path":"https://scotgovanalysis.github.io/objectiveR/index.html","id":"licence","dir":"","previous_headings":"","what":"Licence","title":"Wrapper for Objective APIs","text":"Unless stated otherwise, codebase released MIT Licence. covers codebase sample code documentation. documentation © Crown copyright available terms Open Government 3.0 licence.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/allow_bypass_2fa.html","id":null,"dir":"Reference","previous_headings":"","what":"Allow/disallow bypassing of two factor authentication for workgroup — allow_bypass_2fa","title":"Allow/disallow bypassing of two factor authentication for workgroup — allow_bypass_2fa","text":"Allow/disallow bypassing two factor authentication workgroup","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/allow_bypass_2fa.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Allow/disallow bypassing of two factor authentication for workgroup — allow_bypass_2fa","text":"","code":"allow_bypass_2fa(workgroup_uuid, allow_bypass = TRUE, use_proxy = FALSE)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/allow_bypass_2fa.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Allow/disallow bypassing of two factor authentication for workgroup — allow_bypass_2fa","text":"workgroup_uuid Workgroup UUID allow_bypass Logical indicate whether workgroup allow selected participants bypass two step workspace verification. use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/check_valid.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper function for validating input value — check_valid","title":"Helper function for validating input value — check_valid","text":"Helper function validating input value","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/check_valid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper function for validating input value — check_valid","text":"","code":"check_valid(value, warn = FALSE)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/check_valid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper function for validating input value — check_valid","text":"value Value verify warn Logical. Indicates whether produce warning value invalid","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/check_valid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper function for validating input value — check_valid","text":"Validated value","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/create_folder.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a new folder — create_folder","title":"Create a new folder — create_folder","text":"Create new folder","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/create_folder.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a new folder — create_folder","text":"","code":"create_folder( folder_name, workspace_uuid, folder_description = NULL, parent_uuid = NULL, use_proxy = FALSE )"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/create_folder.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a new folder — create_folder","text":"folder_name Name give new folder workspace_uuid UUID workspace create new folder folder_description Optional description folder parent_uuid UUID another folder workspace create new folder within. supplied, folder created top-level workspace. use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/error.html","id":null,"dir":"Reference","previous_headings":"","what":"Translate error code into helpful message — error","title":"Translate error code into helpful message — error","text":"Translate error code helpful message","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/error.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Translate error code into helpful message — error","text":"","code":"error(response)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/error.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Translate error code into helpful message — error","text":"response httr2 httr2::response()","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/error.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Translate error code into helpful message — error","text":"character vector include error message.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/input_value.html","id":null,"dir":"Reference","previous_headings":"","what":"Look for or ask for input value — input_value","title":"Look for or ask for input value — input_value","text":"function looks relevant value environment variables. exist session interactive, user prompted input value. value validated using check_valid(). Expected environment variables type follows: usr: OBJECTIVER_USR pwd: OBJECTIVER_PWD proxy: OBJECTIVER_PROXY","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/input_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Look for or ask for input value — input_value","text":"","code":"input_value(type = c(\"usr\", \"pwd\", \"proxy\"))"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/input_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Look for or ask for input value — input_value","text":"type One 'usr' (username), 'pwd' (password), 'proxy'.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/input_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Look for or ask for input value — input_value","text":"Validated value","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/my_user_id.html","id":null,"dir":"Reference","previous_headings":"","what":"Get user ID for current authenticated user — my_user_id","title":"Get user ID for current authenticated user — my_user_id","text":"Get user ID current authenticated user","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/my_user_id.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get user ID for current authenticated user — my_user_id","text":"","code":"my_user_id(use_proxy = FALSE)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/my_user_id.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get user ID for current authenticated user — my_user_id","text":"use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/my_user_id.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get user ID for current authenticated user — my_user_id","text":"character value authenticated user's ID","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/my_user_id.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get user ID for current authenticated user — my_user_id","text":"","code":"if (FALSE) { my_user_id() }"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR.html","id":null,"dir":"Reference","previous_headings":"","what":"Core request function — objectiveR","title":"Core request function — objectiveR","text":"Core request function","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Core request function — objectiveR","text":"","code":"objectiveR( endpoint, method = \"GET\", ..., accept = \"application/json\", use_proxy = FALSE )"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Core request function — objectiveR","text":"endpoint endpoint append API server address method HTTP method use; e.g. GET, POST, PUT. Defaults GET. ... Named parameters pass request body accept Accept header use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Core request function — objectiveR","text":"httr2 httr2::response()","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR_auth.html","id":null,"dir":"Reference","previous_headings":"","what":"Authenticate HTTP request — objectiveR_auth","title":"Authenticate HTTP request — objectiveR_auth","text":"sets authorisation header HTTP request. token variable exists global environment, used, otherwise, user prompted enter authenticating username password.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR_auth.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Authenticate HTTP request — objectiveR_auth","text":"","code":"objectiveR_auth(req)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR_auth.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Authenticate HTTP request — objectiveR_auth","text":"req httr2 request","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR_auth.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Authenticate HTTP request — objectiveR_auth","text":"modified httr2 request","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR_auth.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Authenticate HTTP request — objectiveR_auth","text":"","code":"if (FALSE) { httr2::request(\"http://example.com\") |> objectiveR_auth() } token <- \"test\" httr2::request(\"http://example.com\") |> objectiveR_auth() #> #> GET http://example.com #> Headers: #> • Authorization: 'test' #> Body: empty"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participant_bypass_2fa.html","id":null,"dir":"Reference","previous_headings":"","what":"Allow/disallow bypassing of two factor authentication for participant — participant_bypass_2fa","title":"Allow/disallow bypassing of two factor authentication for participant — participant_bypass_2fa","text":"Allow/disallow bypassing two factor authentication participant","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participant_bypass_2fa.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Allow/disallow bypassing of two factor authentication for participant — participant_bypass_2fa","text":"","code":"participant_bypass_2fa( participant_uuid, allow_bypass = TRUE, use_proxy = FALSE )"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participant_bypass_2fa.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Allow/disallow bypassing of two factor authentication for participant — participant_bypass_2fa","text":"participant_uuid Participant UUID (note different user UUID) allow_bypass Logical indicate whether participant able bypass two step verification workspace. use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participant_bypass_2fa.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Allow/disallow bypassing of two factor authentication for participant — participant_bypass_2fa","text":"Note: setting can updated workspace owner.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participants.html","id":null,"dir":"Reference","previous_headings":"","what":"Get data frame of workspace participants — participants","title":"Get data frame of workspace participants — participants","text":"Get data frame workspace participants","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participants.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get data frame of workspace participants — participants","text":"","code":"participants(workspace_uuid, use_proxy = FALSE)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participants.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get data frame of workspace participants — participants","text":"workspace_uuid UUID workspace use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participants.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get data frame of workspace participants — participants","text":"Data frame","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/store_token.html","id":null,"dir":"Reference","previous_headings":"","what":"Store session token from API response — store_token","title":"Store session token from API response — store_token","text":"Store session token API response","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/store_token.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Store session token from API response — store_token","text":"","code":"store_token(response, store_env = globalenv())"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/store_token.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Store session token from API response — store_token","text":"response httr2 response object; must contain 'Authorization' header. store_env environment bind token .","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/store_token.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Store session token from API response — store_token","text":"Returns token invisibly. function primarily used side effect - environment variable created called \"token\".","code":""}]
+[{"path":"https://scotgovanalysis.github.io/objectiveR/LICENCE.html","id":null,"dir":"","previous_headings":"","what":"MIT Licence","title":"MIT Licence","text":"Copyright (c) 2023 Crown Copyright (Scottish Government) Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/articles/faqs.html","id":"what-is-the-difference-between-users-and-participants","dir":"Articles","previous_headings":"","what":"What is the difference between users and participants?","title":"Frequently Asked Questions","text":"user individual using Objective Connect. participant user particular workspace. example, person using Objective Connect User UUID associated , also Participant UUID individual workspace member . user can get User UUID running my_user_id(). user can find participant UUID particular workspace using participants().","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/articles/faqs.html","id":"how-does-two-factor-authentication-2fa-work","dir":"Articles","previous_headings":"","what":"How does two factor authentication (2FA) work?","title":"Frequently Asked Questions","text":"(Note: sometimes also referred ‘two step verification’.) workspaces 2FA enabled, users use API unless given permission bypass . Permission bypass 2FA given workspace level, can granted workspace owner. Firstly, permission must given workgroup level allow bypassing permissions granted workspaces within . can done using allow_bypass_2fa(). allowed, bypassing can granted individual participants workspace using participant_bypass_2fa(). functions also allow bypassing disallowed using allow_bypass = FALSE. check status bypassing 2FA participants workspace, use participants().","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Scottish Government Email Scottish Government> Scottish Government GitHub profile>. Copyright holder. Alice Byers Email Alice Byers> Alice Byers GitHub profile>. Author, maintainer.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Byers (2024). objectiveR: Wrapper Objective APIs. R package version 0.0.0.9000, https://ScotGovAnalysis.github.io/objectiveR, https://github.com/ScotGovAnalysis/objectiveR.","code":"@Manual{, title = {objectiveR: Wrapper for Objective APIs}, author = {Alice Byers}, year = {2024}, note = {R package version 0.0.0.9000, https://ScotGovAnalysis.github.io/objectiveR}, url = {https://github.com/ScotGovAnalysis/objectiveR}, }"},{"path":"https://scotgovanalysis.github.io/objectiveR/index.html","id":"objectiver","dir":"","previous_headings":"","what":"Wrapper for Objective APIs","title":"Wrapper for Objective APIs","text":"objectiveR R package wrapper Objective Connect API.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Wrapper for Objective APIs","text":"package can installed directly GitHub. Note method requires remotes package may work within Scottish Government network. Finally, package can also installed downloading zip repository running following code, replacing section marked <> (including arrows ) location downloaded zip:","code":"remotes::install_github( \"ScotGovAnalysis/objectiveR\", upgrade = \"never\", build_vignettes = TRUE ) remotes::install_local( \"/objectiveR-main.zip\", upgrade = \"never\", build_vignettes = TRUE )"},{"path":"https://scotgovanalysis.github.io/objectiveR/index.html","id":"licence","dir":"","previous_headings":"","what":"Licence","title":"Wrapper for Objective APIs","text":"Unless stated otherwise, codebase released MIT Licence. covers codebase sample code documentation. documentation © Crown copyright available terms Open Government 3.0 licence.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/allow_bypass_2fa.html","id":null,"dir":"Reference","previous_headings":"","what":"Allow/disallow bypassing of two factor authentication for workgroup — allow_bypass_2fa","title":"Allow/disallow bypassing of two factor authentication for workgroup — allow_bypass_2fa","text":"information two factor authentication can found vignette(\"faqs\").","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/allow_bypass_2fa.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Allow/disallow bypassing of two factor authentication for workgroup — allow_bypass_2fa","text":"","code":"allow_bypass_2fa(workgroup_uuid, allow_bypass = TRUE, use_proxy = FALSE)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/allow_bypass_2fa.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Allow/disallow bypassing of two factor authentication for workgroup — allow_bypass_2fa","text":"workgroup_uuid Workgroup UUID allow_bypass Logical indicate whether workgroup allow selected participants bypass two step workspace verification. use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/check_valid.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper function for validating input value — check_valid","title":"Helper function for validating input value — check_valid","text":"Helper function validating input value","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/check_valid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper function for validating input value — check_valid","text":"","code":"check_valid(value, warn = FALSE)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/check_valid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper function for validating input value — check_valid","text":"value Value verify warn Logical. Indicates whether produce warning value invalid","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/check_valid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper function for validating input value — check_valid","text":"Validated value","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/create_folder.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a new folder — create_folder","title":"Create a new folder — create_folder","text":"Create new folder","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/create_folder.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a new folder — create_folder","text":"","code":"create_folder( folder_name, workspace_uuid, folder_description = NULL, parent_uuid = NULL, use_proxy = FALSE )"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/create_folder.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a new folder — create_folder","text":"folder_name Name give new folder workspace_uuid UUID workspace create new folder folder_description Optional description folder parent_uuid UUID another folder workspace create new folder within. supplied, folder created top-level workspace. use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/error.html","id":null,"dir":"Reference","previous_headings":"","what":"Translate error code into helpful message — error","title":"Translate error code into helpful message — error","text":"Translate error code helpful message","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/error.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Translate error code into helpful message — error","text":"","code":"error(response)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/error.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Translate error code into helpful message — error","text":"response httr2 httr2::response()","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/error.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Translate error code into helpful message — error","text":"character vector include error message.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/input_value.html","id":null,"dir":"Reference","previous_headings":"","what":"Look for or ask for input value — input_value","title":"Look for or ask for input value — input_value","text":"function looks relevant value environment variables. exist session interactive, user prompted input value. value validated using check_valid(). Expected environment variables type follows: usr: OBJECTIVER_USR pwd: OBJECTIVER_PWD proxy: OBJECTIVER_PROXY","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/input_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Look for or ask for input value — input_value","text":"","code":"input_value(type = c(\"usr\", \"pwd\", \"proxy\"))"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/input_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Look for or ask for input value — input_value","text":"type One 'usr' (username), 'pwd' (password), 'proxy'.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/input_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Look for or ask for input value — input_value","text":"Validated value","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/my_user_id.html","id":null,"dir":"Reference","previous_headings":"","what":"Get user ID for current authenticated user — my_user_id","title":"Get user ID for current authenticated user — my_user_id","text":"Get user ID current authenticated user","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/my_user_id.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get user ID for current authenticated user — my_user_id","text":"","code":"my_user_id(use_proxy = FALSE)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/my_user_id.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get user ID for current authenticated user — my_user_id","text":"use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/my_user_id.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get user ID for current authenticated user — my_user_id","text":"character value authenticated user's ID","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/my_user_id.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get user ID for current authenticated user — my_user_id","text":"","code":"if (FALSE) { my_user_id() }"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR.html","id":null,"dir":"Reference","previous_headings":"","what":"Core request function — objectiveR","title":"Core request function — objectiveR","text":"Core request function","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Core request function — objectiveR","text":"","code":"objectiveR( endpoint, method = \"GET\", ..., accept = \"application/json\", use_proxy = FALSE )"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Core request function — objectiveR","text":"endpoint endpoint append API server address method HTTP method use; e.g. GET, POST, PUT. Defaults GET. ... Named parameters pass request body accept Accept header use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Core request function — objectiveR","text":"httr2 httr2::response()","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR_auth.html","id":null,"dir":"Reference","previous_headings":"","what":"Authenticate HTTP request — objectiveR_auth","title":"Authenticate HTTP request — objectiveR_auth","text":"sets authorisation header HTTP request. token variable exists global environment, used, otherwise, user prompted enter authenticating username password.","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR_auth.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Authenticate HTTP request — objectiveR_auth","text":"","code":"objectiveR_auth(req)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR_auth.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Authenticate HTTP request — objectiveR_auth","text":"req httr2 request","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR_auth.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Authenticate HTTP request — objectiveR_auth","text":"modified httr2 request","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/objectiveR_auth.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Authenticate HTTP request — objectiveR_auth","text":"","code":"if (FALSE) { httr2::request(\"http://example.com\") |> objectiveR_auth() } token <- \"test\" httr2::request(\"http://example.com\") |> objectiveR_auth() #> #> GET http://example.com #> Headers: #> • Authorization: 'test' #> Body: empty"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participant_bypass_2fa.html","id":null,"dir":"Reference","previous_headings":"","what":"Allow/disallow bypassing of two factor authentication for participant — participant_bypass_2fa","title":"Allow/disallow bypassing of two factor authentication for participant — participant_bypass_2fa","text":"Note setting can updated workspace owner. information two factor authentication can found vignette(\"faqs\").","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participant_bypass_2fa.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Allow/disallow bypassing of two factor authentication for participant — participant_bypass_2fa","text":"","code":"participant_bypass_2fa( participant_uuid, allow_bypass = TRUE, use_proxy = FALSE )"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participant_bypass_2fa.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Allow/disallow bypassing of two factor authentication for participant — participant_bypass_2fa","text":"participant_uuid Participant UUID (note different user UUID) allow_bypass Logical indicate whether participant able bypass two step verification workspace. use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participants.html","id":null,"dir":"Reference","previous_headings":"","what":"Get data frame of workspace participants — participants","title":"Get data frame of workspace participants — participants","text":"Get data frame workspace participants","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participants.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get data frame of workspace participants — participants","text":"","code":"participants(workspace_uuid, use_proxy = FALSE)"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participants.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get data frame of workspace participants — participants","text":"workspace_uuid UUID workspace use_proxy Logical indicate whether use proxy","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/participants.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get data frame of workspace participants — participants","text":"Data frame","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/store_token.html","id":null,"dir":"Reference","previous_headings":"","what":"Store session token from API response — store_token","title":"Store session token from API response — store_token","text":"Store session token API response","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/store_token.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Store session token from API response — store_token","text":"","code":"store_token(response, store_env = globalenv())"},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/store_token.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Store session token from API response — store_token","text":"response httr2 response object; must contain 'Authorization' header. store_env environment bind token .","code":""},{"path":"https://scotgovanalysis.github.io/objectiveR/reference/store_token.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Store session token from API response — store_token","text":"Returns token invisibly. function primarily used side effect - environment variable created called \"token\".","code":""}]
diff --git a/sitemap.xml b/sitemap.xml
index 68edc49..17b407e 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -9,6 +9,12 @@
https://scotgovanalysis.github.io/objectiveR/LICENSE-text.html
+
+ https://scotgovanalysis.github.io/objectiveR/articles/faqs.html
+
+
+ https://scotgovanalysis.github.io/objectiveR/articles/index.html
+
https://scotgovanalysis.github.io/objectiveR/authors.html