GroupMembers¶
- class oci.identity_domains.models.GroupMembers(**kwargs)¶
Bases:
objectThe group members. <b>Important:</b> When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use ‘startIndex’ and ‘count’ to return members in pages instead of in a single response, for example: #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant.
Attributes:
A constant which can be used with the type property of a GroupMembers.
Gets the date_added of this GroupMembers.
Gets the display of this GroupMembers.
Gets the membership_ocid of this GroupMembers.
Gets the name of this GroupMembers.
Gets the ocid of this GroupMembers.
Gets the ref of this GroupMembers.
[Required] Gets the type of this GroupMembers.
[Required] Gets the value of this GroupMembers.
Methods:
__init__(**kwargs)Initializes a new GroupMembers object with values from keyword arguments.
- TYPE_USER = 'User'¶
A constant which can be used with the type property of a GroupMembers. This constant has a value of “User”
- __init__(**kwargs)¶
Initializes a new GroupMembers object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
value (str) – The value to assign to the value property of this GroupMembers.
date_added (str) – The value to assign to the date_added property of this GroupMembers.
ocid (str) – The value to assign to the ocid property of this GroupMembers.
membership_ocid (str) – The value to assign to the membership_ocid property of this GroupMembers.
ref (str) – The value to assign to the ref property of this GroupMembers.
display (str) – The value to assign to the display property of this GroupMembers.
type (str) – The value to assign to the type property of this GroupMembers. Allowed values for this property are: “User”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
name (str) – The value to assign to the name property of this GroupMembers.
- property date_added¶
Gets the date_added of this GroupMembers. The date and time that the member was added to the group.
Added In: 2012271618
- SCIM++ Properties:
caseExact: false
multiValued: false
mutability: readOnly
returned: default
type: dateTime
uniqueness: none
- Returns
The date_added of this GroupMembers.
- Return type
str
- property display¶
Gets the display of this GroupMembers. The member’s display name.
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none
- Returns
The display of this GroupMembers.
- Return type
str
- property membership_ocid¶
Gets the membership_ocid of this GroupMembers. The membership OCID.
Added In: 2102181953
- SCIM++ Properties:
caseExact: true
idcsSearchable: true
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none
- Returns
The membership_ocid of this GroupMembers.
- Return type
str
- property name¶
Gets the name of this GroupMembers. The member’s name.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none
- Returns
The name of this GroupMembers.
- Return type
str
- property ocid¶
Gets the ocid of this GroupMembers. The OCID of the member of this group.
Added In: 2012271618
- SCIM++ Properties:
caseExact: true
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: always
type: string
uniqueness: none
- Returns
The ocid of this GroupMembers.
- Return type
str
- property ref¶
Gets the ref of this GroupMembers. The URI that corresponds to the member Resource of this group.
- SCIM++ Properties:
caseExact: true
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: reference
uniqueness: none
- Returns
The ref of this GroupMembers.
- Return type
str
- property type¶
[Required] Gets the type of this GroupMembers. Indicates the type of resource, for example, User or Group.
- SCIM++ Properties:
caseExact: true
idcsSearchable: true
idcsDefaultValue: User
multiValued: false
mutability: readWrite
required: true
returned: default
type: string
uniqueness: none
Allowed values for this property are: “User”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this GroupMembers.
- Return type
str
- property value¶
[Required] Gets the value of this GroupMembers. The ID of the member of this Group
- SCIM++ Properties:
caseExact: true
idcsSearchable: true
multiValued: false
mutability: readWrite
required: true
returned: always
type: string
uniqueness: none
- Returns
The value of this GroupMembers.
- Return type
str