Skip to content

GroupDomainGetAssignedUserListRequest

Bases: OCIRequest

Request a list of users within in a group that have a given domain assigned. The response is either GroupDomainGetAssignedUserListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

domain (str):

response_size_limit (Optional[int]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
Source code in src/mercury_ocip_fast/commands/commands.py 
46222
46223
46224
46225
46226
46227
46228
46229
46230
46231
46232
46233
46234
46235
46236
46237
46238
46239
46240
46241
46242
46243
46244
46245
46246
46247
46248
46249
46250
46251
46252
46253
46254
46255
46256
46257
46258
46259
46260
46261
46262
46263
46264
46265
46266
46267
46268
46269
46270
46271
46272
46273
46274
46275
46276
46277
46278
46279
46280
46281
46282
46283
46284
46285
46286
46287
46288
46289
@dataclass(kw_only=True)
class GroupDomainGetAssignedUserListRequest(OCIRequest):
    """Request a list of users within in a group that have a given domain assigned.
        The response is either GroupDomainGetAssignedUserListResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        domain (str):

        response_size_limit (Optional[int]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    domain: str = field(metadata={"alias": "domain"})

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

    search_criteria_user_first_name: Optional[List[SearchCriteriaUserFirstName]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserFirstName"})
    )

    search_criteria_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

    search_criteria_email_address: Optional[List[SearchCriteriaEmailAddress]] = field(
        default=None, metadata={"alias": "searchCriteriaEmailAddress"}
    )

    search_criteria_exact_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_extension: Optional[List[SearchCriteriaExtension]] = field(
        default=None, metadata={"alias": "searchCriteriaExtension"}
    )

Responses

Bases: OCIDataResponse

Response to GroupDomainGetAssignedUserListRequest. The table columns are: "User Id", "Last Name", "First Name", "Department", "Phone Number", "Email Address", "Service Provider Id", "Group Id", "Hiragana Last Name" and "Hiragana First Name", "Extension".

Attributes:

user_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py 
125560
125561
125562
125563
125564
125565
125566
125567
125568
125569
125570
125571
125572
@dataclass(kw_only=True)
class GroupDomainGetAssignedUserListResponse(OCIDataResponse):
    """Response to GroupDomainGetAssignedUserListRequest.
        The table columns are: \"User Id\", \"Last Name\", \"First Name\", \"Department\", \"Phone Number\", \"Email Address\",
        \"Service Provider Id\", \"Group Id\", \"Hiragana Last Name\" and \"Hiragana First Name\", \"Extension\".

    Attributes:

        user_table (OCITable):

    """

    user_table: OCITable = field(metadata={"alias": "userTable"})

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py 
115
116
117
118
119
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupDomainGetAssignedUserListRequest

client = Client()

command = GroupDomainGetAssignedUserListRequest(
    service_provider_id=...,
    group_id=...,
    domain=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_email_address=...,
    search_criteria_exact_user_department=...,
    search_criteria_user_id=...,
    search_criteria_extension=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupDomainGetAssignedUserListRequest",
    service_provider_id=...,
    group_id=...,
    domain=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_email_address=...,
    search_criteria_exact_user_department=...,
    search_criteria_user_id=...,
    search_criteria_extension=...,
)

print(response)