ibm_cloud_iam 1.0.1 → 2.0.0

data/docs/ServiceIdList.md

@@ -2,28 +2,29 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**context** | [**ResponseContext**](ResponseContext.md) |  | [optional] 
-**offset** | **Integer** | The offset of the current page. | [optional] 
-**limit** | **Integer** | Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100 | [optional] 
-**first** | **String** | Link to the first page. | [optional] 
-**previous** | **String** | Link to the previous available page. If 'previous' property is not part of the response no previous page is available. | [optional] 
-**_next** | **String** | Link to the next available page. If 'next' property is not part of the response no next page is available. | [optional] 
-**serviceids** | [**Array<ServiceId>**](ServiceId.md) | List of service IDs based on the query paramters and the page size. The service IDs array is always part of the response but might be empty depending on the query parameter values provided. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **context** | [**ResponseContext**](ResponseContext.md) |  | [optional] |
+| **offset** | **Integer** | The offset of the current page. | [optional] |
+| **limit** | **Integer** | Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100. | [optional] |
+| **first** | **String** | Link to the first page. | [optional] |
+| **previous** | **String** | Link to the previous available page. If 'previous' property is not part of the response no previous page is available. | [optional] |
+| **_next** | **String** | Link to the next available page. If 'next' property is not part of the response no next page is available. | [optional] |
+| **serviceids** | [**Array<ServiceId>**](ServiceId.md) | List of service IDs based on the query paramters and the page size. The service IDs array is always part of the response but might be empty depending on the query parameter values provided. |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudIam'
+require 'ibm_cloud_iam'
 
-instance = IbmCloudIam::ServiceIdList.new(context: null,
-                                 offset: null,
-                                 limit: null,
-                                 first: null,
-                                 previous: null,
-                                 _next: null,
-                                 serviceids: null)
+instance = IbmCloudIam::ServiceIdList.new(
+  context: null,
+  offset: null,
+  limit: null,
+  first: null,
+  previous: null,
+  _next: null,
+  serviceids: null
+)
 ```
 
-

data/docs/ShareScope.md

@@ -0,0 +1,20 @@
+# IbmCloudIam::ShareScope
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::ShareScope.new(
+  id: null,
+  type: null
+)
+```
+

data/docs/TemplateAccountSettings.md

@@ -0,0 +1,40 @@
+# IbmCloudIam::TemplateAccountSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **restrict_create_service_id** | [**RetrictActions**](RetrictActions.md) |  | [optional][default to 'NOT_SET'] |
+| **restrict_create_platform_apikey** | [**RetrictActions**](RetrictActions.md) |  | [optional][default to 'NOT_SET'] |
+| **allowed_ip_addresses** | **String** | Defines the IP addresses and subnets from which IAM tokens can be created for the account. | [optional] |
+| **mfa** | [**MfaOptions**](MfaOptions.md) |  | [optional] |
+| **user_mfa** | [**Array<UserMfa>**](UserMfa.md) | List of users that are exempted from the MFA requirement of the account. | [optional] |
+| **session_expiration_in_seconds** | **String** | Defines the session expiration in seconds for the account. Valid values:   * Any whole number between between '900' and '86400'   * NOT_SET - To unset account setting and use service default | [optional][default to '86400'] |
+| **session_invalidation_in_seconds** | **String** | Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values:   * Any whole number between '900' and '7200'   * NOT_SET - To unset account setting and use service default | [optional][default to '7200'] |
+| **max_sessions_per_identity** | **String** | Defines the max allowed sessions per identity required by the account. Valid values:   * Any whole number greater than 0   * NOT_SET - To unset account setting and use service default | [optional] |
+| **system_access_token_expiration_in_seconds** | **String** | Defines the access token expiration in seconds. Valid values:   * Any whole number between '900' and '3600'   * NOT_SET - To unset account setting and use service default | [optional][default to '3600'] |
+| **system_refresh_token_expiration_in_seconds** | **String** | Defines the refresh token expiration in seconds. Valid values:   * Any whole number between '900' and '259200'   * NOT_SET - To unset account setting and use service default | [optional][default to '259200'] |
+| **restrict_user_list_visibility** | [**UserVisbilityRetrictActionsForTemplate**](UserVisbilityRetrictActionsForTemplate.md) |  | [optional] |
+| **restrict_user_domains** | [**TemplateAccountSettingsAllOfRestrictUserDomains**](TemplateAccountSettingsAllOfRestrictUserDomains.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateAccountSettings.new(
+  restrict_create_service_id: null,
+  restrict_create_platform_apikey: null,
+  allowed_ip_addresses: null,
+  mfa: null,
+  user_mfa: null,
+  session_expiration_in_seconds: null,
+  session_invalidation_in_seconds: null,
+  max_sessions_per_identity: null,
+  system_access_token_expiration_in_seconds: null,
+  system_refresh_token_expiration_in_seconds: null,
+  restrict_user_list_visibility: null,
+  restrict_user_domains: null
+)
+```
+

data/docs/TemplateAccountSettingsAllOfRestrictUserDomains.md

@@ -0,0 +1,20 @@
+# IbmCloudIam::TemplateAccountSettingsAllOfRestrictUserDomains
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_sufficient** | **Boolean** |  | [optional] |
+| **restrictions** | [**Array<AccountSettingsUserDomainRestriction>**](AccountSettingsUserDomainRestriction.md) | Defines if account invitations are restricted to specified domains. To remove an entry for a realm_id, perform an update (PUT) request with only the realm_id set. | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateAccountSettingsAllOfRestrictUserDomains.new(
+  account_sufficient: null,
+  restrictions: null
+)
+```
+

data/docs/TemplateAssignmentListResponse.md

@@ -0,0 +1,30 @@
+# IbmCloudIam::TemplateAssignmentListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **context** | [**ResponseContext**](ResponseContext.md) |  | [optional] |
+| **offset** | **Integer** | The offset of the current page. | [optional] |
+| **limit** | **Integer** | Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100 | [optional] |
+| **first** | **String** | Link to the first page. | [optional] |
+| **previous** | **String** | Link to the previous available page. If 'previous' property is not part of the response no previous page is available. | [optional] |
+| **_next** | **String** | Link to the next available page. If 'next' property is not part of the response no next page is available. | [optional] |
+| **assignments** | [**Array<TemplateAssignmentResponse>**](TemplateAssignmentResponse.md) | List of Assignments based on the query paramters and the page size. The assignments array is always part of the response but might be empty depending on the query parameter values provided. |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateAssignmentListResponse.new(
+  context: null,
+  offset: null,
+  limit: null,
+  first: null,
+  previous: null,
+  _next: null,
+  assignments: null
+)
+```
+

data/docs/TemplateAssignmentResource.md

@@ -0,0 +1,18 @@
+# IbmCloudIam::TemplateAssignmentResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Id of the created resource | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateAssignmentResource.new(
+  id: null
+)
+```
+

data/docs/TemplateAssignmentResourceError.md

@@ -0,0 +1,24 @@
+# IbmCloudIam::TemplateAssignmentResourceError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the error | [optional] |
+| **error_code** | **String** | Internal error code | [optional] |
+| **message** | **String** | Error message detailing the nature of the error | [optional] |
+| **status_code** | **String** | Internal status code for the error | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateAssignmentResourceError.new(
+  name: null,
+  error_code: null,
+  message: null,
+  status_code: null
+)
+```
+

data/docs/TemplateAssignmentResponse.md

@@ -0,0 +1,48 @@
+# IbmCloudIam::TemplateAssignmentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **context** | [**ResponseContext**](ResponseContext.md) |  | [optional] |
+| **id** | **String** | Assignment record Id |  |
+| **account_id** | **String** | Enterprise account Id |  |
+| **template_id** | **String** | Template Id |  |
+| **template_version** | **Integer** | Template version |  |
+| **target_type** | **String** | Assignment target type |  |
+| **target** | **String** | Assignment target |  |
+| **status** | **String** | Assignment status |  |
+| **resources** | [**Array<TemplateAssignmentResponseResource>**](TemplateAssignmentResponseResource.md) | Status breakdown per target account of IAM resources created or errors encountered in attempting to create those IAM resources. IAM resources are only included in the response providing the assignment is not in progress. IAM resources are also only included when getting a single assignment, and excluded by list APIs. | [optional] |
+| **history** | [**Array<EnityHistoryRecord>**](EnityHistoryRecord.md) | Assignment history | [optional] |
+| **href** | **String** | Href | [optional] |
+| **created_at** | **String** | Assignment created at |  |
+| **created_by_id** | **String** | IAMid of the identity that created the assignment |  |
+| **last_modified_at** | **String** | Assignment modified at |  |
+| **last_modified_by_id** | **String** | IAMid of the identity that last modified the assignment |  |
+| **entity_tag** | **String** | Entity tag for this assignment record |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateAssignmentResponse.new(
+  context: null,
+  id: null,
+  account_id: null,
+  template_id: null,
+  template_version: null,
+  target_type: null,
+  target: null,
+  status: null,
+  resources: null,
+  history: null,
+  href: null,
+  created_at: null,
+  created_by_id: null,
+  last_modified_at: null,
+  last_modified_by_id: null,
+  entity_tag: null
+)
+```
+

data/docs/TemplateAssignmentResponseResource.md

@@ -0,0 +1,24 @@
+# IbmCloudIam::TemplateAssignmentResponseResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **target** | **String** | Target account where the IAM resource is created. |  |
+| **profile** | [**TemplateAssignmentResponseResourceDetail**](TemplateAssignmentResponseResourceDetail.md) |  | [optional] |
+| **account_settings** | [**TemplateAssignmentResponseResourceDetail**](TemplateAssignmentResponseResourceDetail.md) |  | [optional] |
+| **policy_template_references** | [**Array<TemplateAssignmentResponseResourceDetail>**](TemplateAssignmentResponseResourceDetail.md) | Policy resource(s) included only for trusted profile assignments with policy references. | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateAssignmentResponseResource.new(
+  target: null,
+  profile: null,
+  account_settings: null,
+  policy_template_references: null
+)
+```
+

data/docs/TemplateAssignmentResponseResourceDetail.md

@@ -0,0 +1,26 @@
+# IbmCloudIam::TemplateAssignmentResponseResourceDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Policy Template Id, only returned for a profile assignment with policy references. | [optional] |
+| **version** | **String** | Policy version, only returned for a profile assignment with policy references. | [optional] |
+| **resource_created** | [**TemplateAssignmentResource**](TemplateAssignmentResource.md) |  | [optional] |
+| **error_message** | [**TemplateAssignmentResourceError**](TemplateAssignmentResourceError.md) |  | [optional] |
+| **status** | **String** | Status for the target account's assignment |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateAssignmentResponseResourceDetail.new(
+  id: null,
+  version: null,
+  resource_created: null,
+  error_message: null,
+  status: null
+)
+```
+

data/docs/TemplateCount.md

@@ -0,0 +1,20 @@
+# IbmCloudIam::TemplateCount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | Template identifier | [optional] |
+| **count** | **Integer** | Number of versions for the template | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateCount.new(
+  template_id: null,
+  count: null
+)
+```
+

data/docs/TemplateProfileComponentRequest.md

@@ -0,0 +1,26 @@
+# IbmCloudIam::TemplateProfileComponentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the Profile.  You can use replacement variables in the profile name to adjust the name per account.   The following variables are supported:  - `${template_id}` will be replaced by a unique identifier representing the trusted profile template  - `${template_name}` will be replaced by the current name of the trusted profile template  - `${template_version}` will be replaced by the current version of the trusted profile template  - `${account_id}` will be replaced by the account identifier to which this trusted profile template is assigned to  - `${account_name}` will be replaced by the account name to which this trusted profile template is assigned to  Changes to e.g. the name of the account will NOT cause an update of the trusted profile name. The profile name is  processed during account assignment and any template version upgrade, i.e. during that operation, the updated account name would be used.  |  |
+| **description** | **String** | Description of the Profile | [optional] |
+| **email** | **String** | Email of the trusted profile | [optional] |
+| **rules** | [**Array<TrustedProfileTemplateClaimRule>**](TrustedProfileTemplateClaimRule.md) | Rules for the Profile | [optional] |
+| **identities** | [**Array<ProfileIdentityRequest>**](ProfileIdentityRequest.md) | Identities for the Profile | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateProfileComponentRequest.new(
+  name: null,
+  description: null,
+  email: null,
+  rules: null,
+  identities: null
+)
+```
+

data/docs/TemplateProfileComponentResponse.md

@@ -0,0 +1,26 @@
+# IbmCloudIam::TemplateProfileComponentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the Profile |  |
+| **description** | **String** | Description of the Profile | [optional] |
+| **rules** | [**Array<TrustedProfileTemplateClaimRule>**](TrustedProfileTemplateClaimRule.md) | Rules for the Profile | [optional] |
+| **email** | **String** | Email of the trusted profile | [optional] |
+| **identities** | [**Array<ProfileIdentityResponse>**](ProfileIdentityResponse.md) | Identities for the Profile | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TemplateProfileComponentResponse.new(
+  name: null,
+  description: null,
+  rules: null,
+  email: null,
+  identities: null
+)
+```
+

data/docs/TestResult.md

@@ -0,0 +1,28 @@
+# IbmCloudIam::TestResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **idp_id** | **String** |  | [optional] |
+| **entity_tag** | **String** |  | [optional] |
+| **started_at** | **Integer** |  | [optional] |
+| **modified_at** | **String** |  | [optional] |
+| **idp_version** | **String** |  | [optional] |
+| **steps** | [**Array<TestResultStepsInner>**](TestResultStepsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TestResult.new(
+  idp_id: null,
+  entity_tag: null,
+  started_at: null,
+  modified_at: null,
+  idp_version: null,
+  steps: null
+)
+```
+

data/docs/TestResultStepsInner.md

@@ -0,0 +1,24 @@
+# IbmCloudIam::TestResultStepsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sequence** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **result** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TestResultStepsInner.new(
+  sequence: null,
+  name: null,
+  state: null,
+  result: null
+)
+```
+

data/docs/TestTriggerResponse.md

@@ -0,0 +1,20 @@
+# IbmCloudIam::TestTriggerResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result** | **String** |  | [optional] |
+| **test_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_iam'
+
+instance = IbmCloudIam::TestTriggerResponse.new(
+  result: null,
+  test_url: null
+)
+```
+

data/docs/TokenResponse.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**access_token** | **String** | The IAM access token that can be used to invoke various IBM Cloud APIs. Use this token with the prefix Bearer in the HTTP header Authorization for invocations of IAM compatible APIs. | [optional] 
-**refresh_token** | **String** | (optional) A refresh token that can be used to get a new IAM access token if that token is expired. When using the default client (no basic authorization header) as described in this documentation, this refresh_token cannot be used to retrieve a new IAM access token. When the IAM access token is about to be expired, use the API key to create a new access token. | [optional] 
-**delegated_refresh_token** | **String** | (optional) A delegated refresh token that can only be consumed by the clients that have been specified in the API call as 'receiver_client_ids' | [optional] 
-**token_type** | **String** | The type of the token. Currently, only Bearer is returned. | [optional] 
-**expires_in** | **Integer** | Number of seconds until the IAM access token will expire. | [optional] 
-**expiration** | **Integer** | Number of seconds counted since January 1st, 1970, until the IAM access token will expire. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** | The IAM access token that can be used to invoke various IBM Cloud APIs. Use this token with the prefix Bearer in the HTTP header Authorization for invocations of IAM compatible APIs. | [optional] |
+| **refresh_token** | **String** | (optional) A refresh token that can be used to get a new IAM access token if that token is expired. When using the default client (no basic authorization header) as described in this documentation, this refresh_token cannot be used to retrieve a new IAM access token. When the IAM access token is about to be expired, use the API key to create a new access token. | [optional] |
+| **delegated_refresh_token** | **String** | (optional) A delegated refresh token that can only be consumed by the clients that have been specified in the API call as 'receiver_client_ids' | [optional] |
+| **token_type** | **String** | The type of the token. Currently, only Bearer is returned. | [optional] |
+| **expires_in** | **Integer** | Number of seconds until the IAM access token will expire. | [optional] |
+| **expiration** | **Integer** | Number of seconds counted since January 1st, 1970, until the IAM access token will expire. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudIam'
+require 'ibm_cloud_iam'
 
-instance = IbmCloudIam::TokenResponse.new(access_token: null,
-                                 refresh_token: null,
-                                 delegated_refresh_token: null,
-                                 token_type: null,
-                                 expires_in: null,
-                                 expiration: null)
+instance = IbmCloudIam::TokenResponse.new(
+  access_token: null,
+  refresh_token: null,
+  delegated_refresh_token: null,
+  token_type: null,
+  expires_in: null,
+  expiration: null
+)
 ```
 
-