oci 2.0.5 → 2.0.6

data/lib/oci/identity/models/group.rb

@@ -3,6 +3,20 @@
 require 'date'
 
 module OCI
+  # A collection of users who all need the same type of access to a particular set of resources or compartment.
+  # For conceptual information about groups and other IAM Service components, see
+  # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
+  #
+  # If you're federating with an identity provider (IdP), you need to create mappings between the groups
+  # defined in the IdP and groups you define in the IAM service. For more information, see
+  # [Identity Providers and Federation](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm). Also see
+  # {IdentityProvider} and
+  # {IdpGroupMapping}.
+  #
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
+  # talk to an administrator. If you're an administrator who needs to write policies to give users access,
+  # see [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
   class Identity::Models::Group
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
@@ -12,32 +26,32 @@ module OCI
                 LIFECYCLE_STATE_DELETED = 'DELETED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the group.
+    # **[Required]** The OCID of the group.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the tenancy containing the group.
+    # **[Required]** The OCID of the tenancy containing the group.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The name you assign to the group during creation. The name must be unique across all groups in
+    # **[Required]** The name you assign to the group during creation. The name must be unique across all groups in
     # the tenancy and cannot be changed.
     # 
     # @return [String]
     attr_accessor :name
 
-    # The description you assign to the group. Does not have to be unique, and it's changeable.
+    # **[Required]** The description you assign to the group. Does not have to be unique, and it's changeable.
     # @return [String]
     attr_accessor :description
 
-    # Date and time the group was created, in the format defined by RFC3339.
+    # **[Required]** Date and time the group was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The group's current state. After creating a group, make sure its `lifecycleState` changes from CREATING to
+    # **[Required]** The group's current state. After creating a group, make sure its `lifecycleState` changes from CREATING to
     # ACTIVE before using it.
     # 
     # @return [String]
@@ -47,15 +61,16 @@ module OCI
     # @return [Integer]
     attr_accessor :inactive_status
 
-    # Simple key-value pair that is applied without any predefined name, type or scope. Exists solely for
-    # compatibility with other cloud provider tagging schemes.
-    # Example: `{\"bar-key\": \"value\"}`
+    # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    # Example: `{\"Department\": \"Finance\"}`
     # 
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # Usage of predefined tag keys. These predefined keys are scoped to namespaces.
-    # Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}`
+    # Defined tags for this resource. Each key is predefined and scoped to a namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    # Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
     # 
     # @return [Hash<String, Hash<String, Object>>]
     attr_accessor :defined_tags
@@ -63,6 +78,15 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [String] :description The value to assign to the {#description} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :inactiveStatus The value to assign to the {#inactive_status} property
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {#freeform_tags} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {#defined_tags} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/identity/models/identity_provider.rb

@@ -3,6 +3,17 @@
 require 'date'
 
 module OCI
+  # The resulting base object when you add an identity provider to your tenancy. A
+  # {Saml2IdentityProvider}
+  # is a specific type of `IdentityProvider` that supports the SAML 2.0 protocol. Each
+  # `IdentityProvider` object has its own OCID. For more information, see
+  # [Identity Providers and Federation](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm).
+  #
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
+  # talk to an administrator. If you're an administrator who needs to write policies to give users access,
+  # see [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
+  # This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
   class Identity::Models::IdentityProvider
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
@@ -12,15 +23,15 @@ module OCI
                 LIFECYCLE_STATE_DELETED = 'DELETED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the `IdentityProvider`.
+    # **[Required]** The OCID of the `IdentityProvider`.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the tenancy containing the `IdentityProvider`.
+    # **[Required]** The OCID of the tenancy containing the `IdentityProvider`.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The name you assign to the `IdentityProvider` during creation. The name
+    # **[Required]** The name you assign to the `IdentityProvider` during creation. The name
     # must be unique across all `IdentityProvider` objects in the tenancy and
     # cannot be changed. This is the name federated users see when choosing
     # which identity provider to use when signing in to the Oracle Cloud Infrastructure
@@ -29,13 +40,13 @@ module OCI
     # @return [String]
     attr_accessor :name
 
-    # The description you assign to the `IdentityProvider` during creation. Does
+    # **[Required]** The description you assign to the `IdentityProvider` during creation. Does
     # not have to be unique, and it's changeable.
     # 
     # @return [String]
     attr_accessor :description
 
-    # The identity provider service or product.
+    # **[Required]** The identity provider service or product.
     # Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft
     # Active Directory Federation Services (ADFS).
     # 
@@ -48,14 +59,14 @@ module OCI
     # @return [String]
     attr_accessor :product_type
 
-    # Date and time the `IdentityProvider` was created, in the format defined by RFC3339.
+    # **[Required]** Date and time the `IdentityProvider` was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The current state. After creating an `IdentityProvider`, make sure its
+    # **[Required]** The current state. After creating an `IdentityProvider`, make sure its
     # `lifecycleState` changes from CREATING to ACTIVE before using it.
     # 
     # @return [String]
@@ -65,21 +76,23 @@ module OCI
     # @return [Integer]
     attr_accessor :inactive_status
 
-    # The protocol used for federation. Allowed value: `SAML2`.
+    # **[Required]** The protocol used for federation. Allowed value: `SAML2`.
     # 
     # Example: `SAML2`
     # 
     # @return [String]
     attr_accessor :protocol
 
-    # Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
-    # Example: `{\"bar-key\": \"value\"}`
+    # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    # Example: `{\"Department\": \"Finance\"}`
     # 
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # Usage of predefined tag keys. These predefined keys are scoped to namespaces.
-    # Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}`
+    # Defined tags for this resource. Each key is predefined and scoped to a namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    # Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
     # 
     # @return [Hash<String, Hash<String, Object>>]
     attr_accessor :defined_tags
@@ -98,6 +111,17 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [String] :description The value to assign to the {#description} property
+    # @option attributes [String] :productType The value to assign to the {#product_type} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :inactiveStatus The value to assign to the {#inactive_status} property
+    # @option attributes [String] :protocol The value to assign to the {#protocol} property
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {#freeform_tags} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {#defined_tags} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/identity/models/idp_group_mapping.rb

@@ -3,6 +3,18 @@
 require 'date'
 
 module OCI
+  # A mapping between a single group defined by the identity provider (IdP) you're federating with
+  # and a single IAM Service {Group} in Oracle Cloud Infrastructure.
+  # For more information about group mappings and what they're for, see
+  # [Identity Providers and Federation](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm).
+  #
+  # A given IdP group can be mapped to zero, one, or multiple IAM Service groups, and vice versa.
+  # But each `IdPGroupMapping` object is between only a single IdP group and IAM Service group.
+  # Each `IdPGroupMapping` object has its own OCID.
+  #
+  # **Note:** Any users who are in more than 50 IdP groups cannot be authenticated to use the Oracle
+  # Cloud Infrastructure Console.
+  #
   class Identity::Models::IdpGroupMapping
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
@@ -12,34 +24,34 @@ module OCI
                 LIFECYCLE_STATE_DELETED = 'DELETED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the `IdpGroupMapping`.
+    # **[Required]** The OCID of the `IdpGroupMapping`.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the `IdentityProvider` this mapping belongs to.
+    # **[Required]** The OCID of the `IdentityProvider` this mapping belongs to.
     # @return [String]
     attr_accessor :idp_id
 
-    # The name of the IdP group that is mapped to the IAM Service group.
+    # **[Required]** The name of the IdP group that is mapped to the IAM Service group.
     # @return [String]
     attr_accessor :idp_group_name
 
-    # The OCID of the IAM Service group that is mapped to the IdP group.
+    # **[Required]** The OCID of the IAM Service group that is mapped to the IdP group.
     # @return [String]
     attr_accessor :group_id
 
-    # The OCID of the tenancy containing the `IdentityProvider`.
+    # **[Required]** The OCID of the tenancy containing the `IdentityProvider`.
     # @return [String]
     attr_accessor :compartment_id
 
-    # Date and time the mapping was created, in the format defined by RFC3339.
+    # **[Required]** Date and time the mapping was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The mapping's current state.  After creating a mapping object, make sure its `lifecycleState` changes
+    # **[Required]** The mapping's current state.  After creating a mapping object, make sure its `lifecycleState` changes
     # from CREATING to ACTIVE before using it.
     # 
     # @return [String]
@@ -52,6 +64,14 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :idpId The value to assign to the {#idp_id} property
+    # @option attributes [String] :idpGroupName The value to assign to the {#idp_group_name} property
+    # @option attributes [String] :groupId The value to assign to the {#group_id} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :inactiveStatus The value to assign to the {#inactive_status} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/identity/models/policy.rb

@@ -3,6 +3,20 @@
 require 'date'
 
 module OCI
+  # A document that specifies the type of access a group has to the resources in a compartment. For information about
+  # policies and other IAM Service components, see
+  # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). If you're new to policies, see
+  # [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
+  # The word \"policy\" is used by people in different ways:
+  #
+  #   * An individual statement written in the policy language
+  #   * A collection of statements in a single, named \"policy\" document (which has an Oracle Cloud ID (OCID) assigned to it)
+  #   * The overall body of policies your organization uses to control access to resources
+  #
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
+  # talk to an administrator.
+  #
   class Identity::Models::Policy
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
@@ -12,37 +26,37 @@ module OCI
                 LIFECYCLE_STATE_DELETED = 'DELETED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the policy.
+    # **[Required]** The OCID of the policy.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the compartment containing the policy (either the tenancy or another compartment).
+    # **[Required]** The OCID of the compartment containing the policy (either the tenancy or another compartment).
     # 
     # @return [String]
     attr_accessor :compartment_id
 
-    # The name you assign to the policy during creation. The name must be unique across all policies
+    # **[Required]** The name you assign to the policy during creation. The name must be unique across all policies
     # in the tenancy and cannot be changed.
     # 
     # @return [String]
     attr_accessor :name
 
-    # An array of one or more policy statements written in the policy language.
+    # **[Required]** An array of one or more policy statements written in the policy language.
     # @return [Array<String>]
     attr_accessor :statements
 
-    # The description you assign to the policy. Does not have to be unique, and it's changeable.
+    # **[Required]** The description you assign to the policy. Does not have to be unique, and it's changeable.
     # @return [String]
     attr_accessor :description
 
-    # Date and time the policy was created, in the format defined by RFC3339.
+    # **[Required]** Date and time the policy was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The policy's current state. After creating a policy, make sure its `lifecycleState` changes from CREATING to
+    # **[Required]** The policy's current state. After creating a policy, make sure its `lifecycleState` changes from CREATING to
     # ACTIVE before using it.
     # 
     # @return [String]
@@ -59,14 +73,16 @@ module OCI
     # @return [DateTime]
     attr_accessor :version_date
 
-    # Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
-    # Example: `{\"bar-key\": \"value\"}`
+    # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    # Example: `{\"Department\": \"Finance\"}`
     # 
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # Usage of predefined tag keys. These predefined keys are scoped to namespaces.
-    # Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}`
+    # Defined tags for this resource. Each key is predefined and scoped to a namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    # Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
     # 
     # @return [Hash<String, Hash<String, Object>>]
     attr_accessor :defined_tags
@@ -74,6 +90,17 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [Array<String>] :statements The value to assign to the {#statements} property
+    # @option attributes [String] :description The value to assign to the {#description} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :inactiveStatus The value to assign to the {#inactive_status} property
+    # @option attributes [DateTime] :versionDate The value to assign to the {#version_date} property
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {#freeform_tags} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {#defined_tags} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/identity/models/region.rb

@@ -3,6 +3,14 @@
 require 'date'
 
 module OCI
+  # A localized geographic area, such as Phoenix, AZ. Oracle Cloud Infrastructure is hosted in regions and Availability
+  # Domains. A region is composed of several Availability Domains. An Availability Domain is one or more data centers
+  # located within a region. For more information, see [Regions and Availability Domains](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm).
+  #
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
+  # talk to an administrator. If you're an administrator who needs to write policies to give users access,
+  # see [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
   class Identity::Models::Region
     # The key of the region.
     # 
@@ -27,6 +35,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :key The value to assign to the {#key} property
+    # @option attributes [String] :name The value to assign to the {#name} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/identity/models/region_subscription.rb

@@ -3,13 +3,20 @@
 require 'date'
 
 module OCI
+  # An object that represents your tenancy's access to a particular region (i.e., a subscription), the status of that
+  # access, and whether that region is the home region. For more information, see [Managing Regions](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingregions.htm).
+  #
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
+  # talk to an administrator. If you're an administrator who needs to write policies to give users access,
+  # see [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
   class Identity::Models::RegionSubscription
 
     STATUS_ENUM = [STATUS_READY = 'READY',
                 STATUS_IN_PROGRESS = 'IN_PROGRESS',
                 STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The region's key.
+    # **[Required]** The region's key.
     # 
     # Allowed values are:
     # - `PHX`
@@ -19,7 +26,7 @@ module OCI
     # @return [String]
     attr_accessor :region_key
 
-    # The region's name.
+    # **[Required]** The region's name.
     # 
     # Allowed values are:
     # - `us-phoenix-1`
@@ -29,17 +36,21 @@ module OCI
     # @return [String]
     attr_accessor :region_name
 
-    # The region subscription status.
+    # **[Required]** The region subscription status.
     # @return [String]
     attr_accessor :status
 
-    # Indicates if the region is the home region or not.
+    # **[Required]** Indicates if the region is the home region or not.
     # @return [BOOLEAN]
     attr_accessor :is_home_region
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :regionKey The value to assign to the {#region_key} property
+    # @option attributes [String] :regionName The value to assign to the {#region_name} property
+    # @option attributes [String] :status The value to assign to the {#status} property
+    # @option attributes [BOOLEAN] :isHomeRegion The value to assign to the {#is_home_region} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -58,7 +69,7 @@ module OCI
         self.status = attributes[:'status']
       end
 
-      if attributes[:'isHomeRegion']
+      unless attributes[:'isHomeRegion'].nil?
         self.is_home_region = attributes[:'isHomeRegion']
       end