Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

ComplianceControlsApi.md

Latest commit

 

History

History
165 lines (114 loc) · 7.5 KB

ComplianceControlsApi.md

File metadata and controls

165 lines (114 loc) · 7.5 KB

esp_sdk.ComplianceControlsApi

All URIs are relative to https://api.evident.io

Method HTTP request Description
list PUT /api/v2/compliance_controls.json_api Get a list of Compliance Controls
list_signatures GET /api/v2/compliance_controls/{compliance_control_id}/signatures.json_api Get a list of Signatures for a Compliance Control
show GET /api/v2/compliance_controls/{id}.json_api Show a single Compliance Control

list

PaginatedCollection list(include=include, filter=filter, page=page)

Get a list of Compliance Controls

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.ComplianceControlsApi()
include = 'include_example' # str | Related objects that can be included in the response:  compliance_standard, compliance_domain, signatures See Including Objects for more information. (optional)
filter = {'key': 'filter_example'} # dict(str, str) | Filter Params for Searching.  Equality Searchable Attributes: [id, identifier, name] Matching Searchable Attributes: [identifier, name]  Sortable Attributes: [id, identifier, name, position] Searchable Associations: [compliance_standard, compliance_domain] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information. (optional)
page = '{:number=>1,+:size=>20}' # str | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page. (optional) (default to {:number=>1,+:size=>20})

try: 
    # Get a list of Compliance Controls
    api_response = api_instance.list(include=include, filter=filter, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComplianceControlsApi->list: %s\n" % e)

Parameters

Name Type Description Notes
include str Related objects that can be included in the response: compliance_standard, compliance_domain, signatures See Including Objects for more information. [optional]
filter dict(str, str) Filter Params for Searching. Equality Searchable Attributes: [id, identifier, name] Matching Searchable Attributes: [identifier, name] Sortable Attributes: [id, identifier, name, position] Searchable Associations: [compliance_standard, compliance_domain] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information. [optional]
page str Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_signatures

PaginatedCollection list_signatures(compliance_control_id, include=include, page=page)

Get a list of Signatures for a Compliance Control

The compliance standard must be paid for to view signatures for a control on that standard.

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.ComplianceControlsApi()
compliance_control_id = 56 # int | The ID of the Compliance Control this signature belongs to
include = 'include_example' # str | Related objects that can be included in the response:  service, suppressions See Including Objects for more information. (optional)
page = '{:number=>1,+:size=>20}' # str | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page. (optional) (default to {:number=>1,+:size=>20})

try: 
    # Get a list of Signatures for a Compliance Control
    api_response = api_instance.list_signatures(compliance_control_id, include=include, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComplianceControlsApi->list_signatures: %s\n" % e)

Parameters

Name Type Description Notes
compliance_control_id int The ID of the Compliance Control this signature belongs to
include str Related objects that can be included in the response: service, suppressions See Including Objects for more information. [optional]
page str Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

show

ComplianceControl show(id, include=include)

Show a single Compliance Control

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.ComplianceControlsApi()
id = 56 # int | Compliance Control ID
include = 'include_example' # str | Related objects that can be included in the response:  compliance_standard, compliance_domain, signatures See Including Objects for more information. (optional)

try: 
    # Show a single Compliance Control
    api_response = api_instance.show(id, include=include)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComplianceControlsApi->show: %s\n" % e)

Parameters

Name Type Description Notes
id int Compliance Control ID
include str Related objects that can be included in the response: compliance_standard, compliance_domain, signatures See Including Objects for more information. [optional]

Return type

ComplianceControl

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]