List Form User Security Settings

Lists security/role details of all form users

GET/api/restricted/form/{formId}/usersecurity
curl --request GET 'https://api.globalpatron.com/api/restricted/form/{3b3d22e4-43a9-4a0a-a4d7-54174059ef96}/usersecurity' \
--header 'TokenId: XXXXX' \
--header 'TokenSecret: XXXXX'
Response 200 OK 
{
    "results": [
        {
            "form_id": "3b3d22e4-43a9-4a0a-a4d7-54174059ef96",
            "granted_to_email_address": "[email protected]",
            "granted_by_user_id": "google.com|g95bdbd5-318b-4ae4-85c7-63dfa705d815",
            "has_form_submission": true,
            "has_reporting_full": true,
            "has_account_management": true,
            "has_form_editor": true,
            "has_offline_form_submission": true,
            "id": "399a271a-2d6f-470c-93c7-792364ae090b",
            "created_date_utc": "2023-10-28T07:16:20.5214857Z",
            "modified_date_utc": "0001-01-01T00:00:00"
        },
        {
            "form_id": "3b3d22e4-43a9-4a0a-a4d7-54174059ef96",
            "granted_to_email_address": "[email protected]",
            "granted_by_user_id": "google.com|g95bdbd5-318b-4ae4-85c7-63dfa705d815",
            "has_form_submission": true,
            "has_reporting_full": true,
            "has_account_management": false,
            "has_form_editor": false,
            "has_offline_form_submission": true,
            "id": "ba3b94f5-a22f-4901-9b96-1892e5e0d782",
            "created_date_utc": "2023-10-28T07:15:55.9457877Z",
            "modified_date_utc": "0001-01-01T00:00:00"
        },
        {
            "form_id": "3b3d22e4-43a9-4a0a-a4d7-54174059ef96",
            "granted_to_user_id": "google.com|g95bdbd5-318b-4ae4-85c7-63dfa705d815",
            "has_form_submission": true,
            "has_reporting_full": true,
            "has_account_management": true,
            "has_form_editor": true,
            "has_offline_form_submission": true,
            "id": "6df2a6f5-0067-4b60-8a9d-3d6d3efbd7ad",
            "created_date_utc": "2023-10-18T13:55:25.5774251Z",
            "modified_date_utc": "0001-01-01T00:00:00"
        }
    ],
    "form_document_basic": {
        "form_configuration": {
            "settings": {
                "form_name": "My form name",
                "form_type": "classicmulti",
                "form_system_version": 2
            }
        },
        "id": "3b3d22e4-43a9-4a0a-a4d7-54174059ef96",
        "created_date_utc": "2023-10-18T13:55:25.5774251Z",
        "modified_date_utc": "2023-10-18T14:34:24.5886753Z"
    },
    "granted_form_roles": [
        "has_account_management",
        "has_form_editor",
        "has_form_submission",
        "has_offline_form_submission",
        "has_reporting_full"
    ]
}



Add Form User

Adds a new form user, assigning them access rights to a form

POST/api/restricted/form/{formId}/usersecurity?has_form_submission=[0|1]&has_reporting_full=[0|1]&has_form_editor=[0|1]&has_account_management=[0|1]&has_offline_form_submission=[0|1]&collaborator_email=[newUsersEmail]
curl --request POST https://api.globalpatron.com/api/restricted/form/{3b3d22e4-43a9-4a0a-a4d7-54174059ef96}/usersecurity?has_form_submission=1&has_reporting_full=1&has_form_editor=0&has_account_management=1&has_offline_form_submission=1&collaborator_email=john.smith@microsoft.com' \
--header 'TokenId: XXXXX' \
--header 'TokenSecret: XXXXX'
Response 200 OK 
{
    "id": "",
    "message": "Form collaborator added successfully",
    "action_successful": true,
    "error": ""
}



Update Form User Security Settings

Updates the security settings assigned to an existing form user

POST /api/restricted/form/{formId}/usersecurity/{userSecurityId}?has_form_submission=[0|1]&has_reporting_full=[0|1]&has_form_editor=[0|1]&has_account_management=[0|1]&has_offline_form_submission=[0|1]
curl --request POST 'https://api.globalpatron.com/api/restricted/form/{3b3d22e4-43a9-4a0a-a4d7-54174059ef96}/usersecurity/{399a271a-2d6f-470c-93c7-792364ae090b}?has_form_submission=0&has_reporting_full=0&has_form_editor=1&has_account_management=1&has_offline_form_submission=1' \
--header 'TokenId: XXXXX' \
--header 'TokenSecret: XXXXX'
Response 200 OK 
{
    "id": "",
    "message": "Form collaborator updated successfully",
    "action_successful": true,
    "error": ""
}



Delete Form User

Deletes an existing form user

DELETE/api/restricted/form/{formId}/usersecurity/{userSecurityDocumentId}
curl --request DELETE 'https://api.globalpatron.com/api/restricted/form/{3b3d22e4-43a9-4a0a-a4d7-54174059ef96}/usersecurity/{3ddfb0b2-5bdb-4705-870d-ee40651ec2ec}' \
--header 'TokenId: XXXXX' \
--header 'TokenSecret: XXXXX'
Response 200 OK 
{
    "id": "",
    "message": "Form collaborator removed successfully",
    "action_successful": true,
    "error": ""
}