AzureGraph (version 1.0.0)

az_group: Group in Azure Active Directory

Description

Base class representing an AAD group.

Usage

az_group

Format

An R6 object of class az_group, inheriting from az_object.

Fields

• token: The token used to authenticate with the Graph host.

• tenant: The Azure Active Directory tenant for this group.

• type: always "group" for a group object.

• properties: The group properties.

Methods

• new(...): Initialize a new group object. Do not call this directly; see 'Initialization' below.

• delete(confirm=TRUE): Delete a group. By default, ask for confirmation first.

• update(...): Update the group information in Azure Active Directory.

• do_operation(...): Carry out an arbitrary operation on the group.

• sync_fields(): Synchronise the R object with the app data in Azure Active Directory.

• list_group_memberships(): Return the IDs of all groups this group is a member of.

• list_object_memberships(): Return the IDs of all groups, administrative units and directory roles this group is a member of.

• list_members(type=c("user", "group", "application", "servicePrincipal")): Return a list of all members of this group. Specify the type argument to filter the result for specific object type(s).

• list_owners(type=c("user", "group", "application", "servicePrincipal")): Return a list of all owners of this group. Specify the type argument to filter the result for specific object type(s).

Initialization

Creating new objects of this class should be done via the create_group and get_group methods of the ms_graph and az_app classes. Calling the new() method for this class only constructs the R object; it does not call the Microsoft Graph API to create the actual group.

See Also

ms_graph, az_app, az_user, az_object

Microsoft Graph overview, REST API reference

Examples

# NOT RUN {
gr <- get_graph_login()
usr <- gr$get_user("[e-mail]")

grps <- usr$list_direct_memberships()
grp <- grp[[1]]

grp$list_members()
grp$list_owners()

# }