MyGroup¶
- class oci.identity_domains.models.MyGroup(**kwargs)¶
Bases:
objectThe Group resource.
Attributes:
A constant which can be used with the idcs_prevented_operations property of a MyGroup.
A constant which can be used with the idcs_prevented_operations property of a MyGroup.
A constant which can be used with the idcs_prevented_operations property of a MyGroup.
Gets the compartment_ocid of this MyGroup.
Gets the delete_in_progress of this MyGroup.
[Required] Gets the display_name of this MyGroup.
Gets the domain_ocid of this MyGroup.
Gets the external_id of this MyGroup.
Gets the id of this MyGroup.
Gets the idcs_created_by of this MyGroup.
Gets the idcs_last_modified_by of this MyGroup.
Gets the idcs_last_upgraded_in_release of this MyGroup.
Gets the idcs_prevented_operations of this MyGroup.
Gets the members of this MyGroup.
Gets the meta of this MyGroup.
Gets the non_unique_display_name of this MyGroup.
Gets the ocid of this MyGroup.
[Required] Gets the schemas of this MyGroup.
Gets the tags of this MyGroup.
Gets the tenancy_ocid of this MyGroup.
urn_ietf_params_scim_schemas_oracle_idcs_extension_group_groupGets the urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group of this MyGroup.
urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_groupGets the urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group of this MyGroup.
Methods:
__init__(**kwargs)Initializes a new MyGroup object with values from keyword arguments.
- IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'¶
A constant which can be used with the idcs_prevented_operations property of a MyGroup. This constant has a value of “delete”
- IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'¶
A constant which can be used with the idcs_prevented_operations property of a MyGroup. This constant has a value of “replace”
- IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'¶
A constant which can be used with the idcs_prevented_operations property of a MyGroup. This constant has a value of “update”
- __init__(**kwargs)¶
Initializes a new MyGroup object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this MyGroup.
ocid (str) – The value to assign to the ocid property of this MyGroup.
schemas (list[str]) – The value to assign to the schemas property of this MyGroup.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this MyGroup.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this MyGroup.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this MyGroup.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this MyGroup. Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
tags (list[oci.identity_domains.models.Tags]) – The value to assign to the tags property of this MyGroup.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this MyGroup.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this MyGroup.
domain_ocid (str) – The value to assign to the domain_ocid property of this MyGroup.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this MyGroup.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this MyGroup.
external_id (str) – The value to assign to the external_id property of this MyGroup.
display_name (str) – The value to assign to the display_name property of this MyGroup.
non_unique_display_name (str) – The value to assign to the non_unique_display_name property of this MyGroup.
members (list[oci.identity_domains.models.MyGroupMembers]) – The value to assign to the members property of this MyGroup.
urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group (oci.identity_domains.models.ExtensionGroupGroup) – The value to assign to the urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group property of this MyGroup.
urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group (oci.identity_domains.models.ExtensionPosixGroup) – The value to assign to the urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group property of this MyGroup.
- property compartment_ocid¶
Gets the compartment_ocid of this MyGroup. OCI Compartment Id (ocid) in which the resource lives.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none
- Returns
The compartment_ocid of this MyGroup.
- Return type
str
- property delete_in_progress¶
Gets the delete_in_progress of this MyGroup. A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readOnly
required: false
returned: default
type: boolean
uniqueness: none
- Returns
The delete_in_progress of this MyGroup.
- Return type
bool
- property display_name¶
[Required] Gets the display_name of this MyGroup. The Group display name.
- SCIM++ Properties:
caseExact: false
idcsCsvAttributeName: Display Name
idcsCsvAttributeNameMappings: [[columnHeaderName:Name, deprecatedColumnHeaderName:Display Name]]
idcsSearchable: true
multiValued: false
mutability: readWrite
required: true
returned: always
type: string
uniqueness: global
- Returns
The display_name of this MyGroup.
- Return type
str
- property domain_ocid¶
Gets the domain_ocid of this MyGroup. OCI Domain Id (ocid) in which the resource lives.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none
- Returns
The domain_ocid of this MyGroup.
- Return type
str
- property external_id¶
Gets the external_id of this MyGroup. An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer’s tenant.
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
- Returns
The external_id of this MyGroup.
- Return type
str
- property id¶
Gets the id of this MyGroup. Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readOnly
required: false
returned: always
type: string
uniqueness: global
- Returns
The id of this MyGroup.
- Return type
str
- property idcs_created_by¶
Gets the idcs_created_by of this MyGroup.
- Returns
The idcs_created_by of this MyGroup.
- Return type
- property idcs_last_modified_by¶
Gets the idcs_last_modified_by of this MyGroup.
- Returns
The idcs_last_modified_by of this MyGroup.
- Return type
- property idcs_last_upgraded_in_release¶
Gets the idcs_last_upgraded_in_release of this MyGroup. The release number when the resource was upgraded.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: request
type: string
uniqueness: none
- Returns
The idcs_last_upgraded_in_release of this MyGroup.
- Return type
str
- property idcs_prevented_operations¶
Gets the idcs_prevented_operations of this MyGroup. Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
- SCIM++ Properties:
idcsSearchable: false
multiValued: true
mutability: readOnly
required: false
returned: request
type: string
uniqueness: none
Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The idcs_prevented_operations of this MyGroup.
- Return type
list[str]
- property members¶
Gets the members of this MyGroup. The 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.
- SCIM++ Properties:
caseExact: false
idcsCompositeKey: [value]
idcsCsvAttributeNameMappings: [[columnHeaderName:User Members, mapsTo:members[User].value, multiValueDelimiter:;]]
idcsSearchable: true
multiValued: true
mutability: readWrite
required: false
returned: request
idcsPaginateResponse: true
type: complex
uniqueness: none
- Returns
The members of this MyGroup.
- Return type
- property meta¶
Gets the meta of this MyGroup.
- Returns
The meta of this MyGroup.
- Return type
- property non_unique_display_name¶
Gets the non_unique_display_name of this MyGroup. A human readable name for the group as defined by the Service Consumer.
Added In: 2011192329
- SCIM++ Properties:
caseExact: false
idcsCsvAttributeName: Non-Unique Display Name
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: always
type: string
- Returns
The non_unique_display_name of this MyGroup.
- Return type
str
- property ocid¶
Gets the ocid of this MyGroup. Unique OCI identifier for the SCIM Resource.
- SCIM++ Properties:
caseExact: true
idcsSearchable: true
multiValued: false
mutability: immutable
required: false
returned: default
type: string
uniqueness: global
- Returns
The ocid of this MyGroup.
- Return type
str
- property schemas¶
[Required] Gets the schemas of this MyGroup. REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard “enterprise” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: true
mutability: readWrite
required: true
returned: default
type: string
uniqueness: none
- Returns
The schemas of this MyGroup.
- Return type
list[str]
- property tags¶
Gets the tags of this MyGroup. A list of tags on this resource.
- SCIM++ Properties:
idcsCompositeKey: [key, value]
idcsSearchable: true
multiValued: true
mutability: readWrite
required: false
returned: request
type: complex
uniqueness: none
- Returns
The tags of this MyGroup.
- Return type
- property tenancy_ocid¶
Gets the tenancy_ocid of this MyGroup. OCI Tenant Id (ocid) in which the resource lives.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none
- Returns
The tenancy_ocid of this MyGroup.
- Return type
str
- property urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group¶
Gets the urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group of this MyGroup.
- Returns
The urn_ietf_params_scim_schemas_oracle_idcs_extension_group_group of this MyGroup.
- Return type
- property urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group¶
Gets the urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group of this MyGroup.
- Returns
The urn_ietf_params_scim_schemas_oracle_idcs_extension_posix_group of this MyGroup.
- Return type