MsgraphgroupsanduserClient

Classes

ListUsersResponse dataclass

ListUsersResponse(context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List Users

Attributes

context class-attribute instance-attribute

context: Optional[str] = field(default=None, metadata={'wire_name': '@odata.context'})

The Odata.context link.

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = None

value

ListGroupsByDisplayNameSearchResponse dataclass

ListGroupsByDisplayNameSearchResponse(context: Optional[str] = None, count: Optional[int] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List Groups By Display Name Search

Attributes

context class-attribute instance-attribute

context: Optional[str] = field(default=None, metadata={'wire_name': '@odata.context'})

The Odata.context link.

count class-attribute instance-attribute

count: Optional[int] = field(default=None, metadata={'wire_name': '@odata.count'})

@odata.count

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = None

value

ListSubscribedSkusResponse dataclass

ListSubscribedSkusResponse(context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List Subscribed Skus

Attributes

context class-attribute instance-attribute

context: Optional[str] = field(default=None, metadata={'wire_name': '@odata.context'})

The Odata.context link.

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = None

value

ListDirectGroupMembersResponse dataclass

ListDirectGroupMembersResponse(context: Optional[str] = None, count: Optional[int] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List Direct Group Members

Attributes

context class-attribute instance-attribute

context: Optional[str] = field(default=None, metadata={'wire_name': '@odata.context'})

The Odata.context link.

count class-attribute instance-attribute

count: Optional[int] = field(default=None, metadata={'wire_name': '@odata.count'})

@odata.count

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = None

value

GetMemberLicenseDetailsResponse dataclass

GetMemberLicenseDetailsResponse(context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for Get Member License Details

Attributes

context class-attribute instance-attribute

context: Optional[str] = field(default=None, metadata={'wire_name': '@odata.context'})

The Odata.context link.

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = None

value

GetGroupPropertiesResponse dataclass

GetGroupPropertiesResponse(context: Optional[str] = None, id: Optional[str] = None, deleted_date_time: Optional[str] = None, classification: Optional[str] = None, created_date_time: Optional[str] = None, creation_options: Optional[List[str]] = None, description: Optional[str] = None, display_name: Optional[str] = None, expiration_date_time: Optional[str] = None, group_types: Optional[List[str]] = None, is_assignable_to_role: Optional[str] = None, mail: Optional[str] = None, mail_enabled: Optional[bool] = None, mail_nickname: Optional[str] = None, membership_rule: Optional[str] = None, membership_rule_processing_state: Optional[str] = None, on_premises_domain_name: Optional[str] = None, on_premises_last_sync_date_time: Optional[str] = None, on_premises_net_bios_name: Optional[str] = None, on_premises_sam_account_name: Optional[str] = None, on_premises_security_identifier: Optional[str] = None, on_premises_sync_enabled: Optional[bool] = None, preferred_data_location: Optional[str] = None, preferred_language: Optional[str] = None, proxy_addresses: Optional[List[str]] = None, renewed_date_time: Optional[str] = None, resource_behavior_options: Optional[List[str]] = None, resource_provisioning_options: Optional[List[str]] = None, security_enabled: Optional[bool] = None, security_identifier: Optional[str] = None, theme: Optional[str] = None, visibility: Optional[str] = None, on_premises_provisioning_errors: Optional[List[str]] = None)

Response for Get Group Properties

Attributes

context class-attribute instance-attribute

context: Optional[str] = field(default=None, metadata={'wire_name': '@odata.context'})

The Odata.context link.

id class-attribute instance-attribute

id: Optional[str] = None

Object id of the group

deleted_date_time class-attribute instance-attribute

deleted_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'deletedDateTime'})

Group's deletion date time

classification class-attribute instance-attribute

classification: Optional[str] = None

classification

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

Group's creation date time

creation_options class-attribute instance-attribute

creation_options: Optional[List[str]] = field(default=None, metadata={'wire_name': 'creationOptions'})

Created options of the group.

description class-attribute instance-attribute

description: Optional[str] = None

description

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Group's display name

expiration_date_time class-attribute instance-attribute

expiration_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'expirationDateTime'})

Group's expiration date time

group_types class-attribute instance-attribute

group_types: Optional[List[str]] = field(default=None, metadata={'wire_name': 'groupTypes'})

Group types for the group.

is_assignable_to_role class-attribute instance-attribute

is_assignable_to_role: Optional[str] = field(default=None, metadata={'wire_name': 'isAssignableToRole'})

Can a role be assigned to this group?

mail class-attribute instance-attribute

mail: Optional[str] = None

Group's email

mail_enabled class-attribute instance-attribute

mail_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'mailEnabled'})

Is group email enabled?

mail_nickname class-attribute instance-attribute

mail_nickname: Optional[str] = field(default=None, metadata={'wire_name': 'mailNickname'})

Group's email nick name

membership_rule class-attribute instance-attribute

membership_rule: Optional[str] = field(default=None, metadata={'wire_name': 'membershipRule'})

The rule that is used for membership evaluation.

membership_rule_processing_state class-attribute instance-attribute

membership_rule_processing_state: Optional[str] = field(default=None, metadata={'wire_name': 'membershipRuleProcessingState'})

The processing state of the rule that is used for membership evaluation.

on_premises_domain_name class-attribute instance-attribute

on_premises_domain_name: Optional[str] = field(default=None, metadata={'wire_name': 'onPremisesDomainName'})

Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory.

on_premises_last_sync_date_time class-attribute instance-attribute

on_premises_last_sync_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'onPremisesLastSyncDateTime'})

The time and date at which the tenant was last synced with the on-premise directory.

on_premises_net_bios_name class-attribute instance-attribute

on_premises_net_bios_name: Optional[str] = field(default=None, metadata={'wire_name': 'onPremisesNetBiosName'})

Name of networking service for on-premise server.

on_premises_sam_account_name class-attribute instance-attribute

on_premises_sam_account_name: Optional[str] = field(default=None, metadata={'wire_name': 'onPremisesSamAccountName'})

Sam account name for on-premise directory.

on_premises_security_identifier class-attribute instance-attribute

on_premises_security_identifier: Optional[str] = field(default=None, metadata={'wire_name': 'onPremisesSecurityIdentifier'})

The on-premises security identifier.

on_premises_sync_enabled class-attribute instance-attribute

on_premises_sync_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'onPremisesSyncEnabled'})

True if on-premises sync is enabled for the group.

preferred_data_location class-attribute instance-attribute

preferred_data_location: Optional[str] = field(default=None, metadata={'wire_name': 'preferredDataLocation'})

Preferred data location of the group.

preferred_language class-attribute instance-attribute

preferred_language: Optional[str] = field(default=None, metadata={'wire_name': 'preferredLanguage'})

Preferred language as configured in Microsoft Entra ID.

proxy_addresses class-attribute instance-attribute

proxy_addresses: Optional[List[str]] = field(default=None, metadata={'wire_name': 'proxyAddresses'})

Proxy addresses of the group.

renewed_date_time class-attribute instance-attribute

renewed_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'renewedDateTime'})

Renewed date time of the group.

resource_behavior_options class-attribute instance-attribute

resource_behavior_options: Optional[List[str]] = field(default=None, metadata={'wire_name': 'resourceBehaviorOptions'})

Resource behavior options of the group.

resource_provisioning_options class-attribute instance-attribute

resource_provisioning_options: Optional[List[str]] = field(default=None, metadata={'wire_name': 'resourceProvisioningOptions'})

Resource provisioning options of the group.

security_enabled class-attribute instance-attribute

security_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'securityEnabled'})

Indicates if the group is security enabled.

security_identifier class-attribute instance-attribute

security_identifier: Optional[str] = field(default=None, metadata={'wire_name': 'securityIdentifier'})

Security identifier of the group.

theme class-attribute instance-attribute

theme: Optional[str] = None

Theme of Microsoft Entra ID group.

visibility class-attribute instance-attribute

visibility: Optional[str] = None

Visibility of the group.

on_premises_provisioning_errors class-attribute instance-attribute

on_premises_provisioning_errors: Optional[List[str]] = field(default=None, metadata={'wire_name': 'onPremisesProvisioningErrors'})

On premise provisioning errors of the group.

GetMemberGroupsInput dataclass

GetMemberGroupsInput(security_enabled_only: Optional[bool] = None)

Get Member Groups

Attributes

security_enabled_only class-attribute instance-attribute

security_enabled_only: Optional[bool] = field(default=None, metadata={'wire_name': 'securityEnabledOnly'})

Do you want to retrieve security enabled groups only?

GetMemberGroupsResponse dataclass

GetMemberGroupsResponse(context: Optional[str] = None, value: Optional[List[str]] = None)

Response for Get Member Groups

Attributes

context class-attribute instance-attribute

context: Optional[str] = field(default=None, metadata={'wire_name': '@odata.context'})

The Odata.context link.

value class-attribute instance-attribute

value: Optional[List[str]] = None

value

MsgraphgroupsanduserClient

MsgraphgroupsanduserClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for msgraphgroupsanduser connector.

Initialize a MsgraphgroupsanduserClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

list_users_async async

list_users_async() -> dict[str, Any] | None

List Users

Retrieve all users in the organization (Microsoft Entra ID Tenant)

list_groups_by_display_name_search_async async

list_groups_by_display_name_search_async(search: Optional[str] = None) -> dict[str, Any] | None

List Groups By Display Name Search

Retrieve groups by searching group's display name

list_subscribed_skus_async async

list_subscribed_skus_async() -> dict[str, Any] | None

List Subscribed Skus

Details of organization's subscribed license plan SKUs

list_direct_group_members_async async

list_direct_group_members_async(group_id: str, filter: Optional[str] = None, select: Optional[str] = None) -> dict[str, Any] | None

List Direct Group Members

Retrieve direct members of a group with count

get_member_license_details_async async

get_member_license_details_async(id: str, select: Optional[str] = None) -> dict[str, Any] | None

Get Member License Details

Retrieve group member(user)'s license details

get_group_properties_async async

get_group_properties_async(group_id: str) -> dict[str, Any] | None

Get Group Properties

Retrieve properties and relationships of an Microsoft Entra ID group

get_member_groups_async async

get_member_groups_async(input: GetMemberGroupsInput, member_id: str) -> dict[str, Any] | None

Get Member Groups

Group memberships for a user (member)