MsgraphgroupsanduserClient
Classes
dataclass
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
class-attribute
instance-attribute
context: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.context'})
The Odata.context link.
dataclass
ListSubscribedSkusResponse(*, context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)
dataclass
ListDirectGroupMembersResponse(*, context: Optional[str] = None, count: Optional[int] = None, value: Optional[List[Dict[str, Any]]] = None)
Response for List Direct Group Members
Attributes
class-attribute
instance-attribute
context: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.context'})
The Odata.context link.
dataclass
GetMemberLicenseDetailsResponse(*, context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)
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
class-attribute
instance-attribute
context: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.context'})
The Odata.context link.
class-attribute
instance-attribute
Object id of the group
class-attribute
instance-attribute
deleted_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'deletedDateTime'})
Group's deletion date time
class-attribute
instance-attribute
classification
class-attribute
instance-attribute
created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})
Group's creation date time
class-attribute
instance-attribute
creation_options: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creationOptions'})
Created options of the group.
class-attribute
instance-attribute
description
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})
Group's display name
class-attribute
instance-attribute
expiration_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'expirationDateTime'})
Group's expiration date time
class-attribute
instance-attribute
group_types: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'groupTypes'})
Group types for the group.
class-attribute
instance-attribute
is_assignable_to_role: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isAssignableToRole'})
Can a role be assigned to this group?
class-attribute
instance-attribute
Group's email
class-attribute
instance-attribute
mail_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mailEnabled'})
Is group email enabled?
class-attribute
instance-attribute
mail_nickname: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mailNickname'})
Group's email nick name
class-attribute
instance-attribute
membership_rule: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'membershipRule'})
The rule that is used for membership evaluation.
class-attribute
instance-attribute
membership_rule_processing_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'membershipRuleProcessingState'})
The processing state of the rule that is used for membership evaluation.
class-attribute
instance-attribute
on_premises_domain_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'onPremisesDomainName'})
Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory.
class-attribute
instance-attribute
on_premises_last_sync_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'onPremisesLastSyncDateTime'})
The time and date at which the tenant was last synced with the on-premise directory.
class-attribute
instance-attribute
on_premises_net_bios_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'onPremisesNetBiosName'})
Name of networking service for on-premise server.
class-attribute
instance-attribute
on_premises_sam_account_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'onPremisesSamAccountName'})
Sam account name for on-premise directory.
class-attribute
instance-attribute
on_premises_security_identifier: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'onPremisesSecurityIdentifier'})
The on-premises security identifier.
class-attribute
instance-attribute
on_premises_sync_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'onPremisesSyncEnabled'})
True if on-premises sync is enabled for the group.
class-attribute
instance-attribute
preferred_data_location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'preferredDataLocation'})
Preferred data location of the group.
class-attribute
instance-attribute
preferred_language: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'preferredLanguage'})
Preferred language as configured in Microsoft Entra ID.
class-attribute
instance-attribute
proxy_addresses: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'proxyAddresses'})
Proxy addresses of the group.
class-attribute
instance-attribute
renewed_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'renewedDateTime'})
Renewed date time of the group.
class-attribute
instance-attribute
resource_behavior_options: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceBehaviorOptions'})
Resource behavior options of the group.
class-attribute
instance-attribute
resource_provisioning_options: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceProvisioningOptions'})
Resource provisioning options of the group.
class-attribute
instance-attribute
security_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'securityEnabled'})
Indicates if the group is security enabled.
class-attribute
instance-attribute
security_identifier: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'securityIdentifier'})
Security identifier of the group.
class-attribute
instance-attribute
Theme of Microsoft Entra ID group.
class-attribute
instance-attribute
Visibility of the group.
dataclass
dataclass
MsgraphgroupsanduserClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
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 |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
list_users(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List Users
Retrieve all users in the organization (Microsoft Entra ID Tenant)
Returns a single-page Azure Core async collection.
Swagger operation ID: ListUsers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_groups_by_display_name_search(*, search: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List Groups By Display Name Search
Retrieve groups by searching group's display name
Returns a single-page Azure Core async collection.
Swagger operation ID: ListGroupsByDisplayNameSearch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
search
|
Optional[str]
|
Search by keyword in display name of the Microsoft Entra ID group. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_subscribed_skus(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List Subscribed Skus
Details of organization's subscribed license plan SKUs
Returns a single-page Azure Core async collection.
Swagger operation ID: ListSubscribedSkus.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_direct_group_members(group_id: str, *, filter: Optional[str] = None, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List Direct Group Members
Retrieve direct members of a group with count
Returns a single-page Azure Core async collection.
Swagger operation ID: ListDirectGroupMembers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group_id
|
str
|
Object ID of the Microsoft Entra ID group. |
required |
filter
|
Optional[str]
|
Filter By. |
None
|
select
|
Optional[str]
|
Select which columns to retrieve. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_member_license_details(id: str, *, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Member License Details
Retrieve group member(user)'s license details
Returns a single-page Azure Core async collection.
Swagger operation ID: GetMemberLicenseDetails.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
Object ID of the Microsoft Entra ID member(user). |
required |
select
|
Optional[str]
|
Selection of data points(columns). |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_group_properties(group_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Group Properties
Retrieve properties and relationships of an Microsoft Entra ID group
Swagger operation ID: GetGroupProperties.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group_id
|
str
|
Object ID of the Microsoft Entra ID group. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_member_groups(input: GetMemberGroupsInput | Mapping[str, Any], member_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[str]
Get Member Groups
Group memberships for a user (member)
Returns a single-page Azure Core async collection.
Swagger operation ID: GetMemberGroups.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetMemberGroupsInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
member_id
|
str
|
Object ID of the Microsoft Entra ID member(user). |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[str]
|
AsyncItemPaged[str]: An Azure Core pager over connector results.
Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |