Filter by keyword

Security Information Actions

On This Page

    Security Information actions that can be performed by Jira users.

    Each action is optional (unless indicated otherwise). The absence of an action indicates that the action is not supported by the provider.

    Properties

    fetchContainers
    Type
    object
    Required
    		Yes
    Description

    Action for fetching security containers by IDs.

    Example request

    The templateUrl property of this action will receive a POST request when this action is invoked. The container IDs to be fetched will be included in the body.

    1 2 3 4 5 { "ids": ["XXXX", "YYYY"] }

    Example response

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
    
 {
   "containers": [
     {
       // Identifier of the security container which will be used to hydrate container details. This should be in this regex format: [a-zA-Z0-9\\-_.~@:{}=]+(/[a-zA-Z0-9\\-_.~@:{}=]+)*.
       id: "f730ce9c-3442-4f8a-93a4-a44f3b35c46b/target/111-222-333",
       // Human readable name of the container
       name: "my-container-name",
       // Url allowing Jira to link directly to the provider's container
       url: "https://my.security.provider.com/f730ce9c-3442-4f8a-93a4-a44f3b35c46b/container/f730ce9c-3442-4f8a-93a4-a44f3b35c46b",
       // Url providing the avatar for the container.
       avatarUrl: "https://res.cloudinary.com/snyk/image/upload/v1584038122/groups/Atlassian_Logo.png",
       // The date and time this container was last scanned/updated
       lastUpdatedDate: "2022-01-19T23:27:25+00:00"
     }
   ]
 }

    Properties

    templateUrl
    Type
    string
    Format
    uri-template
    Required
    		Yes
    fetchWorkspaces
    Type
    object
    Required
    		Yes
    Description

    Action for fetching security workspaces by IDs.

    Example request

    The templateUrl property of this action will receive a POST request when this action is invoked. The workspace IDs to be fetched will be included in the body.

    1
2
3
4
5
    
 {
   "ids": ["XXXX", "YYYY"]
 }

    Example response

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
    
 {
   "workspaces": [
     {
       // Identifier of the security workspace which will be used to hydrate workspace details
       id: "f730ce9c-3442-4f8a-93a4-a44f3b35c46b"
       // Human readable name of the workspace
       name: "economy-security-scanning"
       // Url allowing Jira to link directly to the provider's workspace
       url: "https://my.security.provider.com/org/f730ce9c-3442-4f8a-93a4-a44f3b35c46b"
       // Url providing the avatar for the workspace.
       avatarUrl: "https://res.cloudinary.com/snyk/image/upload/v1584038122/groups/Atlassian_Logo.png"
     }
   ]
 }

    Properties

    templateUrl
    Type
    string
    Format
    uri-template
    Required
    		Yes
    searchContainers
    Type
    object
    Required
    		Yes
    Description

    Action for showing any partial or full matches using a search on the security container name for a given workspace.

    Example request

    The templateUrl property of this action will receive a GET request with workspaceId and searchQuery query params when this action is invoked.

    1
2
3
    
 "https://my.security.provider.com/containers/search?workspaceId=12345&searchQuery=my-container-name"

    Example response

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
    
 {
   "containers": [
     {
       // Identifier of the security container which will be used to hydrate container details. This should be in this regex format: [a-zA-Z0-9\\-_.~@:{}=]+(/[a-zA-Z0-9\\-_.~@:{}=]+)*.
       id: "f730ce9c-3442-4f8a-93a4-a44f3b35c46b/target/111-222-333",
       // Human readable name of the container
       name: "my-container-name",
       // Url allowing Jira to link directly to the provider's container
       url: "https://my.security.provider.com/f730ce9c-3442-4f8a-93a4-a44f3b35c46b/container/f730ce9c-3442-4f8a-93a4-a44f3b35c46b",
       // Url providing the avatar for the container.
       avatarUrl: "https://res.cloudinary.com/snyk/image/upload/v1584038122/groups/Atlassian_Logo.png",
       // The date and time this container was last scanned/updated
       lastUpdatedDate: "2022-01-19T23:27:25+00:00"
     }
   ]

    Properties

    templateUrl
    Type
    string
    Format
    uri-template
    Required
    		Yes
    onEntityAssociated
    Type
    object
    Description

    Action to notify the security provider when vulnerability has been associated with jira issue

    Example request

    The templateUrl property of this action will receive a PUT request when this action is invoked. The entity.id is the providers external ID

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
    
 {
   "entity": {
     // This is vulnerability Atlassian Resource Identifier (ARI). This should be in format: ari:cloud:jira:{siteId}:vulnerability/activation/{activationId}/{vulnerabilityId}
     "ari": "ari:cloud:jira:f730ce9c-3442-4f8a-93a4-a44f3b35c46b:vulnerability/activation/111-222-333/111111",
     // This is vulnerability identifier provided by the provider
     "id": "1234"
   },
   "associatedWith": {
     // This is jira issue Atlassian Type Identifier (ATI)
     "ati": "ati:cloud:jira:issue",
     // This is jira issue Atlassian Resource Identifier (ARI) that get associated with the vulnerability. This should be in format: ari:cloud:jira:{siteId}:issue/{issueId}
     "ari": "ari:cloud:jira:f730ce9c-3442-4f8a-93a4-a44f3b35c46b:issue/1234"
     // This is the siteId
     "cloudId": "f730ce9c-3442-4f8a-93a4-a44f3b35c46b",
     // This is jira issue identifier
     "id": "1234"
   }
 }

    Properties

    templateUrl
    Type
    string
    Format
    uri-template
    Required
    		Yes
    onEntityDisassociated
    Type
    object
    Description

    Action to notify the security provider when vulnerability has its association removed from jira issue

    Example request

    The templateUrl property of this action will receive a PUT request when this action is invoked. The entity.id is the providers external ID

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
    
 {
   "entity": {
     // This is vulnerability Atlassian Resource Identifier (ARI). This should be in format: ari:cloud:jira:{siteId}:vulnerability/activation/{activationId}/{vulnerabilityId}
     "ari": "ari:cloud:jira:f730ce9c-3442-4f8a-93a4-a44f3b35c46b:vulnerability/activation/111-222-333/111111",
     // This is vulnerability identifier provided by the provider
     "id": "1234"
   },
   "disassociatedFrom": {
     // This is jira issue Atlassian Type Identifier (ATI)
     "ati": "ati:cloud:jira:issue",
     // This is jira issue Atlassian Resource Identifier (ARI) get disassociated from the vulnerability. This should be in format: ari:cloud:jira:{siteId}:issue/{issueId}
     "ari": "ari:cloud:jira:f730ce9c-3442-4f8a-93a4-a44f3b35c46b:issue/1234"
     // This is the siteId
     "cloudId": "f730ce9c-3442-4f8a-93a4-a44f3b35c46b",
     // This is jira issue identifier
     "id": "1234"
   }
 }

    Properties

    templateUrl
    Type
    string
    Format
    uri-template
    Required
    		Yes

    Rate this page: