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

UserAttributionsApi.md

Latest commit

 

History

History
196 lines (134 loc) · 6.43 KB

UserAttributionsApi.md

File metadata and controls

196 lines (134 loc) · 6.43 KB

UserAttributionsApi

All URIs are relative to http://localhost/

Method HTTP request Description
addChannel POST api/v2/external_accounts/{external_account_id}/user_attribution/channel.json_api Create a User Attribution Channel for an external account
removeChannel DELETE api/v2/external_accounts/{external_account_id}/user_attribution/channel.json_api Remove the User Attribution Channel for an external account
showChannel GET api/v2/external_accounts/{external_account_id}/user_attribution/channel.json_api Show the User Attribution Channel of an external account
update PATCH api/v2/external_accounts/{external_account_id}/user_attribution.json_api Update the user attributions on an external account

addChannel

ExternalAccountUserAttributionChannel addChannel(externalAccountId)

Create a User Attribution Channel for an external account

URL will only be returned in this response and will not be accessible again.

Example

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


UserAttributionsApi apiInstance = new UserAttributionsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account to create a User Attribution Channel for
try {
    ExternalAccountUserAttributionChannel result = apiInstance.addChannel(externalAccountId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserAttributionsApi#addChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account to create a User Attribution Channel for

Return type

ExternalAccountUserAttributionChannel

Authorization

No authorization required

HTTP request headers

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

removeChannel

Meta removeChannel(externalAccountId)

Remove the User Attribution Channel for an external account

Example

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


UserAttributionsApi apiInstance = new UserAttributionsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account to remove the User Attribution Channel from
try {
    Meta result = apiInstance.removeChannel(externalAccountId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserAttributionsApi#removeChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account to remove the User Attribution Channel from

Return type

Meta

Authorization

No authorization required

HTTP request headers

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

showChannel

ExternalAccountUserAttributionChannel showChannel(externalAccountId)

Show the User Attribution Channel of an external account

The channel url will not be returned.

Example

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


UserAttributionsApi apiInstance = new UserAttributionsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account to show the user attribution channel for
try {
    ExternalAccountUserAttributionChannel result = apiInstance.showChannel(externalAccountId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserAttributionsApi#showChannel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account to show the user attribution channel for

Return type

ExternalAccountUserAttributionChannel

Authorization

No authorization required

HTTP request headers

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

update

ExternalAccount update(externalAccountId, include, cloudtrailName)

Update the user attributions on an external account

Example

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


UserAttributionsApi apiInstance = new UserAttributionsApi();
Integer externalAccountId = 56; // Integer | The ID of the external account to update the user attributions of
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.
String cloudtrailName = "cloudtrailName_example"; // String | The name of the cloudetrail associated with the user attribution.
try {
    ExternalAccount result = apiInstance.update(externalAccountId, include, cloudtrailName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserAttributionsApi#update");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account to update the user attributions of
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]
cloudtrailName String The name of the cloudetrail associated with the user attribution. [optional]

Return type

ExternalAccount

Authorization

No authorization required

HTTP request headers

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