AzureadClient

Attributes

GetMemberGroupsResponse module-attribute

GetMemberGroupsResponse = List[str]

Classes

CreateOffice365GroupInput dataclass

CreateOffice365GroupInput(display_name: str, description: str, mail_nickname: str, group_types: List[str], security_enabled: bool, mail_enabled: bool)

Create Office 365 group

Attributes

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

Display name of the new group.

description instance-attribute

description: str

Description of the new group.

mail_nickname class-attribute instance-attribute

mail_nickname: str = dataclass_field(metadata={'wire_name': 'mailNickname'})

The mail alias of the new group.

group_types class-attribute instance-attribute

group_types: List[str] = dataclass_field(metadata={'wire_name': 'groupTypes'})

For Office 365, group type is 'Unified'.

security_enabled class-attribute instance-attribute

security_enabled: bool = dataclass_field(metadata={'wire_name': 'securityEnabled'})

True if the new group is a security group.

mail_enabled class-attribute instance-attribute

mail_enabled: bool = dataclass_field(metadata={'wire_name': 'mailEnabled'})

True if the new group is a mailing group.

CreateGroupResponse dataclass

CreateGroupResponse(*, context: Optional[str] = None, id: Optional[str] = None, deleted_date_time: Optional[str] = None, classification: Optional[str] = None, created_date_time: Optional[str] = None, description: Optional[str] = None, display_name: Optional[str] = None, group_types: Optional[List[str]] = None, mail: Optional[str] = None, mail_enabled: Optional[bool] = None, mail_nickname: Optional[str] = None, on_premises_last_sync_date_time: Optional[str] = None, on_premises_security_identifier: Optional[str] = None, on_premises_sync_enabled: Optional[bool] = None, proxy_addresses: Optional[List[str]] = None, renewed_date_time: Optional[str] = None, security_enabled: Optional[bool] = None, visibility: Optional[str] = None)

Response for Create Office 365 group

Attributes

context class-attribute instance-attribute

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

@odata.context

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

id

deleted_date_time class-attribute instance-attribute

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

deletedDateTime

classification class-attribute instance-attribute

classification: Optional[str] = dataclass_field(default=None, kw_only=True)

classification

created_date_time class-attribute instance-attribute

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

createdDateTime

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

description

display_name class-attribute instance-attribute

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

displayName

group_types class-attribute instance-attribute

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

groupTypes

mail class-attribute instance-attribute

mail: Optional[str] = dataclass_field(default=None, kw_only=True)

mail

mail_enabled class-attribute instance-attribute

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

mailEnabled

mail_nickname class-attribute instance-attribute

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

mailNickname

on_premises_last_sync_date_time class-attribute instance-attribute

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

onPremisesLastSyncDateTime

on_premises_security_identifier class-attribute instance-attribute

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

onPremisesSecurityIdentifier

on_premises_sync_enabled class-attribute instance-attribute

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

onPremisesSyncEnabled

proxy_addresses class-attribute instance-attribute

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

proxyAddresses

renewed_date_time class-attribute instance-attribute

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

renewedDateTime

security_enabled class-attribute instance-attribute

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

securityEnabled

visibility class-attribute instance-attribute

visibility: Optional[str] = dataclass_field(default=None, kw_only=True)

visibility

CreateSecurityGroupInput dataclass

CreateSecurityGroupInput(display_name: str, description: str, mail_nickname: str, security_enabled: bool, mail_enabled: bool)

Create security group

Attributes

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

Display name of the new group.

description instance-attribute

description: str

Description of the new group.

mail_nickname class-attribute instance-attribute

mail_nickname: str = dataclass_field(metadata={'wire_name': 'mailNickname'})

The mail alias of the new group.

security_enabled class-attribute instance-attribute

security_enabled: bool = dataclass_field(metadata={'wire_name': 'securityEnabled'})

True if the new group is a security group.

mail_enabled class-attribute instance-attribute

mail_enabled: bool = dataclass_field(metadata={'wire_name': 'mailEnabled'})

True if the new group is a mailing group.

GetGroupResponse dataclass

GetGroupResponse(*, id: Optional[str] = None, deleted_date_time: Optional[str] = None, created_date_time: Optional[str] = None, description: Optional[str] = None, display_name: Optional[str] = None, mail: Optional[str] = None, mail_enabled: Optional[bool] = None, on_premises_last_sync_date_time: Optional[str] = None, on_premises_sync_enabled: Optional[bool] = None, security_enabled: Optional[bool] = None, visibility: Optional[str] = None)

Response for Get group

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique identifier for the group.

deleted_date_time class-attribute instance-attribute

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

Date-time the group was deleted.

created_date_time class-attribute instance-attribute

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

Date-time the group was created.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

An optional description for the group.

display_name class-attribute instance-attribute

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

The display name for the group.

mail class-attribute instance-attribute

mail: Optional[str] = dataclass_field(default=None, kw_only=True)

The SMTP address for the group.

mail_enabled class-attribute instance-attribute

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

True if the group is mail-enabled.

on_premises_last_sync_date_time class-attribute instance-attribute

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

A date-time indicating the last time at which the group was synced with the on-premises directory.

on_premises_sync_enabled class-attribute instance-attribute

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

True if this group is synced from an on-premises directory.

security_enabled class-attribute instance-attribute

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

True if the group is a security group.

visibility class-attribute instance-attribute

visibility: Optional[str] = dataclass_field(default=None, kw_only=True)

Visibility of the group (public or private).

GetUserResponse dataclass

GetUserResponse(*, id: Optional[str] = None, business_phones: Optional[List[str]] = None, display_name: Optional[str] = None, given_name: Optional[str] = None, job_title: Optional[str] = None, mail: Optional[str] = None, mobile_phone: Optional[str] = None, office_location: Optional[str] = None, preferred_language: Optional[str] = None, surname: Optional[str] = None, user_principal_name: Optional[str] = None)

Response for Get user

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

A unique identifier for the user.

display_name class-attribute instance-attribute

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

The name displayed in the address book for the user.

given_name class-attribute instance-attribute

given_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'givenName'})

The given name (first name) of the user.

job_title class-attribute instance-attribute

job_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobTitle'})

The user's job title.

mail class-attribute instance-attribute

mail: Optional[str] = dataclass_field(default=None, kw_only=True)

The SMTP address for the user.

mobile_phone class-attribute instance-attribute

mobile_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mobilePhone'})

The primary cellular telephone number for the user.

office_location class-attribute instance-attribute

office_location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'officeLocation'})

The office location in the user's place of business.

preferred_language class-attribute instance-attribute

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

The preferred language for the user. Should follow ISO 639-1 Code; for example 'en-US'.

surname class-attribute instance-attribute

surname: Optional[str] = dataclass_field(default=None, kw_only=True)

The user's surname (family name or last name).

user_principal_name class-attribute instance-attribute

user_principal_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userPrincipalName'})

The user principal name (UPN) of the user.

GetGroupMembersResponse dataclass

GetGroupMembersResponse(*, next_link: Optional[str] = None, value: Optional[List[GetUserResponse | Mapping[str, Any]]] = None)

Response for Get group members

Attributes

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

Link to get next page of results

value class-attribute instance-attribute

value: Optional[List[GetUserResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Array of users that are members of the group.

CreateGroupInput dataclass

CreateGroupInput(display_name: str, description: str, mail_nickname: str, group_types: List[str], security_enabled: bool, mail_enabled: bool)

Create group

Attributes

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

Display name of the new group.

description instance-attribute

description: str

Description of the new group.

mail_nickname class-attribute instance-attribute

mail_nickname: str = dataclass_field(metadata={'wire_name': 'mailNickname'})

The mail alias of the new group.

group_types class-attribute instance-attribute

group_types: List[str] = dataclass_field(metadata={'wire_name': 'groupTypes'})

Choose 'Unified' for an O365 group. Choose 'None' for a security group.

security_enabled class-attribute instance-attribute

security_enabled: bool = dataclass_field(metadata={'wire_name': 'securityEnabled'})

True if the new group is a security group.

mail_enabled class-attribute instance-attribute

mail_enabled: bool = dataclass_field(metadata={'wire_name': 'mailEnabled'})

True if the new group is a mailing group.

GetMemberGroupsResponseV2 dataclass

GetMemberGroupsResponseV2(*, value: Optional[GetMemberGroupsResponse] = None)

Response for Check group membership (V2)

GetGroupRequest dataclass

GetGroupRequest(id: str)

Definition: GetGroup_Request

Attributes

id class-attribute instance-attribute

id: str = dataclass_field(metadata={'wire_name': '@odata.id'})

Unique identifier of a user (Ex. '5e6cf5c7-b511-4842-6aae-3f6b8ae5e95b').

AssignManagerRequest dataclass

AssignManagerRequest(id: str)

Definition: AssignManager_Request

Attributes

id class-attribute instance-attribute

id: str = dataclass_field(metadata={'wire_name': '@odata.id'})

Unique identifier of a manager (Ex. '5f6cf5c7-a561-4842-9aae-3e6d8ce5e95b').

UpdateUserRequest dataclass

UpdateUserRequest(*, user_principal_name: Optional[str] = None, display_name: Optional[str] = None, mail_nickname: Optional[str] = None, given_name: Optional[str] = None, surname: Optional[str] = None, account_enabled: Optional[bool] = None, job_title: Optional[str] = None, department: Optional[str] = None, mobile_phone: Optional[str] = None, office_location: Optional[str] = None, preferred_language: Optional[str] = None, business_phones: Optional[List[str]] = None, other_mails: Optional[List[str]] = None, custom_properties: Optional[Dict[str, str]] = None, on_premises_extension_attributes: Optional[Dict[str, Any]] = None)

Definition: UpdateUser_Request

Attributes

user_principal_name class-attribute instance-attribute

user_principal_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userPrincipalName'})

The user principal name (UPN) of the user.

display_name class-attribute instance-attribute

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

The name displayed in the address book for the user.

mail_nickname class-attribute instance-attribute

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

The mail alias for the user.

given_name class-attribute instance-attribute

given_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'givenName'})

The given name (first name) of the user.

surname class-attribute instance-attribute

surname: Optional[str] = dataclass_field(default=None, kw_only=True)

The user's surname (family name or last name).

account_enabled class-attribute instance-attribute

account_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'accountEnabled'})

True if the new account should be enabled.

job_title class-attribute instance-attribute

job_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobTitle'})

The user's job title.

department class-attribute instance-attribute

department: Optional[str] = dataclass_field(default=None, kw_only=True)

The name for the department in which the user works.

mobile_phone class-attribute instance-attribute

mobile_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mobilePhone'})

The mobile phone number for the user in any format such as '1 (234) 567-8910'.

office_location class-attribute instance-attribute

office_location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'officeLocation'})

The office location in the user's place of business.

preferred_language class-attribute instance-attribute

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

The preferred language for the user. Should follow ISO 639-1 Code; for example 'en-US'.

custom_properties class-attribute instance-attribute

custom_properties: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

Free form property name and value for this user.

GetMemberGroupsRequest dataclass

GetMemberGroupsRequest(security_enabled_only: bool)

Definition: GetMemberGroups_Request

Attributes

security_enabled_only class-attribute instance-attribute

security_enabled_only: bool = dataclass_field(metadata={'wire_name': 'securityEnabledOnly'})

Determines if only security enabled groups should be fetched.

CreateUserRequest dataclass

CreateUserRequest(account_enabled: bool, display_name: str, mail_nickname: str, password_profile: Dict[str, Any], user_principal_name: str, *, given_name: Optional[str] = None, surname: Optional[str] = None, business_phones: Optional[List[str]] = None, department: Optional[str] = None, job_title: Optional[str] = None, mobile_phone: Optional[str] = None, office_location: Optional[str] = None, preferred_language: Optional[str] = None)

Definition: CreateUser_Request

Attributes

account_enabled class-attribute instance-attribute

account_enabled: bool = dataclass_field(metadata={'wire_name': 'accountEnabled'})

True if the new account should be enabled when it is created.

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

The name displayed in the address book for the user.

mail_nickname class-attribute instance-attribute

mail_nickname: str = dataclass_field(metadata={'wire_name': 'mailNickname'})

The mail alias for the user.

password_profile class-attribute instance-attribute

password_profile: Dict[str, Any] = dataclass_field(metadata={'wire_name': 'passwordProfile'})

passwordProfile

user_principal_name class-attribute instance-attribute

user_principal_name: str = dataclass_field(metadata={'wire_name': 'userPrincipalName'})

The user principal name (UPN) of the user.

given_name class-attribute instance-attribute

given_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'givenName'})

The user's given name (first name).

surname class-attribute instance-attribute

surname: Optional[str] = dataclass_field(default=None, kw_only=True)

The user's surname (family name or last name).

department class-attribute instance-attribute

department: Optional[str] = dataclass_field(default=None, kw_only=True)

The name for the department in which the user works.

job_title class-attribute instance-attribute

job_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobTitle'})

The user's job title.

mobile_phone class-attribute instance-attribute

mobile_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mobilePhone'})

The mobile phone number for the user in any format such as '1 (234) 567-8910'.

office_location class-attribute instance-attribute

office_location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'officeLocation'})

The office location in the user's place of business.

preferred_language class-attribute instance-attribute

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

The preferred language for the user. Should follow ISO 639-1 Code; for example 'en-US'.

CheckMemberGroupsRequest dataclass

CheckMemberGroupsRequest(group_ids: List[str])

Definition: CheckMemberGroups_Request

AzureadClient

AzureadClient(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 azuread connector.

Initialize a AzureadClient.

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:

create_office365_group async

create_office365_group(input: CreateOffice365GroupInput | Mapping[str, Any], *, 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

Create Office 365 group

Create an Office 365 group in your Microsoft Entra ID tenant.

Swagger operation ID: CreateOffice365Group.

Parameters:

Name	Type	Description	Default
input	CreateOffice365GroupInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	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.

create_security_group async

create_security_group(input: CreateSecurityGroupInput | Mapping[str, Any], *, 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

Create security group

Create a security group in your Microsoft Entra ID tenant.

Swagger operation ID: CreateSecurityGroup.

Parameters:

Name	Type	Description	Default
input	CreateSecurityGroupInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	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.

get_group async

get_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

Get details for a group.

Swagger operation ID: GetGroup.

Parameters:

Name	Type	Description	Default
id	str	Unique identifier of a group (Ex. '40639f36-46a6-73a6-91e2-9584b7913429').	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.

get_user async

get_user(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 user

Get details for a user.

Swagger operation ID: GetUser.

Parameters:

Name	Type	Description	Default
id	str	Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').	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.

update_user async

update_user(input: UpdateUserRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Update user

Update the info for a user.

Swagger operation ID: UpdateUser.

Parameters:

Name	Type	Description	Default
input	UpdateUserRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
id	str	Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').	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:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

refresh_tokens async

refresh_tokens(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Refresh tokens

Invalidate all refresh tokens for a user

Swagger operation ID: RefreshTokens.

Parameters:

Name	Type	Description	Default
id	str	Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').	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:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_user async

create_user(input: CreateUserRequest | Mapping[str, Any], *, 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

Create user

Create a new user in your Microsoft Entra ID tenant.

Swagger operation ID: CreateUser.

Parameters:

Name	Type	Description	Default
input	CreateUserRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	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_group_members

list_group_members(id: str, *, top: Optional[int] = 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 group members

Get the users who are members of a group. You can query up to 1000 items using the Top parameter. If you need to retrieve more than 1000 values, please turn on the Settings->Pagination feature and provide a Threshold limit.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetGroupMembers.

Parameters:

Name	Type	Description	Default
id	str	Unique identifier of a group (Ex. '40639f36-46a6-73a6-91e2-9584b7913429').	required
top	Optional[int]	Limit on the number of results to return (from 1 to 999, default is 100).	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 async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

remove_member_from_group async

remove_member_from_group(group_id: str, member_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Remove Member From Group

Remove Member From Group

Swagger operation ID: RemoveMemberFromGroup.

Parameters:

Name	Type	Description	Default
group_id	str	The Id of the group.	required
member_id	str	The Id of the member.	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:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_user_to_group async

add_user_to_group(input: GetGroupRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Add user to group

Add a user to a group in this Microsoft Entra ID tenant.

Swagger operation ID: AddUserToGroup.

Parameters:

Name	Type	Description	Default
input	GetGroupRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
id	str	Unique identifier of a group (Ex. '40639f36-46a6-73a6-91e2-9584b7913429').	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:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

assign_manager async

assign_manager(input: AssignManagerRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Assign manager

Assign a manager for a user.

Swagger operation ID: AssignManager.

Parameters:

Name	Type	Description	Default
input	AssignManagerRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
id	str	Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').	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:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_group async

create_group(input: CreateGroupInput | Mapping[str, Any], *, 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

Create group

Create a group in your Microsoft Entra ID tenant.

Swagger operation ID: CreateGroup.

Parameters:

Name	Type	Description	Default
input	CreateGroupInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	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.

check_member_groups async

check_member_groups(input: CheckMemberGroupsRequest | Mapping[str, Any], 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

Check group membership

If the user is a member of the given group, the result will contain the given id. Otherwise the result will be empty.

Swagger operation ID: CheckMemberGroupsV2.

Parameters:

Name	Type	Description	Default
input	CheckMemberGroupsRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
id	str	Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').	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

list_member_groups(input: GetMemberGroupsRequest | Mapping[str, Any], 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 groups of a user

Get the groups a user is a member of.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetMemberGroupsV2.

Parameters:

Name	Type	Description	Default
input	GetMemberGroupsRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
id	str	Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').	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 async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.