docs/OrgsApi.md in cloudsmith-api-2.0.1 vs docs/OrgsApi.md in cloudsmith-api-2.0.2

- old
+ new

@@ -8,10 +8,17 @@ [**orgs_invites_delete**](OrgsApi.md#orgs_invites_delete) | **DELETE** /orgs/{org}/invites/{slug_perm}/ | Delete a specific organization invite [**orgs_invites_extend**](OrgsApi.md#orgs_invites_extend) | **POST** /orgs/{org}/invites/{slug_perm}/extend/ | Extend an organization invite. [**orgs_invites_list**](OrgsApi.md#orgs_invites_list) | **GET** /orgs/{org}/invites/ | Get a list of all invites for an organization. [**orgs_invites_partial_update**](OrgsApi.md#orgs_invites_partial_update) | **PATCH** /orgs/{org}/invites/{slug_perm}/ | Update a specific organization invite. [**orgs_invites_resend**](OrgsApi.md#orgs_invites_resend) | **POST** /orgs/{org}/invites/{slug_perm}/resend/ | Resend an organization invite. +[**orgs_license_policy_create**](OrgsApi.md#orgs_license_policy_create) | **POST** /orgs/{org}/license-policy/ | Create a package license policy. +[**orgs_license_policy_delete**](OrgsApi.md#orgs_license_policy_delete) | **DELETE** /orgs/{org}/license-policy/{slug_perm}/ | Delete a package license policy. +[**orgs_license_policy_list**](OrgsApi.md#orgs_license_policy_list) | **GET** /orgs/{org}/license-policy/ | Get a list of all package license policies. +[**orgs_license_policy_partial_update**](OrgsApi.md#orgs_license_policy_partial_update) | **PATCH** /orgs/{org}/license-policy/{slug_perm}/ | Partially update a package license policy. +[**orgs_license_policy_read**](OrgsApi.md#orgs_license_policy_read) | **GET** /orgs/{org}/license-policy/{slug_perm}/ | Get a package license policy. +[**orgs_license_policy_update**](OrgsApi.md#orgs_license_policy_update) | **PUT** /orgs/{org}/license-policy/{slug_perm}/ | Update a package license policy. +[**orgs_license_policy_violation_list**](OrgsApi.md#orgs_license_policy_violation_list) | **GET** /orgs/{org}/license-policy-violation/ | List all current license policy violations for this Organization. [**orgs_list**](OrgsApi.md#orgs_list) | **GET** /orgs/ | Get a list of all the organizations you are associated with. [**orgs_members_delete**](OrgsApi.md#orgs_members_delete) | **DELETE** /orgs/{org}/members/{member}/ | Removes a member from the organization. [**orgs_members_list**](OrgsApi.md#orgs_members_list) | **GET** /orgs/{org}/members/ | Get the details for all organization members. [**orgs_members_read**](OrgsApi.md#orgs_members_read) | **GET** /orgs/{org}/members/{member}/ | Get the details for a specific organization member. [**orgs_members_remove**](OrgsApi.md#orgs_members_remove) | **GET** /orgs/{org}/members/{member}/remove/ | Removes a member from the organization (deprecated, use DELETE instead). @@ -31,10 +38,17 @@ [**orgs_teams_members_create**](OrgsApi.md#orgs_teams_members_create) | **POST** /orgs/{org}/teams/{team}/members | Add users to a team. [**orgs_teams_members_list**](OrgsApi.md#orgs_teams_members_list) | **GET** /orgs/{org}/teams/{team}/members | List all members for the team. [**orgs_teams_members_update**](OrgsApi.md#orgs_teams_members_update) | **PUT** /orgs/{org}/teams/{team}/members | Replace all team members. [**orgs_teams_partial_update**](OrgsApi.md#orgs_teams_partial_update) | **PATCH** /orgs/{org}/teams/{team}/ | Update a specific team in a organization. [**orgs_teams_read**](OrgsApi.md#orgs_teams_read) | **GET** /orgs/{org}/teams/{team}/ | Get the details of a specific team within an organization. +[**orgs_vulnerability_policy_create**](OrgsApi.md#orgs_vulnerability_policy_create) | **POST** /orgs/{org}/vulnerability-policy/ | Create a package vulnerability policy. +[**orgs_vulnerability_policy_delete**](OrgsApi.md#orgs_vulnerability_policy_delete) | **DELETE** /orgs/{org}/vulnerability-policy/{slug_perm}/ | Delete a package vulnerability policy. +[**orgs_vulnerability_policy_list**](OrgsApi.md#orgs_vulnerability_policy_list) | **GET** /orgs/{org}/vulnerability-policy/ | Get a list of all package vulnerability policies. +[**orgs_vulnerability_policy_partial_update**](OrgsApi.md#orgs_vulnerability_policy_partial_update) | **PATCH** /orgs/{org}/vulnerability-policy/{slug_perm}/ | Partially update a package vulnerability policy. +[**orgs_vulnerability_policy_read**](OrgsApi.md#orgs_vulnerability_policy_read) | **GET** /orgs/{org}/vulnerability-policy/{slug_perm}/ | Get a package vulnerability policy. +[**orgs_vulnerability_policy_update**](OrgsApi.md#orgs_vulnerability_policy_update) | **PUT** /orgs/{org}/vulnerability-policy/{slug_perm}/ | Update a package vulnerability policy. +[**orgs_vulnerability_policy_violation_list**](OrgsApi.md#orgs_vulnerability_policy_violation_list) | **GET** /orgs/{org}/vulnerability-policy-violation/ | List all current vulnerability policy violations for this Organization. # **orgs_invites_create** > OrganizationInvite orgs_invites_create(org, opts) @@ -382,10 +396,423 @@ - **Content-Type**: application/json - **Accept**: application/json +# **orgs_license_policy_create** +> OrganizationPackageLicensePolicy orgs_license_policy_create(org, opts) + +Create a package license policy. + +Create a package license policy. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +opts = { + data: CloudsmithApi::OrganizationPackageLicensePolicyRequest.new # OrganizationPackageLicensePolicyRequest | +} + +begin + #Create a package license policy. + result = api_instance.orgs_license_policy_create(org, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_license_policy_create: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **data** | [**OrganizationPackageLicensePolicyRequest**](OrganizationPackageLicensePolicyRequest.md)| | [optional] + +### Return type + +[**OrganizationPackageLicensePolicy**](OrganizationPackageLicensePolicy.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_license_policy_delete** +> orgs_license_policy_delete(org, slug_perm) + +Delete a package license policy. + +Delete a package license policy. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +slug_perm = 'slug_perm_example' # String | + + +begin + #Delete a package license policy. + api_instance.orgs_license_policy_delete(org, slug_perm) +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_license_policy_delete: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **slug_perm** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_license_policy_list** +> Array<OrganizationPackageLicensePolicy> orgs_license_policy_list(org, opts) + +Get a list of all package license policies. + +Get a list of all package license policies. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +opts = { + page: 56, # Integer | A page number within the paginated result set. + page_size: 56 # Integer | Number of results to return per page. +} + +begin + #Get a list of all package license policies. + result = api_instance.orgs_license_policy_list(org, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_license_policy_list: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **page** | **Integer**| A page number within the paginated result set. | [optional] + **page_size** | **Integer**| Number of results to return per page. | [optional] + +### Return type + +[**Array<OrganizationPackageLicensePolicy>**](OrganizationPackageLicensePolicy.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_license_policy_partial_update** +> OrganizationPackageLicensePolicy orgs_license_policy_partial_update(org, slug_perm, opts) + +Partially update a package license policy. + +Partially update a package license policy. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +slug_perm = 'slug_perm_example' # String | + +opts = { + data: CloudsmithApi::OrganizationPackageLicensePolicyRequestPatch.new # OrganizationPackageLicensePolicyRequestPatch | +} + +begin + #Partially update a package license policy. + result = api_instance.orgs_license_policy_partial_update(org, slug_perm, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_license_policy_partial_update: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **slug_perm** | **String**| | + **data** | [**OrganizationPackageLicensePolicyRequestPatch**](OrganizationPackageLicensePolicyRequestPatch.md)| | [optional] + +### Return type + +[**OrganizationPackageLicensePolicy**](OrganizationPackageLicensePolicy.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_license_policy_read** +> OrganizationPackageLicensePolicy orgs_license_policy_read(org, slug_perm) + +Get a package license policy. + +Get a package license policy. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +slug_perm = 'slug_perm_example' # String | + + +begin + #Get a package license policy. + result = api_instance.orgs_license_policy_read(org, slug_perm) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_license_policy_read: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **slug_perm** | **String**| | + +### Return type + +[**OrganizationPackageLicensePolicy**](OrganizationPackageLicensePolicy.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_license_policy_update** +> OrganizationPackageLicensePolicy orgs_license_policy_update(org, slug_perm, opts) + +Update a package license policy. + +Update a package license policy. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +slug_perm = 'slug_perm_example' # String | + +opts = { + data: CloudsmithApi::OrganizationPackageLicensePolicyRequest.new # OrganizationPackageLicensePolicyRequest | +} + +begin + #Update a package license policy. + result = api_instance.orgs_license_policy_update(org, slug_perm, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_license_policy_update: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **slug_perm** | **String**| | + **data** | [**OrganizationPackageLicensePolicyRequest**](OrganizationPackageLicensePolicyRequest.md)| | [optional] + +### Return type + +[**OrganizationPackageLicensePolicy**](OrganizationPackageLicensePolicy.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_license_policy_violation_list** +> PackageLicensePolicyViolationLogCursorPage orgs_license_policy_violation_list(org, opts) + +List all current license policy violations for this Organization. + +List all current license policy violations for this Organization. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +opts = { + cursor: 'cursor_example', # String | The pagination cursor value. + page_size: 56 # Integer | Number of results to return per page. +} + +begin + #List all current license policy violations for this Organization. + result = api_instance.orgs_license_policy_violation_list(org, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_license_policy_violation_list: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **cursor** | **String**| The pagination cursor value. | [optional] + **page_size** | **Integer**| Number of results to return per page. | [optional] + +### Return type + +[**PackageLicensePolicyViolationLogCursorPage**](PackageLicensePolicyViolationLogCursorPage.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + # **orgs_list** > Array<Organization> orgs_list(opts) Get a list of all the organizations you are associated with. @@ -1700,9 +2127,422 @@ **team** | **String**| | ### Return type [**OrganizationTeam**](OrganizationTeam.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_vulnerability_policy_create** +> OrganizationPackageVulnerabilityPolicy orgs_vulnerability_policy_create(org, opts) + +Create a package vulnerability policy. + +Create a package vulnerability policy. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +opts = { + data: CloudsmithApi::OrganizationPackageVulnerabilityPolicyRequest.new # OrganizationPackageVulnerabilityPolicyRequest | +} + +begin + #Create a package vulnerability policy. + result = api_instance.orgs_vulnerability_policy_create(org, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_vulnerability_policy_create: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **data** | [**OrganizationPackageVulnerabilityPolicyRequest**](OrganizationPackageVulnerabilityPolicyRequest.md)| | [optional] + +### Return type + +[**OrganizationPackageVulnerabilityPolicy**](OrganizationPackageVulnerabilityPolicy.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_vulnerability_policy_delete** +> orgs_vulnerability_policy_delete(org, slug_perm) + +Delete a package vulnerability policy. + +Delete a package vulnerability policy. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +slug_perm = 'slug_perm_example' # String | + + +begin + #Delete a package vulnerability policy. + api_instance.orgs_vulnerability_policy_delete(org, slug_perm) +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_vulnerability_policy_delete: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **slug_perm** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_vulnerability_policy_list** +> Array<OrganizationPackageVulnerabilityPolicy> orgs_vulnerability_policy_list(org, opts) + +Get a list of all package vulnerability policies. + +Get a list of all package vulnerability policies. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +opts = { + page: 56, # Integer | A page number within the paginated result set. + page_size: 56 # Integer | Number of results to return per page. +} + +begin + #Get a list of all package vulnerability policies. + result = api_instance.orgs_vulnerability_policy_list(org, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_vulnerability_policy_list: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **page** | **Integer**| A page number within the paginated result set. | [optional] + **page_size** | **Integer**| Number of results to return per page. | [optional] + +### Return type + +[**Array<OrganizationPackageVulnerabilityPolicy>**](OrganizationPackageVulnerabilityPolicy.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_vulnerability_policy_partial_update** +> OrganizationPackageVulnerabilityPolicy orgs_vulnerability_policy_partial_update(org, slug_perm, opts) + +Partially update a package vulnerability policy. + +Partially update a package vulnerability policy. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +slug_perm = 'slug_perm_example' # String | + +opts = { + data: CloudsmithApi::OrganizationPackageVulnerabilityPolicyRequestPatch.new # OrganizationPackageVulnerabilityPolicyRequestPatch | +} + +begin + #Partially update a package vulnerability policy. + result = api_instance.orgs_vulnerability_policy_partial_update(org, slug_perm, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_vulnerability_policy_partial_update: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **slug_perm** | **String**| | + **data** | [**OrganizationPackageVulnerabilityPolicyRequestPatch**](OrganizationPackageVulnerabilityPolicyRequestPatch.md)| | [optional] + +### Return type + +[**OrganizationPackageVulnerabilityPolicy**](OrganizationPackageVulnerabilityPolicy.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_vulnerability_policy_read** +> OrganizationPackageVulnerabilityPolicy orgs_vulnerability_policy_read(org, slug_perm) + +Get a package vulnerability policy. + +Get a package vulnerability policy. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +slug_perm = 'slug_perm_example' # String | + + +begin + #Get a package vulnerability policy. + result = api_instance.orgs_vulnerability_policy_read(org, slug_perm) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_vulnerability_policy_read: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **slug_perm** | **String**| | + +### Return type + +[**OrganizationPackageVulnerabilityPolicy**](OrganizationPackageVulnerabilityPolicy.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_vulnerability_policy_update** +> OrganizationPackageVulnerabilityPolicy orgs_vulnerability_policy_update(org, slug_perm, opts) + +Update a package vulnerability policy. + +Update a package vulnerability policy. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +slug_perm = 'slug_perm_example' # String | + +opts = { + data: CloudsmithApi::OrganizationPackageVulnerabilityPolicyRequest.new # OrganizationPackageVulnerabilityPolicyRequest | +} + +begin + #Update a package vulnerability policy. + result = api_instance.orgs_vulnerability_policy_update(org, slug_perm, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_vulnerability_policy_update: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **slug_perm** | **String**| | + **data** | [**OrganizationPackageVulnerabilityPolicyRequest**](OrganizationPackageVulnerabilityPolicyRequest.md)| | [optional] + +### Return type + +[**OrganizationPackageVulnerabilityPolicy**](OrganizationPackageVulnerabilityPolicy.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **orgs_vulnerability_policy_violation_list** +> PackageVulnerabilityPolicyViolationLogCursorPage orgs_vulnerability_policy_violation_list(org, opts) + +List all current vulnerability policy violations for this Organization. + +List all current vulnerability policy violations for this Organization. + +### Example +```ruby +# load the gem +require 'cloudsmith-api' +# setup authorization +CloudsmithApi.configure do |config| + # Configure API key authorization: apikey + config.api_key['X-Api-Key'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['X-Api-Key'] = 'Bearer' +end + +api_instance = CloudsmithApi::OrgsApi.new + +org = 'org_example' # String | + +opts = { + cursor: 'cursor_example', # String | The pagination cursor value. + page_size: 56 # Integer | Number of results to return per page. +} + +begin + #List all current vulnerability policy violations for this Organization. + result = api_instance.orgs_vulnerability_policy_violation_list(org, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling OrgsApi->orgs_vulnerability_policy_violation_list: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **String**| | + **cursor** | **String**| The pagination cursor value. | [optional] + **page_size** | **Integer**| Number of results to return per page. | [optional] + +### Return type + +[**PackageVulnerabilityPolicyViolationLogCursorPage**](PackageVulnerabilityPolicyViolationLogCursorPage.md) ### Authorization [apikey](../README.md#apikey)