Group in Azure Active Directory
Class representing an AAD group.
An R6 object of class az_group
, inheriting from az_object
.
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.
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_members(type=c("user", "group", "application", "servicePrincipal"), filter=NULL, n=Inf)
: Return a list of all members of this group. Specify the type
argument to limit the result to specific object type(s).
list_owners(type=c("user", "group", "application", "servicePrincipal"), filter=NULL, n=Inf)
: Return a list of all owners of this group. Specify the type
argument to limit the result to specific object type(s).
All list_*
methods have filter
and n
arguments to limit the number of results. The former should be an OData expression as a string to filter the result set on. The latter should be a number setting the maximum number of (filtered) results to return. The default values are filter=NULL
and n=Inf
. If n=NULL
, the ms_graph_pager
iterator object is returned instead to allow manual iteration over the results.
Support in the underlying Graph API for OData queries is patchy. Not all endpoints that return lists of objects support filtering, and if they do, they may not allow all of the defined operators. If your filtering expression results in an error, you can carry out the operation without filtering and then filter the results on the client side.
## Not run: gr <- get_graph_login() usr <- gr$get_user("myname@aadtenant.com") grps <- usr$list_group_memberships() grp <- gr$get_group(grps[1]) grp$list_members() grp$list_owners() # capping the number of results grp$list_members(n=10) # get the pager object for a listing method pager <- grp$list_members(n=NULL) pager$value ## End(Not run)
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.