Graph#

• REST API
• API Version: 7.1

Prerequisites#

See QuickStart

Examples#

Now that we have the connection object webApi, we can get the instance of GraphApi.

var graph = webApi.getGraphApi();

We have access to the functionalities that Graph Api has.

Available functions#

Create a new user#

Create a new user. You need to provide user descriptor to successfully create a user account. This simply means that you've to clone (or materialize) an existing user using the user descriptor.

You can get the user descriptor by running getUsers method.

graph.createUser("John.doe@gmail.com", "user-descriptor");

// Get the user descriptor from an existing user
graph.getUsers()
    .getUsers()
    .stream()
    .filter(x -> x.getDisplayName().equals("Jane.doe@gmail.com"))
    .findFirst()
    .get()
    .getDescriptor();

Add user to group#

After successfully creating a user you can add the user account to an existing group.

graph.addUserToGroup("John.doe@gmail.com", "group-descriptor");

// Get group descriptor
graph.getGroups()
    .getGraphGroups()
    .stream()
    .filter(x -> x.getDisplayName().equals("Readers"))
    .findFirst()
    .get()
    .getDescriptor();

Delete a user#

Delete a user using user descriptor.

var userDescriptor = graph.getUsers().getUsers()
    .stream()
    .filter(x -> x.getDisplayName().equals("test@xmail.com"))
    .findFirst()
    .get()
    .getDescriptor();
graph.deleteUser("user-descriptor");

Get a user#

Get a user with user descriptor.

graph.getUser("user-descriptor");

Get a all groups#

List all the groups.

graph.groups().getGraphGroups();

Get a list of users in a group#

Get a list of users in a group. You should pass the groups descriptor to get the users.

var groupDescriptor = graph.getGroups()
    .getGraphGroups()
    .stream()
    .filter(x -> x.getDisplayName().equals("Readers"))
    .findFirst()
    .get()
    .getDescriptor();
graph.getGroupMembersOf(groupDescriptor);

Get a list of groups that a user is a member of#

Get a list of all the groups that a user is a member of.

var userDescriptor = graph.getUsers().getUsers()
    .stream()
    .filter(x -> x.getDisplayName().equals("test@xmail.com"))
    .findFirst()
    .get()
    .getDescriptor();
graph.getMemberOfGroups(userDescriptor);

Create a new group#

Create a new group with the group display name and description.

graph.createGroup("ReadersPlus", "A group containing both readers and additional privileges");