Show / Hide Table of Contents

Class UserGroupMembership

An object that represents the membership of a user in a group. When you add a user to a group, the result is a UserGroupMembership with its own OCID. To remove a user from a group, you delete the UserGroupMembership object.

Inheritance
object
UserGroupMembership
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class UserGroupMembership

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the tenancy containing the user, group, and membership object.

Remarks

Required

GroupId

Declaration
[Required(ErrorMessage = "GroupId is required.")]
[JsonProperty(PropertyName = "groupId")]
public string GroupId { get; set; }
Property Value
Type Description
string

The OCID of the group.

Remarks

Required

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the membership.

Remarks

Required

InactiveStatus

Declaration
[JsonProperty(PropertyName = "inactiveStatus")]
public long? InactiveStatus { get; set; }
Property Value
Type Description
long?

The detailed status of INACTIVE lifecycleState.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public UserGroupMembership.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
UserGroupMembership.LifecycleStateEnum?

The membership's current state. After creating a membership object, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

Date and time the membership was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z

Remarks

Required

UserId

Declaration
[Required(ErrorMessage = "UserId is required.")]
[JsonProperty(PropertyName = "userId")]
public string UserId { get; set; }
Property Value
Type Description
string

The OCID of the user.

Remarks

Required

In this article
Back to top