POST: Create a Collaboration Registration Form Ingrid ⇤ Client Access Links https://api.bitsighttech.com/ratings/v1/client-access-links Create a new registration form for clients to register for the Client/Vendor Access Program. Available for Continuous Monitoring and Cyber Insurance users. Parameters Parameter Values name [Body] Assign a name for the form. [String] description [Body] Provide a description of the form. [String] is_active [Body] Determine if the form is active. [Boolean] true = The form is active. false = The form is inactive. scope [Body] The app scope where the user created the client access link. [String] insurance = Insurance app tprm = Continuous Monitoring app Example Request cURL Example curl -H "Content-Type: application/json" -X POST -i https://api.bitsighttech.com/ratings/v1/client-access-links -u api_token: -d '{ "name": "Example name", "description": "Example description", "is_active": true, "scope": "tprm" }' JSON Example { "name": "Example name", "description": "Example description", "is_active": true, "scope": "tprm" } Example Response { "guid": "19caa9ab-0560-4661-9d02-3364b13714ec", "link": "https://service.bitsighttech.com/app/static/pages/access-request?token=19caa9ab-0560-4661-9d02-3364b13714ec", "name": "Example name", "scope": "tprm" "description": "Example description", "is_active": true, "created_time": "2024-01-29T17:37:54.968848Z", "updated_time": "2024-01-29T17:37:54.968893Z", "created_by": { "guid": "de5750f0-f60b-4478-9bfc-08m20e71f4b2", "formal_name": "User One" }, "updated_by": {null} } Response Attributes Field Description guid String [collab_form_guid] The unique identifier of this collaboration registration form. link String The form URL. name String The name of this form. scope String The app scope where the user created the client access link. description String A description of this form. is_active Boolean true = This form is active. created_time String [YYYY-MM-DDTHH:MM:SSZ] The date and time when this form was created. updated_time String [YYYY-MM-DDTHH:MM:SSZ] The date and time when this form was last updated. created_by Object The user who created this form. guid String [user_guid] This user’s unique identifier. formal_name String This user's name. updated_by Object The user who last updated this form. Status Codes See the common errors and status codes. Code Description 201 – Success The request was successfully submitted. 400 – Bad Request This can often be due to missing a required parameter. 401 – No Authentication No valid API token was provided. 403 – Unauthorized You do not have permission to access this resource. 404 – Not Found The specified resource could not be found. September 3, 2024: Added scope parameter and response attribute. February 12, 2024: Published. Related articles GET: Breach News GET: Service Provider Details DKIM Records Risk Vector PATCH: Update a Collaboration Registration Form Program Setup: Client Access Links Feedback 0 comments Please sign in to leave a comment.