Package com.oracle.bmc.identity.model

Class Group

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Group
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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 IAM.

    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.oracle.com/iaas/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 [Get Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

    *Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
    Note: Objects should always be created or deserialized using the Group.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Group.Builder, which maintain a set of all explicitly set fields called Group.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Group.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        The OCID of the group.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the tenancy containing the group.
        Returns:
        the value

      • getName

        public String getName()
        The name you assign to the group during creation.

        The name must be unique across all groups in the tenancy and cannot be changed.

        Returns:
        the value

      • getDescription

        public String getDescription()
        The description you assign to the group.

        Does not have to be unique, and it’s changeable.

        (For tenancies that support identity domains) You can have an empty description.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        Date and time the group was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getLifecycleState

        public Group.LifecycleState getLifecycleState()
        The group’s current state.

        After creating a group, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

        Returns:
        the value

      • getInactiveStatus

        public Long getInactiveStatus()
        The detailed status of INACTIVE lifecycleState.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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. Example: {“Department”: “Finance”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel