Grip Security
The Grip Security connector enables seamless integration with the Grip Security platform, allowing for efficient management and automation of security tasks related to SaaS applications.
Grip Security offers a comprehensive SaaS management platform that enhances visibility and control over SaaS applications. This connector enables Swimlane Turbine users to manage access revocation, workflow cancellations, label management, and user information retrieval directly within the security automation workflows. By integrating with Grip Security, users can streamline SaaS security operations, enforce compliance, and respond to incidents more efficiently, leveraging the extensive capabilities of the Swimlane Turbine platform.
Limitations
None to date.
Prerequisites
To effectively utilize the Grip Security connector within the Swimlane Turbine platform, ensure you have the following prerequisites in place:
- API Key Authentication with the following parameters:
- URL: The endpoint URL for the Grip Security API.
- Access Token: Your personal access token for authenticating API requests.
Capabilities
This Connector provides the following capabilities:
- Cancel Access Revocation
- Cancel Justification Request
- Cancel Workflow by Workflow Run ID
- Create Label
- Delete Label
- Delete User Label
- Get Access Revocation Status
- Get Alert
- Get Alert V2
- Get Justification Request Link
- Get Justification Request Status
- Get SaaS
- Get SaaS applications for user
- Get Saas ID
- Get Saas User ... and so on
Cancel Access Revocation
Stop the process of employee access revocation.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/7a10116c1a37d-cancel-access-revocation)
Cancel Justification Request
Cancels an open justification request. The request can be canceled using its unique request ID.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/0d815514796ab-cancel-justification-request)
Cancel Workflow by Workflow Run ID
Cancel a workflow run by the workflow run ID.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/ef1137e9ca34d-cancel-workflow-by-workflow-run-id)
Create Label
Creates Label for the given SAAS_ID.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/d97d503037a4b-create-label)
Delete Label
Deletes a specified label from a SaaS application within Grip Security using the saas_id and label provided.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/a414a861ee6ec-delete-label)
Delete a User Label
Delete a specific label from the user.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/dc4b00ba8344e-delete-a-user-label)
Get Access Revocation Status
Retrieve the result of a specific employee access revocation.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/4116f308ba4bb-get-access-revocation-status)
Get Alert
Retrieve the information of the alert with the matching alert ID.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/4100ffe50da66-get-alert)
Get Alert V2
Retrieve the information of the alert with the matching alert ID using V2 API.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/11b5aa1d646c0-get-alert)
Get Justification Request Link
Retrieve the link of the justification request.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/ae812b3bfcf6d-get-justification-request-link)
Get Justification Request Status
Retrieve the status of the justification request.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/d80b4bada6889-get-justification-request-status)
Get SaaS
Retrieve the information of the SaaS with the matching SaaS ID.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/1c66d637a4728-get-saa-s)
Get SaaS applications for User
Get SaaS applications for user
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/9a1cf7710431d-get-saa-s-applications-for-user)
Get SaaS ID
Retrieve the saas application id of a SaaS by it's name. The result will be in array, in case there is more than one SaaS with the same name.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/83c3c79bdb1bd-get-saas-id)
Get Saas User
Retrieve all the data on a specific saas application user.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/384a7a2971ba4-get-saas-user)
Get User
Retrieve the information of the user with the matching user mail.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/4930e3a1dbc52-get-user)
Get User ID
Retrieve the userID out of the user email address.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/9cbe8055b82d3-get-user-id)
Get Users For SaaS Application
Retrieve a list of all the users in a specific saas.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/df46c6db4c08c-get-users-for-saa-s-application)
List Alerts
Retrieve a list of alerts from the Grip system. The list is paginated using Query Parameters.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/8138dd5c78b18-list-alerts)
List Alerts V2
Retrieve a list of alerts from the Grip system using V2 API. The list is paginated using Query Parameters.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/38adfda2eca8e-list-alerts)
List Audit Logs
Retrieve a list of audit logs from the Grip system. The list is paginated using Query Parameters.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/1d5f8e825f9c4-list-audit-logs)
List Offboarding Workflows
Retrieve the results of all offboarding workflows.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/dc4d2e89e4a6d-list-offboarding-workflows)
List SaaS
Retrieve a list of all the SaaS in the organization, including organizational data and grip data. The list is paginated using Query Parameters.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/60dabc18f8891-list-saa-s)
List Users
Retrieve a list of all the users in the organization, including organizational data and grip data. The list is paginated using Query Parameters.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/7256414af9f9a-list-users)
Run Workflow By ID
Run a workflow for the workflow ID. Every workflow should contain at least one of the following - app_name / app_id in case of Application-based workflow,identity_email / identity_id in case of Identity-based workflow.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/07776a4d92de2-run-workflow-by-id)
Send Justification Request
Initiates a request for a user to justify their use of an application. The request can be sent to users identified by either user ID or email.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/dc6b0f9306561-send-justification-request)
Start Access Revocation
Start an employee access revocation task on specific employee for selected SaaS.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/a40d967e3147c-start-access-revocation)
Start Offboarding
Start an offboarding workflow for the specific users. Every workflow should contains Name, List of users ids, specified with their inheritor mailbox in case they are deactivated in the mail platform, Turn on enhanced mode if needed.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/b9e17bf2c6761-status-offboarding)
Status of a Workflow
Retrieve the status of a workflow.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/4c82cd4216645-status-of-a-workflow)
Status Offboarded User
Retrieve the status of an offboarding workflow, with results for supported applications.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/19bab44b151a4-status-offboarded-user)
Status Offboarding
Retrieves the status of an offboarding workflow.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/b9e17bf2c6761-status-offboarding)
Stop Offboarding
Stop the process of offboarding.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/bc2e9127270f0-stop-offboarding)
Update Primary Contact
Update primary contact of a specific saas.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/025a29d1acdcc-update-primary-contact)
Update Sanction Status
Updates the sanction state of a specified SaaS application based on the provided input.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/011ade02e2b98-update-sanction-status)
User Label
Add a label for a specific user id. If the specific label already exists in the env, it will add it to the user. If it doesn't it will create it and add it to the user.
Grip Security documentation for this action can be found [here] (https://apidocs.grip.security/docs/api-docs/95aea440bbf3e-user-label)
Additional Documentation
Configurations
API Key Authentication
Authenticates using an API Key
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
access-token | Access Token | string | Required |
Actions
Cancel Access Revocation
Halts the ongoing process of revoking an employee's access in Grip Security using a specified actionID.
Endpoint
- URL: /public/actions/accessRevocation/employee/stop
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
actionID | string | Optional | Unique identifier |
Input Example
{"json_body":{"actionID":"4a156b6a-0d73-4d7b-92f3-7bc07d13205f"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Cancel Justification Request
Cancels an existing justification request in Grip Security using a unique requestId.
Endpoint
- URL: /public/actions/justification/cancel
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
requestId | string | Optional | Unique identifier |
Input Example
{"json_body":{"requestId":"d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
requestId | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"requestId":"d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"}}
Cancel Workflow by Workflow Run ID
Cancels an ongoing workflow run in Grip Security using the provided workflow run ID.
Endpoint
- URL: workflows/{{workflow_run_id}}/cancel
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.workflow_run_id | string | Required | The ID of the workflow run to cancel. |
Input Example
{"path_parameters":{"workflow_run_id":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
message | string | Response message |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"message":"Workflow cancelled successfully"}}
Create Label
Generates a new label for a given SaaS ID within Grip Security, utilizing the 'label' data provided in the JSON body.
Endpoint
- URL: saas/{{saas_id}}/label
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.saas_id | string | Required | Parameters for the Create Label action |
label | string | Optional | Parameter for Create Label |
Input Example
{"json_body":{"label":""},"path_parameters":{"saas_id":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Delete Label
Removes a specific label from a SaaS application in Grip Security using the provided saas_id and label.
Endpoint
- URL: saas/{{saas_id}}/label
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.saas_id | string | Required | The ID of the SaaS application to delete the label from. |
label | string | Optional | The label to delete. |
Input Example
{"json_body":{"label":"alpha123"},"path_parameters":{"saas_id":"12345"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Delete User Label
Removes a specified label from a user in Grip Security by utilizing the user's ID and the label name.
Endpoint
- URL: users/{{user_id}}/label
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.user_id | string | Required | Parameters for the Delete User Label action |
label | string | Optional | Parameter for Delete User Label |
Input Example
{"json_body":{"label":""},"path_parameters":{"user_id":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
message | string | Response message |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"message":"string"}}
Get Access Revocation Status
Retrieve the revocation status for an employee's access in Grip Security by providing the action_id.
Endpoint
- URL: /public/actions/accessRevocation/employee/{{action_id}}/status
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.action_id | string | Required | Parameters for the Get Access Revocation Status action |
Input Example
{"path_parameters":{"action_id":"4a156b6a-0d73-4d7b-92f3-7bc07d13205f"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
actionID | string | Unique identifier |
status | string | Status value |
createdBy | string | Output field: createdBy |
startedAt | string | Output field: startedAt |
completedAt | string | Output field: completedAt |
userId | string | Unique identifier |
userMail | string | Output field: userMail |
userFullName | string | Name of the resource |
userDisplayName | string | Name of the resource |
details | string | Output field: details |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"actionID":"4a156b6a-0d73-4d7b-92f3-7bc07d13205f","status":"Completed","createdBy":"string","startedAt":"2019-08-24T14:15:22Z","completedAt":"2019-08-24T14:15:22Z","userId":"8e6afaf9-ce27-419e-bf33-4b02fc2e90ca","userMail":"string","userFullName":"string","userDisplayName":"string","details":"string"}}
Get Alert
Retrieve detailed information for a specific alert in Grip Security using the unique readable ID provided.
Endpoint
- URL: /public/alerts/{{alert_readable_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.alert_readable_id | string | Required | Parameters for the Get Alert action |
Input Example
{"path_parameters":{"alert_readable_id":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
alertId | string | Unique identifier |
alertType | string | Type of the resource |
alertSeverity | string | Output field: alertSeverity |
createdAt | string | Output field: createdAt |
updatedAt | string | Output field: updatedAt |
category | string | Output field: category |
uniqueFieldsData | object | Response data |
description | string | Output field: description |
mitigationSteps | object | Output field: mitigationSteps |
mitigationSteps.header | string | Output field: mitigationSteps.header |
mitigationSteps.steps | array | Output field: mitigationSteps.steps |
potentialImpacts | array | Output field: potentialImpacts |
relatedEntity | object | Output field: relatedEntity |
relatedEntity.id | string | Unique identifier |
relatedEntity.name | string | Name of the resource |
relatedEntity.email | string | Output field: relatedEntity.email |
relatedEntity.entityType | string | Type of the resource |
alertUrl | string | URL endpoint for the request |
status | string | Status value |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"alertId":"string","alertType":"string","alertSeverity":"string","createdAt":"string","updatedAt":"string","category":"string","uniqueFieldsData":{},"description":"string","mitigationSteps":{"header":"string","steps":[]},"potentialImpacts":["string"],"relatedEntity":{"id":"string","name":"string","email":"string","entityType":"identity"},"alertUrl":"string","status":"string"}}
Get Alert V2
Retrieve detailed information for a specific alert in Grip Security using the alert's readable ID.
Endpoint
- URL: /public/v2/alerts/{{alert_readable_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.alert_readable_id | string | Required | Parameters for the Get Alert V2 action |
Input Example
{"path_parameters":{"alert_readable_id":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
alertId | string | Unique identifier |
alertType | string | Type of the resource |
alertSeverity | string | Output field: alertSeverity |
createdAt | string | Output field: createdAt |
updatedAt | string | Output field: updatedAt |
category | string | Output field: category |
uniqueFieldsData | object | Response data |
description | string | Output field: description |
mitigationSteps | object | Output field: mitigationSteps |
mitigationSteps.header | string | Output field: mitigationSteps.header |
mitigationSteps.steps | array | Output field: mitigationSteps.steps |
potentialImpacts | array | Output field: potentialImpacts |
relatedEntity | object | Output field: relatedEntity |
relatedEntity.id | string | Unique identifier |
relatedEntity.name | string | Name of the resource |
relatedEntity.email | string | Output field: relatedEntity.email |
relatedEntity.entityType | string | Type of the resource |
alertUrl | string | URL endpoint for the request |
status | string | Status value |
alertName | string | Name of the resource |
policyReadableId | number | Unique identifier |
mitigationDescription | string | Output field: mitigationDescription |
relatedEntityId | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"alertId":"string","alertType":"string","alertSeverity":"string","createdAt":"string","updatedAt":"string","category":"string","uniqueFieldsData":{},"description":"string","mitigationSteps":{"header":"string","steps":[]},"potentialImpacts":["string"],"relatedEntity":{"id":"string","name":"string","email":"string","entityType":"identity"},"alertUrl":"string","status":"string","alertName":"string","policyReadableId":0}}
Get Justification Request Link
Retrieve a specific justification request link from Grip Security using the provided request ID.
Endpoint
- URL: /public/actions/justification/{{request_id}}/link
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | string | Required | Parameters for the Get Justification Request Link action |
Input Example
{"path_parameters":{"request_id":"d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":"string"}
Get Justification Request Status
Retrieve the current status of a justification request in Grip Security using the provided request ID.
Endpoint
- URL: /public/actions/justification/{{request_id}}/status
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.request_id | string | Required | Parameters for the Get Justification Request Status action |
Input Example
{"path_parameters":{"request_id":"d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
requestId | string | Unique identifier |
status | string | Status value |
createdBy | string | Output field: createdBy |
startedAt | string | Output field: startedAt |
completedAt | string | Output field: completedAt |
recipientName | string | Name of the resource |
recipientMail | string | Output field: recipientMail |
saasId | string | Unique identifier |
saasName | string | Name of the resource |
response | object | Output field: response |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"requestId":"d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6","status":"Sent","createdBy":"string","startedAt":"2019-08-24T14:15:22Z","completedAt":"2019-08-24T14:15:22Z","recipientName":"string","recipientMail":"string","saasId":"cb85d5df-47f3-4b28-b393-8104f184d6be","saasName":"string","response":{}}}
Get SaaS
Retrieves detailed information for a specific SaaS entry in Grip Security using the provided SaaS ID.
Endpoint
- URL: /saas/{{saas_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.saas_id | string | Required | Parameters for the Get SaaS action |
Input Example
{"path_parameters":{"saas_id":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | string | Unique identifier |
name | string | Name of the resource |
url | string | URL endpoint for the request |
logoUrl | string | URL endpoint for the request |
gripData | object | Response data |
gripData.numberOfUsers | number | Response data |
gripData.numberOfOnboardedUsers | number | Response data |
gripData.numberOfOffboardedUsers | number | Response data |
gripData.SSOPercentage | number | Response data |
gripData.accessRemovalSupport | string | Response data |
gripData.riskScore | number | Response data |
gripData.sanctionTag | string | Response data |
gripData.labels | array | Response data |
gripData.buisnessOwner | string | Response data |
gripData.category | string | Response data |
gripData.appInstancesCount | number | Response data |
gripData.sourcePlatforms | array | Response data |
gripData.lastKnownUsage | string | Response data |
gripData.assets | array | Response data |
gripData.compliances | array | Response data |
gripData.primaryContact | object | Response data |
gripData.primaryContact.email | string | Response data |
gripData.primaryContact.userId | string | Response data |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"string","url":"string","logoUrl":"string","gripData":{"numberOfUsers":0,"numberOfOnboardedUsers":0,"numberOfOffboardedUsers":0,"SSOPercentage":0,"accessRemovalSupport":"supported","riskScore":0,"sanctionTag":"sanctioned","labels":[],"buisnessOwner":"string","category":"string","appInstancesCount":0,"sourcePlatforms":[],"lastKnownUsage":"2019-08-24T14:15:22Z","assets":[],"compli...
Get SaaS applications for user
Retrieve a list of SaaS applications associated with a given user ID in Grip Security.
Endpoint
- URL: /users/{{user_id}}/saas
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.user_id | string | Required | Parameters for the Get SaaS applications for user action |
parameters.limit | number | Optional | Parameters for the Get SaaS applications for user action |
parameters.offset | number | Optional | Parameters for the Get SaaS applications for user action |
Input Example
{"parameters":{"limit":100,"offset":0},"path_parameters":{"user_id":"12345"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":[{"saas":{},"saasUser":{}}]}
Get Saas ID
Obtain a unique identifier for a specified SaaS application by its name within Grip Security.
Endpoint
- URL: /saas/{{saas_name}}/id
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.saas_name | string | Required | Parameters for the Get Saas ID action |
Input Example
{"path_parameters":{"saas_name":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]}
Get Saas User
Retrieves detailed information for a specific user within a SaaS application using the user's unique identifier.
Endpoint
- URL: saasUser/{{saas_app_user_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.saas_app_user_id | string | Required | The ID of the SaaS application user to retrieve the data for. |
Input Example
{"path_parameters":{"saas_app_user_id":"3a6aaaf9-ce37-423e-ba3a-4b02fc2e90ca"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get User
Retrieve detailed information for a specified user in Grip Security using the unique user ID provided as a path parameter.
Endpoint
- URL: /users/{{user_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.user_id | string | Required | Parameters for the Get User action |
Input Example
{"path_parameters":{"user_id":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | string | Unique identifier |
string | Output field: mail | |
aliases | array | Output field: aliases |
fullName | string | Name of the resource |
displayName | string | Name of the resource |
organizationalUnit | string | Output field: organizationalUnit |
managerEmail | string | Output field: managerEmail |
gripData | object | Response data |
gripData.numberOfSaas | string | Response data |
gripData.SSOPercentage | string | Response data |
gripData.activity | object | Response data |
gripData.activity.platformsActivity | array | Response data |
gripData.activity.platformsActivity.platform | string | Response data |
gripData.activity.platformsActivity.status | string | Response data |
gripData.activity.hasActiveMailbox | boolean | Response data |
gripData.labels | array | Response data |
gripData.firstEventTime | string | Response data |
gripData.latestEventTime | string | Response data |
gripData.lastUsage | string | Response data |
gripData.offboardingWorkflowStatus | string | Response data |
gripData.offboardingWorkflowTimestamp | string | Response data |
customFields | object | Output field: customFields |
type | string | Type of the resource |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":"8e6afaf9-ce27-419e-bf33-4b02fc2e90ca","mail":"[email protected]","aliases":["string"],"fullName":"Anonymous Anonymous","displayName":"string","organizationalUnit":"Marketing","managerEmail":"[email protected]","gripData":{"numberOfSaas":"5","SSOPercentage":"32","activity":{},"labels":[],"firstEventTime":"2019-08-24T14:15:22Z","latestEventTime":"2019-08-24T14:15:22Z","lastUsage":"2019-08-24T14:15:22Z","offboardingWo...
Get User ID
Obtain a user's unique ID from Grip Security using their email address as input.
Endpoint
- URL: /users/{{user_mail}}/id
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.user_mail | string | Required | Parameters for the Get User ID action |
Input Example
{"path_parameters":{"user_mail":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
userId | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"userId":"8e6afaf9-ce27-419e-bf33-4b02fc2e90ca"}}
Get Users For SaaS Application
Retrieves all users associated with a specific SaaS application using the provided saas_id parameter.
Endpoint
- URL: /saas/{{saas_id}}/users
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.saas_id | string | Required | Parameters for the Get Users For SaaS Application action |
Input Example
{"path_parameters":{"saas_id":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":[{"user":{},"saasUser":{}}]}
List Alerts
Retrieve a paginated list of alerts from the Grip Security system, utilizing query parameters for targeted results.
Endpoint
- URL: /public/alerts
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.alert_severity | number | Optional | Parameters for the List Alerts action |
parameters.alert_type | string | Optional | Parameters for the List Alerts action |
parameters.category | string | Optional | Parameters for the List Alerts action |
parameters.limit | number | Optional | Parameters for the List Alerts action |
parameters.offset | number | Optional | Parameters for the List Alerts action |
parameters.related_entity_id | string | Optional | Parameters for the List Alerts action |
parameters.related_entity_type | string | Optional | Parameters for the List Alerts action |
Input Example
{"parameters":{"alert_severity":0,"alert_type":"string","category":"string","limit":200,"offset":0,"related_entity_id":"string","related_entity_type":"identity"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"next":200,"prev":0},"reason":"OK","json_body":[{"alertId":"string","alertType":"string","alertSeverity":"string","createdAt":"string","updatedAt":"string","category":"string","uniqueFieldsData":{},"description":"string","mitigationSteps":{},"potentialImpacts":[],"relatedEntity":{},"alertUrl":"string","status":"string"}]}
List Alerts V2
Retrieve a paginated list of alerts from Grip Security using query parameters for targeted results.
Endpoint
- URL: /public/v2/alerts
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.alert_severity | number | Optional | Parameters for the List Alerts V2 action |
parameters.alert_type | string | Optional | Parameters for the List Alerts V2 action |
parameters.category | string | Optional | Parameters for the List Alerts V2 action |
parameters.limit | number | Optional | Parameters for the List Alerts V2 action |
parameters.offset | number | Optional | Parameters for the List Alerts V2 action |
parameters.related_entity_id | string | Optional | Parameters for the List Alerts V2 action |
parameters.related_entity_type | string | Optional | Parameters for the List Alerts V2 action |
Input Example
{"parameters":{"alert_severity":0,"alert_type":"string","category":"string","limit":200,"offset":0,"related_entity_id":"string","related_entity_type":"identity"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"next":200,"prev":0},"reason":"OK","json_body":[{"alertId":"string","alertType":"string","alertSeverity":"string","createdAt":"string","updatedAt":"string","category":"string","uniqueFieldsData":{},"description":"string","mitigationSteps":{},"potentialImpacts":[],"relatedEntity":{},"alertUrl":"string","status":"string","alertName":"string","policyReadableId":0}]}
List Audit Logs
Retrieve a paginated list of audit logs from the Grip Security system using Query Parameters.
Endpoint
- URL: audit-trail
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.limit | number | Optional | For pagination purposes. Will set the maximum amount of audit logs which will return from a single query. |
parameters.offset | number | Optional | For pagination purposes. Will get only audit logs after this offset. If there are 200 audit logs in a page, the offset for page 2 will be 200. |
Input Example
{"parameters":{"limit":100,"offset":0}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
List Offboarding Workflows
Retrieve the results of all offboarding workflows in Grip Security, providing a comprehensive overview.
Endpoint
- URL: workflows/offboarding
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.limit | number | Optional | For pagination purposes. Will set the maximum amount of workflows which will return from a single query. |
parameters.offset | number | Optional | For pagination purposes. Will get only workflows after this offset. If there are 200 workflows in a page, the offset for page 2 will be 200. |
Input Example
{"parameters":{"limit":100,"offset":0}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":[{"workflowId":"43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4","status":"Completed","createdBy":"string","startedAt":"2019-08-24T14:15:22Z","completedAt":"2019-08-24T14:15:22Z","workflowName":"22-11-10 15-52","numberOfEmployees":0}]}
List SaaS
Retrieve a paginated list of all SaaS applications within the organization, complete with relevant data.
Endpoint
- URL: /saas
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.limit | number | Optional | Parameters for the List SaaS action |
parameters.offset | number | Optional | Parameters for the List SaaS action |
Input Example
{"parameters":{"limit":100,"offset":0}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"string","url":"string","logoUrl":"string","gripData":{}}]}
List Users
Retrieve a comprehensive list of users, including both organizational and Grip Security-specific data.
Endpoint
- URL: /users
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.next | number | Optional | Parameters for the List Users action |
parameters.offset | number | Optional | Parameters for the List Users action |
Input Example
{"parameters":{"next":1,"offset":0}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":[{"id":"8e6afaf9-ce27-419e-bf33-4b02fc2e90ca","mail":"[email protected]","aliases":[],"fullName":"Anonymous Anonymous","displayName":"string","organizationalUnit":"Marketing","managerEmail":"[email protected]","gripData":{},"customFields":{},"type":"string"}]}
Run Workflow By ID
Executes a specified workflow in Grip Security using the workflow ID, applicable for both Application-based and Identity-based workflows.
Endpoint
- URL: workflows/{{workflow_id}}/run
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.workflow_id | string | Required | The ID of the workflow to run. |
identityEmail | array | Optional | The identities email in Grip's identity profile page. This field should be selected if the workflow entity is 'Identity', it is preferable to enter identity_id than identity_email. This value can get list. |
identityId | array | Optional | The identities id in Grip. It can be copied from the URL path of the identity's profile page in Grip. This field should be selected if the workflow entity is 'Identity', this field is preferable to enter when using this type of workflow. This value can get list. |
appName | array | Optional | The application name in Grip's app portfolio page. This field should be selected if the workflow entity is 'App', it is preferable to enter app_id than app_name. This value can get list. |
appId | array | Optional | The application id in Grip. It can be copied from the URL path of the app's portfolio page in Grip. This field should be selected if the workflow entity is 'App', this field is preferable to enter when using this type of workflow. This value can get list. |
inheritorEmail | string | Optional | The inheritor email for the given users. This field is relevant only for identity values, and should be filled only if the users' mailbox is inactive. |
Input Example
{"json_body":{"identityEmail":["[email protected]"],"identityId":["43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4"],"appName":["Test App"],"appId":["43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4"],"inheritorEmail":"[email protected]"},"path_parameters":{"workflow_id":"43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
workflowRunIds | object | Unique identifier |
workflowRunIds.property1 | string | Unique identifier |
workflowRunIds.property2 | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"workflowRunIds":{"property1":"497f6eca-6276-4993-bfeb-53cbbbba6f08","property2":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}}}
Send Justification Request
Initiates a justification request for a user's use of a specified SaaS application in Grip Security, requiring a saasApplicationId.
Endpoint
- URL: /public/actions/justification/send
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
userId | string | Optional | Unique identifier |
userEmail | string | Optional | Parameter for Send Justification Request |
saasApplicationId | string | Optional | Unique identifier |
communicationPlatform | string | Optional | Parameter for Send Justification Request |
Input Example
{"json_body":{"userId":"2c4a230c-5085-4924-a3e1-25fb4fc5965b","userEmail":"string","saasApplicationId":"86f9ba57-2da9-42da-8118-7ec1d4cc813c","communicationPlatform":"Email"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
requestId | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"requestId":"d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"}}
Start Access Revocation
Initiates the revocation of a specified employee's access across selected SaaS applications, requiring userId and saasIds.
Endpoint
- URL: /public/actions/accessRevocation/employee/start
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
userId | string | Optional | Unique identifier |
saasIds | array | Optional | Unique identifier |
inheritorMailbox | string | Optional | Parameter for Start Access Revocation |
managerApprovalEmail | string | Optional | Parameter for Start Access Revocation |
Input Example
{"json_body":{"userId":"2c4a230c-5085-4924-a3e1-25fb4fc5965b","saasIds":["497f6eca-6276-4993-bfeb-53cbbbba6f08"],"inheritorMailbox":"[email protected]","managerApprovalEmail":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
actionID | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"actionID":"4a156b6a-0d73-4d7b-92f3-7bc07d13205f"}}
Start Offboarding
Initiates an offboarding workflow in Grip Security for specified users, including user IDs, inheritor mailboxes, and enhanced mode options.
Endpoint
- URL: workflows/offboarding/start
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
usersToOffboard | array | Optional | Parameter for Start Offboarding |
usersToOffboard.userId | string | Optional | The ID of the user in Grip system. The userId is the base for every API query. Either the userId or the userEmail field is required. |
usersToOffboard.inheritorMailbox | string | Optional | The inheritor mail address, in case the user is inactive. Default is User's original mailbox. |
usersToOffboard.userEmail | string | Optional | The email address of the user in Grip system. Either the userEmail or the userId field is required. |
enableEnhancedMode | boolean | Optional | True if the user wants to run the offboarding on enhanced-mode applications. False if not. |
workflowName | string | Optional | The name of the workflow in Grip. This field can be chosen by the user, and it is not mandatory. |
Input Example
{"json_body":{"usersToOffboard":[{"userId":"8e6afaf9-ce27-419e-bf33-4b02fc2e90ca","inheritorMailbox":"[email protected]","userEmail":"[email protected]"}],"enableEnhancedMode":false,"workflowName":"22-11-10 15-52"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
workflowId | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"workflowId":"43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4"}}
Status of a Workflow
Retrieve the current status of a specified workflow in Grip Security using the workflow_id.
Endpoint
- URL: workflows/{{workflow_id}}/status
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.workflow_id | string | Required | The ID of the workflow to retrieve the status for. |
Input Example
{"path_parameters":{"workflow_id":"12345"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
status | string | Status value |
statusDetails | string | Status value |
createdAt | string | Output field: createdAt |
completedAt | string | Output field: completedAt |
actions | array | Output field: actions |
actions.actionName | string | Name of the resource |
actions.status | string | Status value |
actions.selfUrl | string | URL endpoint for the request |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"status":"Completed","statusDetails":"This is a test status details","createdAt":"2019-08-24T14:15:22Z","completedAt":"2019-08-24T14:15:22Z","actions":[{}]}}
Status Offboarded User
Retrieve the offboarding workflow status for a user in Grip Security using the specified workflow ID.
Endpoint
- URL: workflows/offboarding/{{workflow_id}}/userstatus
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.workflow_id | string | Required | The ID of the workflow to retrieve the status for. |
Input Example
{"path_parameters":{"workflow_id":"cb85d5df-47f3-4b28-b393-8104f184d6be"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
userMail | string | Output field: userMail |
userFullName | string | Name of the resource |
status | string | Status value |
startedAt | string | Output field: startedAt |
completedAt | string | Output field: completedAt |
results | object | Result of the operation |
results.supportedForAccessRemoval | array | Result of the operation |
results.supportedForAccessRemoval.saasId | string | Unique identifier |
results.supportedForAccessRemoval.saasName | string | Name of the resource |
results.supportedForAccessRemoval.accessRemovalResult | string | Result of the operation |
results.unsupportedForAccessRemoval | array | Result of the operation |
results.unsupportedForAccessRemoval.saasId | string | Unique identifier |
results.unsupportedForAccessRemoval.saasName | string | Name of the resource |
results.idpConnected | array | Unique identifier |
results.idpConnected.saasId | string | Unique identifier |
results.idpConnected.saasName | string | Unique identifier |
results.idpConnected.idpProvider | string | Unique identifier |
results.idpConnected.autType | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"userMail":"[email protected]","userFullName":"Test User","status":"In Progress","startedAt":"2019-08-24T14:15:22Z","completedAt":"2019-08-24T14:15:22Z","results":{"supportedForAccessRemoval":[],"unsupportedForAccessRemoval":[],"idpConnected":[]}}}
Status Offboarding
Retrieves the current status of a specified offboarding workflow in Grip Security using the workflow_id.
Endpoint
- URL: workflows/offboarding/{{workflow_id}}/status
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.workflow_id | string | Required | The ID of the workflow to retrieve the status for. |
Input Example
{"path_parameters":{"workflow_id":"43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
workflowId | string | Unique identifier |
status | string | Status value |
createdBy | string | Output field: createdBy |
startedAt | string | Output field: startedAt |
completedAt | string | Output field: completedAt |
workflowName | string | Name of the resource |
numberOfEmployees | number | Output field: numberOfEmployees |
results | array | Result of the operation |
results.userMail | string | Result of the operation |
results.userFullName | string | Name of the resource |
results.userDisplayName | string | Name of the resource |
results.status | string | Status value |
results.statusReason | string | Status value |
results.saasResults | array | Result of the operation |
results.saasResults.saasId | string | Unique identifier |
results.saasResults.saasName | string | Name of the resource |
results.saasResults.saasUserId | string | Unique identifier |
results.saasResults.enhancedMode | boolean | Result of the operation |
results.saasResults.result | string | Result of the operation |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"workflowId":"43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4","status":"Completed","createdBy":"string","startedAt":"2019-08-24T14:15:22Z","completedAt":"2019-08-24T14:15:22Z","workflowName":"22-11-10 15-52","numberOfEmployees":0,"results":[{}]}}
Stop Offboarding
Terminate an ongoing offboarding process in Grip Security using the specified workflow ID.
Endpoint
- URL: workflows/offboarding/stop
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
workflowId | string | Optional | The ID of the workflow to stop. |
Input Example
{"json_body":{"workflowId":"43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Update Primary Contact
Updates the primary contact for a specified SaaS using saas_id and user_id as identifiers.
Endpoint
- URL: saas/{{saas_id}}/update-primary-contact
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.user_id | string | Required | The ID of the user to update the primary contact for. |
path_parameters.saas_id | string | Required | The ID of the SaaS application to update the primary contact for. |
Input Example
{"parameters":{"user_id":"12345"},"path_parameters":{"saas_id":"12345"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Update Sanction Status
Updates the sanction state of a specified SaaS application in Grip Security using the provided saas_id and new_sanction_state.
Endpoint
- URL: saas/{{saas_id}}/sanction_status
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.comment | string | Optional | The comment to update the sanction status for. |
parameters.user_email | string | Optional | If not received it will be the token name. |
parameters.new_sanction_state | string | Required | The new sanction state to update the sanction status for. |
path_parameters.saas_id | string | Required | The ID of the SaaS application to update the sanction status for. |
Input Example
{"parameters":{"comment":"This is a test comment","user_email":"[email protected]","new_sanction_state":"Sanctioned"},"path_parameters":{"saas_id":"12345","user_email":"[email protected]"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
User Label
Adds or updates a user's label in Grip Security using the specified user ID and label data.
Endpoint
- URL: /users/{{user_id}}/label
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.user_id | string | Required | Parameters for the User Label action |
headers | object | Optional | HTTP headers for the request |
headers.Content-Type | string | Optional | HTTP headers for the request |
label | string | Optional | Parameter for User Label |
Input Example
{"json_body":{"label":"alpha123"},"path_parameters":{"user_id":"12345"},"headers":{"Content-Type":"application/json"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
message | string | Response message |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"message":"string"}}
Response Headers
Header | Description | Example |
|---|---|---|
next | HTTP response header: next | 200 |
prev | HTTP response header: prev | 0 |