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

ExternalAccountsApi.md

Latest commit

 

History

History
596 lines (412 loc) · 25.1 KB

ExternalAccountsApi.md

File metadata and controls

596 lines (412 loc) · 25.1 KB

ExternalAccountsApi

All URIs are relative to http://localhost/

Method HTTP request Description
addComplianceStandard POST api/v2/external_accounts/{external_account_id}/compliance_standards.json_api Add a compliance standard to an external account
addCustomComplianceStandard POST api/v2/external_accounts/{external_account_id}/custom_compliance_standards.json_api Add a custom compliance standard to an external account
addDisabledSignature POST api/v2/external_accounts/disabled_signatures.json_api Disable a set of signatures for an external account or a set of external accounts for a signature
delete DELETE api/v2/external_accounts/{id}.json_api Delete a(n) External Account
list PUT api/v2/external_accounts.json_api Get a list of External Accounts
listComplianceStandards GET api/v2/external_accounts/{external_account_id}/compliance_standards.json_api Get a list of compliance standards for an external account
listCustomComplianceStandards GET api/v2/external_accounts/{external_account_id}/custom_compliance_standards.json_api Get a list of custom compliance standards for an external account
listDisabledSignatures PUT api/v2/external_accounts/{external_account_id}/disabled_signatures.json_api Get a list all the disabled signatures for an external account
removeComplianceStandard DELETE api/v2/external_accounts/{external_account_id}/compliance_standards/{compliance_standard_id}.json_api Remove a compliance standard from an external account
removeCustomComplianceStandard DELETE api/v2/external_accounts/{external_account_id}/custom_compliance_standards/{custom_compliance_standard_id}.json_api Remove a custom compliance standard from an external account
removeDisabledSignature DELETE api/v2/external_accounts/disabled_signatures.json_api Re-enable a set of signatures for an external account or a set of external accounts for a signature
show GET api/v2/external_accounts/{id}.json_api Show a single External Account

addComplianceStandard

ComplianceStandard addComplianceStandard(externalAccountId, complianceStandardId, include)

Add a compliance standard to an external account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account this compliance standard belongs to
Integer complianceStandardId = 56; // Integer | The ID of the compliance standard that belongs to this external account
String include = "include_example"; // String | Related objects that can be included in the response:  compliance_domains, compliance_controls See Including Objects for more information.
try {
    ComplianceStandard result = apiInstance.addComplianceStandard(externalAccountId, complianceStandardId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#addComplianceStandard");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account this compliance standard belongs to
complianceStandardId Integer The ID of the compliance standard that belongs to this external account
include String Related objects that can be included in the response: compliance_domains, compliance_controls See Including Objects for more information. [optional]

Return type

ComplianceStandard

Authorization

No authorization required

HTTP request headers

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

addCustomComplianceStandard

Meta addCustomComplianceStandard(externalAccountId, customComplianceStandardId)

Add a custom compliance standard to an external account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account this custom compliance standard belongs to
Integer customComplianceStandardId = 56; // Integer | The ID of the custom compliance standard that belongs to this external account
try {
    Meta result = apiInstance.addCustomComplianceStandard(externalAccountId, customComplianceStandardId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#addCustomComplianceStandard");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account this custom compliance standard belongs to
customComplianceStandardId Integer The ID of the custom compliance standard that belongs to this external account

Return type

Meta

Authorization

No authorization required

HTTP request headers

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

addDisabledSignature

Signature addDisabledSignature(externalAccountIds, signatureIds, include)

Disable a set of signatures for an external account or a set of external accounts for a signature

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
List<Integer> externalAccountIds = Arrays.asList(56); // List<Integer> | The IDs of the external_account(s) to disable
List<Integer> signatureIds = Arrays.asList(56); // List<Integer> | The IDs of the signature(s) to disable
String include = "include_example"; // String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
try {
    Signature result = apiInstance.addDisabledSignature(externalAccountIds, signatureIds, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#addDisabledSignature");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountIds List<Integer> The IDs of the external_account(s) to disable
signatureIds List<Integer> The IDs of the signature(s) to disable
include String Related objects that can be included in the response: service, suppressions See Including Objects for more information. [optional]

Return type

Signature

Authorization

No authorization required

HTTP request headers

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

delete

Meta delete(id)

Delete a(n) External Account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
Integer id = 56; // Integer | External Account ID
try {
    Meta result = apiInstance.delete(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#delete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer External Account ID

Return type

Meta

Authorization

No authorization required

HTTP request headers

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

list

PaginatedCollection list(include, filter, page)

Get a list of External Accounts

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
String include = "include_example"; // String | Related objects that can be included in the response:  organization, sub_organization, team, scan_intervals, disabled_signatures, suppressions, azure_group See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, nickname, name] Matching Searchable Attributes: [nickname, name] Limited Searchable Attributes: [account_eq, arn_eq, provider_eq, subscription_id_eq] Sortable Attributes: [name, updated_at, created_at, id] Searchable Associations: [organization, sub_organization, team, azure_group, compliance_standards, disabled_signatures, integrations, scheduled_exports, suppressions] 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.
String page = "{:number=>1,+:size=>20}"; // String | 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.
try {
    PaginatedCollection result = apiInstance.list(include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#list");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
include String Related objects that can be included in the response: organization, sub_organization, team, scan_intervals, disabled_signatures, suppressions, azure_group See Including Objects for more information. [optional]
filter Map<String, String> Filter Params for Searching. Equality Searchable Attributes: [id, nickname, name] Matching Searchable Attributes: [nickname, name] Limited Searchable Attributes: [account_eq, arn_eq, provider_eq, subscription_id_eq] Sortable Attributes: [name, updated_at, created_at, id] Searchable Associations: [organization, sub_organization, team, azure_group, compliance_standards, disabled_signatures, integrations, scheduled_exports, suppressions] 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 String 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

No authorization required

HTTP request headers

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

listComplianceStandards

PaginatedCollection listComplianceStandards(externalAccountId, include, page)

Get a list of compliance standards for an external account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account this compliance standard belongs to
String include = "include_example"; // String | Related objects that can be included in the response:  compliance_domains, compliance_controls See Including Objects for more information.
String page = "{:number=>1,+:size=>20}"; // String | 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.
try {
    PaginatedCollection result = apiInstance.listComplianceStandards(externalAccountId, include, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#listComplianceStandards");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account this compliance standard belongs to
include String Related objects that can be included in the response: compliance_domains, compliance_controls See Including Objects for more information. [optional]
page String 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

No authorization required

HTTP request headers

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

listCustomComplianceStandards

PaginatedCollection listCustomComplianceStandards(externalAccountId, include, page)

Get a list of custom compliance standards for an external account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account this custom compliance standard belongs to
String include = "include_example"; // String | Related objects that can be included in the response:  custom_compliance_domains, custom_compliance_controls See Including Objects for more information.
String page = "{:number=>1,+:size=>20}"; // String | 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.
try {
    PaginatedCollection result = apiInstance.listCustomComplianceStandards(externalAccountId, include, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#listCustomComplianceStandards");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account this custom compliance standard belongs to
include String Related objects that can be included in the response: custom_compliance_domains, custom_compliance_controls See Including Objects for more information. [optional]
page String 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

No authorization required

HTTP request headers

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

listDisabledSignatures

PaginatedCollection listDisabledSignatures(externalAccountId, include, filter, page)

Get a list all the disabled signatures for an external account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account to retrieve the disabled signatures for
String include = "include_example"; // String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, risk_level, service_id, disabled, supports_user_attribution, name, identifier, description, resolution] Matching Searchable Attributes: [name, identifier, description, resolution] Limited Searchable Attributes: [service_provider_eq, service_provider_in, service_name_in] Sortable Attributes: [name, identifier, updated_at, created_at, id] Searchable Associations: [signature_copy, disabled_external_accounts, integrations, suppressions] 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.
String page = "{:number=>1,+:size=>20}"; // String | 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.
try {
    PaginatedCollection result = apiInstance.listDisabledSignatures(externalAccountId, include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#listDisabledSignatures");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account to retrieve the disabled signatures for
include String Related objects that can be included in the response: service, suppressions See Including Objects for more information. [optional]
filter Map<String, String> Filter Params for Searching. Equality Searchable Attributes: [id, risk_level, service_id, disabled, supports_user_attribution, name, identifier, description, resolution] Matching Searchable Attributes: [name, identifier, description, resolution] Limited Searchable Attributes: [service_provider_eq, service_provider_in, service_name_in] Sortable Attributes: [name, identifier, updated_at, created_at, id] Searchable Associations: [signature_copy, disabled_external_accounts, integrations, suppressions] 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 String 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

No authorization required

HTTP request headers

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

removeComplianceStandard

Meta removeComplianceStandard(externalAccountId, complianceStandardId)

Remove a compliance standard from an external account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account this compliance standard belongs to
Integer complianceStandardId = 56; // Integer | The ID of the compliance standard that belongs to this external account
try {
    Meta result = apiInstance.removeComplianceStandard(externalAccountId, complianceStandardId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#removeComplianceStandard");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account this compliance standard belongs to
complianceStandardId Integer The ID of the compliance standard that belongs to this external account

Return type

Meta

Authorization

No authorization required

HTTP request headers

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

removeCustomComplianceStandard

Meta removeCustomComplianceStandard(externalAccountId, customComplianceStandardId)

Remove a custom compliance standard from an external account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account this custom compliance standard belongs to
Integer customComplianceStandardId = 56; // Integer | The ID of the custom compliance standard that belongs to this external account
try {
    Meta result = apiInstance.removeCustomComplianceStandard(externalAccountId, customComplianceStandardId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#removeCustomComplianceStandard");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account this custom compliance standard belongs to
customComplianceStandardId Integer The ID of the custom compliance standard that belongs to this external account

Return type

Meta

Authorization

No authorization required

HTTP request headers

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

removeDisabledSignature

Meta removeDisabledSignature(externalAccountIds, signatureIds)

Re-enable a set of signatures for an external account or a set of external accounts for a signature

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
List<Integer> externalAccountIds = Arrays.asList(56); // List<Integer> | The IDs of the external_account(s) to enable
List<Integer> signatureIds = Arrays.asList(56); // List<Integer> | The IDs of the signature(s) to enable
try {
    Meta result = apiInstance.removeDisabledSignature(externalAccountIds, signatureIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#removeDisabledSignature");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountIds List<Integer> The IDs of the external_account(s) to enable
signatureIds List<Integer> The IDs of the signature(s) to enable

Return type

Meta

Authorization

No authorization required

HTTP request headers

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

show

ExternalAccount show(id, include)

Show a single External Account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsApi;


ExternalAccountsApi apiInstance = new ExternalAccountsApi();
Integer id = 56; // Integer | External Account ID
String include = "include_example"; // String | Related objects that can be included in the response:  organization, sub_organization, team, scan_intervals, disabled_signatures, suppressions, azure_group See Including Objects for more information.
try {
    ExternalAccount result = apiInstance.show(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsApi#show");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer External Account ID
include String Related objects that can be included in the response: organization, sub_organization, team, scan_intervals, disabled_signatures, suppressions, azure_group See Including Objects for more information. [optional]

Return type

ExternalAccount

Authorization

No authorization required

HTTP request headers

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