ibm_cloud_iam 1.0.1 → 2.0.0

data/docs/Report.md

@@ -0,0 +1,34 @@
+# IbmCloudIam::Report
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_by** | **String** | IAMid of the user who triggered the report |  |
+| **reference** | **String** | Unique reference used to generate the report |  |
+| **report_duration** | **String** | Duration in hours for which the report is generated. |  |
+| **report_start_time** | **String** | Start time of the report |  |
+| **report_end_time** | **String** | End time of the report |  |
+| **users** | [**Array<UserActivity>**](UserActivity.md) | List of users | [optional] |
+| **apikeys** | [**Array<ApikeyActivity>**](ApikeyActivity.md) | List of apikeys | [optional] |
+| **serviceids** | [**Array<EntityActivity>**](EntityActivity.md) | List of serviceids | [optional] |
+| **profiles** | [**Array<EntityActivity>**](EntityActivity.md) | List of profiles | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::Report.new(
+  created_by: null,
+  reference: null,
+  report_duration: null,
+  report_start_time: null,
+  report_end_time: null,
+  users: null,
+  apikeys: null,
+  serviceids: null,
+  profiles: null
+)
+```
+

data/docs/ReportMfaEnrollmentStatus.md

@@ -0,0 +1,28 @@
+# IbmCloudIam::ReportMfaEnrollmentStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_by** | **String** | IAMid of the user who triggered the report |  |
+| **reference** | **String** | Unique reference used to generate the report |  |
+| **report_time** | **String** | Date time at which report is generated. Date is in ISO format. |  |
+| **account_id** | **String** | BSS account id of the user who triggered the report |  |
+| **ims_account_id** | **String** | IMS account id of the user who triggered the report | [optional] |
+| **users** | [**Array<UserReportMfaEnrollmentStatus>**](UserReportMfaEnrollmentStatus.md) | List of users | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::ReportMfaEnrollmentStatus.new(
+  created_by: null,
+  reference: null,
+  report_time: null,
+  account_id: null,
+  ims_account_id: null,
+  users: null
+)
+```
+

data/docs/ReportReference.md

@@ -0,0 +1,18 @@
+# IbmCloudIam::ReportReference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reference** | **String** | Reference for the report to be generated. |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::ReportReference.new(
+  reference: null
+)
+```
+

data/docs/ResponseContext.md

@@ -2,36 +2,37 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**transaction_id** | **String** | The transaction ID of the inbound REST request.  | [optional] 
-**operation** | **String** | The operation of the inbound REST request.  | [optional] 
-**user_agent** | **String** | The user agent of the inbound REST request.  | [optional] 
-**url** | **String** | The URL of that cluster.  | [optional] 
-**instance_id** | **String** | The instance ID of the server instance processing the request.  | [optional] 
-**thread_id** | **String** | The thread ID of the server instance processing the request.  | [optional] 
-**host** | **String** | The host of the server instance processing the request.  | [optional] 
-**start_time** | **String** | The start time of the request.  | [optional] 
-**end_time** | **String** | The finish time of the request.  | [optional] 
-**elapsed_time** | **String** | The elapsed time in msec.  | [optional] 
-**cluster_name** | **String** | The cluster name.  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** | The transaction ID of the inbound REST request.  | [optional] |
+| **operation** | **String** | The operation of the inbound REST request.  | [optional] |
+| **user_agent** | **String** | The user agent of the inbound REST request.  | [optional] |
+| **url** | **String** | The URL of that cluster.  | [optional] |
+| **instance_id** | **String** | The instance ID of the server instance processing the request.  | [optional] |
+| **thread_id** | **String** | The thread ID of the server instance processing the request.  | [optional] |
+| **host** | **String** | The host of the server instance processing the request.  | [optional] |
+| **start_time** | **String** | The start time of the request.  | [optional] |
+| **end_time** | **String** | The finish time of the request.  | [optional] |
+| **elapsed_time** | **String** | The elapsed time in msec.  | [optional] |
+| **cluster_name** | **String** | The cluster name.  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudIam'
+require 'ibm_cloud_iam'
 
-instance = IbmCloudIam::ResponseContext.new(transaction_id: null,
-                                 operation: null,
-                                 user_agent: null,
-                                 url: null,
-                                 instance_id: null,
-                                 thread_id: null,
-                                 host: null,
-                                 start_time: null,
-                                 end_time: null,
-                                 elapsed_time: null,
-                                 cluster_name: null)
+instance = IbmCloudIam::ResponseContext.new(
+  transaction_id: null,
+  operation: null,
+  user_agent: null,
+  url: null,
+  instance_id: null,
+  thread_id: null,
+  host: null,
+  start_time: null,
+  end_time: null,
+  elapsed_time: null,
+  cluster_name: null
+)
 ```
 
-

data/docs/RetrictActions.md

@@ -0,0 +1,15 @@
+# IbmCloudIam::RetrictActions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::RetrictActions.new()
+```
+

data/docs/SamlMetadataImportResponse.md

@@ -0,0 +1,42 @@
+# IbmCloudIam::SamlMetadataImportResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **idp_id** | **String** | Realm ID of the Identity Provider. |  |
+| **entity_tag** | **String** | Version information used for optimistic locking. |  |
+| **created_at** | **Time** | Creation timestamp. |  |
+| **modified_at** | **Time** | Last modification timestamp. |  |
+| **account_id** | **String** | Account that owns the Identity Provider. |  |
+| **name** | **String** | User-friendly name of the Identity Provider. |  |
+| **type** | **String** |  |  |
+| **properties** | **Object** | Type-specific Identity Provider configuration. |  |
+| **secrets** | **Object** | Type-specific secret configuration. |  |
+| **history** | **Array<Object>** | History entries for the Identity Provider. | [optional] |
+| **share_scope** | [**Array<ShareScope>**](ShareScope.md) | Accounts, enterprises, or account groups allowed to consume the IdP. | [optional] |
+| **active** | **Boolean** | Indicates whether the Identity Provider is enabled. If disabled, the IdP cannot be used by the owner account or any consumer accounts.  |  |
+| **ui_setup_completed** | **Boolean** | Internal flag used by the UI to determine whether the Identity Provider should be opened in the setup wizard or the edit dialog.  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::SamlMetadataImportResponse.new(
+  idp_id: null,
+  entity_tag: null,
+  created_at: null,
+  modified_at: null,
+  account_id: null,
+  name: null,
+  type: null,
+  properties: null,
+  secrets: null,
+  history: null,
+  share_scope: null,
+  active: null,
+  ui_setup_completed: null
+)
+```
+

data/docs/ServiceIDGroupsApi.md

@@ -0,0 +1,347 @@
+# IbmCloudIam::ServiceIDGroupsApi
+
+All URIs are relative to *https://iam.cloud.ibm.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_service_id_group**](ServiceIDGroupsApi.md#create_service_id_group) | **POST** /v1/serviceid_groups | Create a service ID group |
+| [**delete_service_id_group**](ServiceIDGroupsApi.md#delete_service_id_group) | **DELETE** /v1/serviceid_groups/{id} | Delete a service ID group |
+| [**get_service_id_group**](ServiceIDGroupsApi.md#get_service_id_group) | **GET** /v1/serviceid_groups/{id} | Get details of a service ID group |
+| [**list_service_id_group**](ServiceIDGroupsApi.md#list_service_id_group) | **GET** /v1/serviceid_groups | List service ID groups |
+| [**update_service_id_group**](ServiceIDGroupsApi.md#update_service_id_group) | **PUT** /v1/serviceid_groups/{id} | Update a service ID group |
+
+
+## create_service_id_group
+
+> <ServiceIdGroup> create_service_id_group(authorization, create_service_id_group_request)
+
+Create a service ID group
+
+Creates a service ID group for the given account ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_iam'
+
+api_instance = IbmCloudIam::ServiceIDGroupsApi.new
+authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
+create_service_id_group_request = IbmCloudIam::CreateServiceIdGroupRequest.new({account_id: 'account_id_example', name: 'name_example'}) # CreateServiceIdGroupRequest | Request to create a service ID Group.
+
+begin
+  # Create a service ID group
+  result = api_instance.create_service_id_group(authorization, create_service_id_group_request)
+  p result
+rescue IbmCloudIam::ApiError => e
+  puts "Error when calling ServiceIDGroupsApi->create_service_id_group: #{e}"
+end
+```
+
+#### Using the create_service_id_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ServiceIdGroup>, Integer, Hash)> create_service_id_group_with_http_info(authorization, create_service_id_group_request)
+
+```ruby
+begin
+  # Create a service ID group
+  data, status_code, headers = api_instance.create_service_id_group_with_http_info(authorization, create_service_id_group_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ServiceIdGroup>
+rescue IbmCloudIam::ApiError => e
+  puts "Error when calling ServiceIDGroupsApi->create_service_id_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. |  |
+| **create_service_id_group_request** | [**CreateServiceIdGroupRequest**](CreateServiceIdGroupRequest.md) | Request to create a service ID Group. |  |
+
+### Return type
+
+[**ServiceIdGroup**](ServiceIdGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_service_id_group
+
+> delete_service_id_group(id, authorization)
+
+Delete a service ID group
+
+Delete a service ID group.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_iam'
+
+api_instance = IbmCloudIam::ServiceIDGroupsApi.new
+id = 'id_example' # String | Unique ID of the service ID group.
+authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
+
+begin
+  # Delete a service ID group
+  api_instance.delete_service_id_group(id, authorization)
+rescue IbmCloudIam::ApiError => e
+  puts "Error when calling ServiceIDGroupsApi->delete_service_id_group: #{e}"
+end
+```
+
+#### Using the delete_service_id_group_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_service_id_group_with_http_info(id, authorization)
+
+```ruby
+begin
+  # Delete a service ID group
+  data, status_code, headers = api_instance.delete_service_id_group_with_http_info(id, authorization)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue IbmCloudIam::ApiError => e
+  puts "Error when calling ServiceIDGroupsApi->delete_service_id_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID of the service ID group. |  |
+| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_service_id_group
+
+> <ServiceIdGroup> get_service_id_group(id, authorization)
+
+Get details of a service ID group
+
+Returns the details of a service ID group.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_iam'
+
+api_instance = IbmCloudIam::ServiceIDGroupsApi.new
+id = 'id_example' # String | Unique ID of the service ID group.
+authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
+
+begin
+  # Get details of a service ID group
+  result = api_instance.get_service_id_group(id, authorization)
+  p result
+rescue IbmCloudIam::ApiError => e
+  puts "Error when calling ServiceIDGroupsApi->get_service_id_group: #{e}"
+end
+```
+
+#### Using the get_service_id_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ServiceIdGroup>, Integer, Hash)> get_service_id_group_with_http_info(id, authorization)
+
+```ruby
+begin
+  # Get details of a service ID group
+  data, status_code, headers = api_instance.get_service_id_group_with_http_info(id, authorization)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ServiceIdGroup>
+rescue IbmCloudIam::ApiError => e
+  puts "Error when calling ServiceIDGroupsApi->get_service_id_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID of the service ID group. |  |
+| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. |  |
+
+### Return type
+
+[**ServiceIdGroup**](ServiceIdGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_service_id_group
+
+> <ServiceIdGroupList> list_service_id_group(authorization, opts)
+
+List service ID groups
+
+Returns a list of all service ID groups for the given account ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_iam'
+
+api_instance = IbmCloudIam::ServiceIDGroupsApi.new
+authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
+opts = {
+  account_id: 'account_id_example' # String | Account ID of the service ID groups to query
+}
+
+begin
+  # List service ID groups
+  result = api_instance.list_service_id_group(authorization, opts)
+  p result
+rescue IbmCloudIam::ApiError => e
+  puts "Error when calling ServiceIDGroupsApi->list_service_id_group: #{e}"
+end
+```
+
+#### Using the list_service_id_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ServiceIdGroupList>, Integer, Hash)> list_service_id_group_with_http_info(authorization, opts)
+
+```ruby
+begin
+  # List service ID groups
+  data, status_code, headers = api_instance.list_service_id_group_with_http_info(authorization, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ServiceIdGroupList>
+rescue IbmCloudIam::ApiError => e
+  puts "Error when calling ServiceIDGroupsApi->list_service_id_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. |  |
+| **account_id** | **String** | Account ID of the service ID groups to query | [optional] |
+
+### Return type
+
+[**ServiceIdGroupList**](ServiceIdGroupList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_service_id_group
+
+> <ServiceIdGroup> update_service_id_group(id, if_match, authorization, update_service_id_group_request)
+
+Update a service ID group
+
+Update a service ID group
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_iam'
+
+api_instance = IbmCloudIam::ServiceIDGroupsApi.new
+id = 'id_example' # String | Unique ID of the service ID group to be updated.
+if_match = 'if_match_example' # String | Version of the service ID gorup to be updated. Specify the version that you retrieved when reading service ID group. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.
+authorization = 'authorization_example' # String | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: 'No authorization header found'. Make sure that the provided token has the required authority for the request.
+update_service_id_group_request = IbmCloudIam::UpdateServiceIdGroupRequest.new({name: 'name_example'}) # UpdateServiceIdGroupRequest | Request to update service ID group.
+
+begin
+  # Update a service ID group
+  result = api_instance.update_service_id_group(id, if_match, authorization, update_service_id_group_request)
+  p result
+rescue IbmCloudIam::ApiError => e
+  puts "Error when calling ServiceIDGroupsApi->update_service_id_group: #{e}"
+end
+```
+
+#### Using the update_service_id_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ServiceIdGroup>, Integer, Hash)> update_service_id_group_with_http_info(id, if_match, authorization, update_service_id_group_request)
+
+```ruby
+begin
+  # Update a service ID group
+  data, status_code, headers = api_instance.update_service_id_group_with_http_info(id, if_match, authorization, update_service_id_group_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ServiceIdGroup>
+rescue IbmCloudIam::ApiError => e
+  puts "Error when calling ServiceIDGroupsApi->update_service_id_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID of the service ID group to be updated. |  |
+| **if_match** | **String** | Version of the service ID gorup to be updated. Specify the version that you retrieved when reading service ID group. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates. |  |
+| **authorization** | **String** | Authorization Token used for the request. The supported token type is a Cloud IAM Access Token. If the token is omitted the request will fail with BXNIM0308E: &#39;No authorization header found&#39;. Make sure that the provided token has the required authority for the request. |  |
+| **update_service_id_group_request** | [**UpdateServiceIdGroupRequest**](UpdateServiceIdGroupRequest.md) | Request to update service ID group. |  |
+
+### Return type
+
+[**ServiceIdGroup**](ServiceIdGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+