AzureadClient
Attributes
Classes
dataclass
CreateOffice365GroupInput(display_name: Optional[str] = None, description: Optional[str] = None, mail_nickname: Optional[str] = None, group_types: Optional[List[str]] = None, security_enabled: Optional[bool] = None, mail_enabled: Optional[bool] = None)
Create Office 365 group
Attributes
class-attribute
instance-attribute
Display name of the new group.
class-attribute
instance-attribute
Description of the new group.
class-attribute
instance-attribute
The mail alias of the new group.
class-attribute
instance-attribute
For Office 365, group type is 'Unified'.
class-attribute
instance-attribute
True if the new group is a security group.
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
class-attribute
instance-attribute
@odata.context
class-attribute
instance-attribute
deletedDateTime
class-attribute
instance-attribute
classification
class-attribute
instance-attribute
createdDateTime
class-attribute
instance-attribute
displayName
class-attribute
instance-attribute
groupTypes
class-attribute
instance-attribute
mailEnabled
class-attribute
instance-attribute
mailNickname
class-attribute
instance-attribute
on_premises_last_sync_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'onPremisesLastSyncDateTime'})
onPremisesLastSyncDateTime
class-attribute
instance-attribute
on_premises_security_identifier: Optional[str] = field(default=None, metadata={'wire_name': 'onPremisesSecurityIdentifier'})
onPremisesSecurityIdentifier
class-attribute
instance-attribute
on_premises_sync_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'onPremisesSyncEnabled'})
onPremisesSyncEnabled
class-attribute
instance-attribute
proxy_addresses: Optional[List[str]] = field(default=None, metadata={'wire_name': 'proxyAddresses'})
proxyAddresses
class-attribute
instance-attribute
renewedDateTime
class-attribute
instance-attribute
securityEnabled
dataclass
CreateSecurityGroupInput(display_name: Optional[str] = None, description: Optional[str] = None, mail_nickname: Optional[str] = None, security_enabled: Optional[bool] = None, mail_enabled: Optional[bool] = None)
Create security group
Attributes
class-attribute
instance-attribute
Display name of the new group.
class-attribute
instance-attribute
Description of the new group.
class-attribute
instance-attribute
The mail alias of the new group.
class-attribute
instance-attribute
True if the new group is a security group.
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
class-attribute
instance-attribute
Date-time the group was deleted.
class-attribute
instance-attribute
Date-time the group was created.
class-attribute
instance-attribute
An optional description for the group.
class-attribute
instance-attribute
The display name for the group.
class-attribute
instance-attribute
True if the group is mail-enabled.
class-attribute
instance-attribute
on_premises_last_sync_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'onPremisesLastSyncDateTime'})
A date-time indicating the last time at which the group was synced with the on-premises directory.
class-attribute
instance-attribute
on_premises_sync_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'onPremisesSyncEnabled'})
True if this group is synced from an on-premises directory.
class-attribute
instance-attribute
True if the group is a security group.
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
class-attribute
instance-attribute
The name displayed in the address book for the user.
class-attribute
instance-attribute
The given name (first name) of the user.
class-attribute
instance-attribute
The user's job title.
class-attribute
instance-attribute
The primary cellular telephone number for the user.
class-attribute
instance-attribute
The office location in the user's place of business.
class-attribute
instance-attribute
preferred_language: Optional[str] = field(default=None, metadata={'wire_name': 'preferredLanguage'})
The preferred language for the user. Should follow ISO 639-1 Code; for example 'en-US'.
class-attribute
instance-attribute
The user's surname (family name or last name).
dataclass
GetGroupMembersResponse(next_link: Optional[str] = None, value: Optional[List[GetUserResponse]] = None)
Response for Get group members
Attributes
class-attribute
instance-attribute
Link to get next page of results
dataclass
CreateGroupInput(display_name: Optional[str] = None, description: Optional[str] = None, mail_nickname: Optional[str] = None, group_types: Optional[List[str]] = None, security_enabled: Optional[bool] = None, mail_enabled: Optional[bool] = None)
Create group
Attributes
class-attribute
instance-attribute
Display name of the new group.
class-attribute
instance-attribute
Description of the new group.
class-attribute
instance-attribute
The mail alias of the new group.
class-attribute
instance-attribute
Choose 'Unified' for an O365 group. Choose 'None' for a security group.
class-attribute
instance-attribute
True if the new group is a security group.
dataclass
Response for Check group membership (V2)
dataclass
dataclass
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, Any]] = None, on_premises_extension_attributes: Optional[Dict[str, Any]] = None)
Definition: UpdateUser_Request
Attributes
class-attribute
instance-attribute
user_principal_name: Optional[str] = field(default=None, metadata={'wire_name': 'userPrincipalName'})
The user principal name (UPN) of the user.
class-attribute
instance-attribute
The name displayed in the address book for the user.
class-attribute
instance-attribute
The mail alias for the user.
class-attribute
instance-attribute
The given name (first name) of the user.
class-attribute
instance-attribute
The user's surname (family name or last name).
class-attribute
instance-attribute
True if the new account should be enabled.
class-attribute
instance-attribute
The user's job title.
class-attribute
instance-attribute
The name for the department in which the user works.
class-attribute
instance-attribute
The mobile phone number for the user in any format such as '1 (234) 567-8910'.
class-attribute
instance-attribute
The office location in the user's place of business.
dataclass
dataclass
CreateUserRequest(account_enabled: Optional[bool] = None, display_name: Optional[str] = None, mail_nickname: Optional[str] = None, password_profile: Optional[Dict[str, Any]] = None, user_principal_name: Optional[str] = None, 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
class-attribute
instance-attribute
True if the new account should be enabled when it is created.
class-attribute
instance-attribute
The name displayed in the address book for the user.
class-attribute
instance-attribute
The mail alias for the user.
class-attribute
instance-attribute
password_profile: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'passwordProfile'})
passwordProfile
class-attribute
instance-attribute
user_principal_name: Optional[str] = field(default=None, metadata={'wire_name': 'userPrincipalName'})
The user principal name (UPN) of the user.
class-attribute
instance-attribute
The user's given name (first name).
class-attribute
instance-attribute
The user's surname (family name or last name).
class-attribute
instance-attribute
The name for the department in which the user works.
class-attribute
instance-attribute
The user's job title.
class-attribute
instance-attribute
The mobile phone number for the user in any format such as '1 (234) 567-8910'.
class-attribute
instance-attribute
The office location in the user's place of business.
dataclass
Definition: CheckMemberGroups_Request
AzureadClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)
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 |
token_provider
|
Optional[TokenProvider]
|
Optional token provider. Defaults to ManagedIdentityTokenProvider. |
None
|
options
|
Optional[ConnectorClientOptions]
|
Optional connector client options. |
None
|
Methods:
async
Create Office 365 group
Create an Office 365 group in your Microsoft Entra ID tenant.
async
Create security group
Create a security group in your Microsoft Entra ID tenant.
async
Get group
Get details for a group.
async
Get user
Get details for a user.
async
Update user
Update the info for a user.
async
Refresh tokens
Invalidate all refresh tokens for a user
async
Create user
Create a new user in your Microsoft Entra ID tenant.
async
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.
async
Remove Member From Group
Remove Member From Group
async
Add user to group
Add a user to a group in this Microsoft Entra ID tenant.
async
Assign manager
Assign a manager for a user.
async
Create group
Create a group in your Microsoft Entra ID tenant.
async
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.