Package org.azd.memberentitlementmanagement

Class MemberEntitlementManagementApi

java.lang.Object

org.azd.utils.AzDAsyncApi<MemberEntitlementManagementApi>

org.azd.memberentitlementmanagement.MemberEntitlementManagementApi

All Implemented Interfaces:

MemberEntitlementManagementDetails

public class MemberEntitlementManagementApi
extends AzDAsyncApi<MemberEntitlementManagementApi>
implements MemberEntitlementManagementDetails

MemberEntitlementManagementApi class to manage groups and user entitlements API

Constructor Summary

Constructors

Constructor	Description
MemberEntitlementManagementApi(Connection connection)	Pass the connection object to work with Member Entitlement Management Api

Method Summary

Modifier and Type	Method	Description
UserEntitlementsResponse	addUserEntitlement(AccountLicenseType accountLicenseType, String emailId, GroupType groupType, String projectId)	Add a user, assign license and make them a member of a project group in an account.
Void	deleteUserEntitlement(String userId)	Delete a user from the account.
GroupEntitlement	getGroupEntitlement(String groupId)	Get a group entitlement.
GroupEntitlements	getGroupEntitlements()	Get the group entitlements for an account.
PagedGraphMemberList	getMembers(String groupId)	Get direct members of a Group.
PagedGraphMemberList	getMembers(String groupId, int maxResults, String pagingToken)	Get direct members of a Group.
UserEntitlement	getUserEntitlement(String userId)	Get User Entitlement for a user.
PagedGraphMemberList	getUserEntitlements()	Get a list of users/members entitlements.
UsersSummary	getUserEntitlementSummary()	Get summary of Licenses, Extension, Projects, Groups and their assignments in the collection.
Void	removeMemberFromGroup(String groupId, String memberId)	Remove a member from a Group.
UserEntitlementsResponse	updateUserEntitlement(String userId, List<Object> requestBody)	Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.
UserEntitlementsResponse	updateUserEntitlement(String userId, AccountLicenseType accountLicenseType, LicensingSource licensingSource)	Edit the entitlements License for a user.

Methods inherited from class org.azd.utils.AzDAsyncApi

createAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MemberEntitlementManagementApi

public MemberEntitlementManagementApi(Connection connection)

Pass the connection object to work with Member Entitlement Management Api

Parameters:

connection - Connection object

Method Details

getGroupEntitlements

public GroupEntitlements getGroupEntitlements()
                                       throws AzDException

Get the group entitlements for an account.

Specified by:

getGroupEntitlements in interface MemberEntitlementManagementDetails

Returns:

GroupEntitlements GroupEntitlements

Throws:

AzDException - Default Api Exception handler.

getGroupEntitlement

public GroupEntitlement getGroupEntitlement(String groupId)
                                     throws AzDException

Get a group entitlement. If the group entitlement does not exist, returns null.

Specified by:

getGroupEntitlement in interface MemberEntitlementManagementDetails

Parameters:

groupId - ID of the group.

Returns:

GroupEntitlement GroupEntitlement

Throws:

AzDException - Default Api Exception handler.

getUserEntitlementSummary

public UsersSummary getUserEntitlementSummary()
                                       throws AzDException

Get summary of Licenses, Extension, Projects, Groups and their assignments in the collection.

Specified by:

getUserEntitlementSummary in interface MemberEntitlementManagementDetails

Returns:

UsersSummary UsersSummary

Throws:

AzDException - Default Api Exception handler.

getMembers

public PagedGraphMemberList getMembers(String groupId)
                                throws AzDException

Get direct members of a Group.

Specified by:

getMembers in interface MemberEntitlementManagementDetails

Parameters:

groupId - Id of the Group.

Returns:

PagedGraphMemberList PagedGraphMemberList

Throws:

AzDException - Default Api Exception handler.

getMembers

public PagedGraphMemberList getMembers(String groupId,
 int maxResults,
 String pagingToken)
                                throws AzDException

Get direct members of a Group.

Specified by:

getMembers in interface MemberEntitlementManagementDetails

Parameters:

groupId - Id of the Group.

maxResults - Maximum number of results to retrieve.

pagingToken - Paging Token from the previous page fetched. If the 'pagingToken' is null, the results would be fetched from the beginning of the Members List.

Returns:

PagedGraphMemberList PagedGraphMemberList

Throws:

AzDException - Default Api Exception handler.

removeMemberFromGroup

public Void removeMemberFromGroup(String groupId,
 String memberId)
                           throws AzDException

Remove a member from a Group.

Specified by:

removeMemberFromGroup in interface MemberEntitlementManagementDetails

Parameters:

groupId - Id of the group.

memberId - Id of the group.

Throws:

AzDException - Default Api Exception handler.

addUserEntitlement

public UserEntitlementsResponse addUserEntitlement(AccountLicenseType accountLicenseType,
 String emailId,
 GroupType groupType,
 String projectId)
                                            throws AzDException

Add a user, assign license and make them a member of a project group in an account.

Specified by:

addUserEntitlement in interface MemberEntitlementManagementDetails

Parameters:

accountLicenseType - Type of Accounts License (e.g. Express, Stakeholder etc.) AccountLicenseType

emailId - Email address of the user.

groupType - Type of the group. (e.g. Project Administrator, Project Contributor, etc.) GroupType

projectId - Id of the project. Get the project id by running getProjects() or getProject("projectName") from CoreApi.

Returns:

UserEntitlementsResponse UserEntitlementsResponse

Throws:

AzDException - Default Api Exception handler.

deleteUserEntitlement

public Void deleteUserEntitlement(String userId)
                           throws AzDException

Delete a user from the account. The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.

Specified by:

deleteUserEntitlement in interface MemberEntitlementManagementDetails

Parameters:

userId - userId ID of the user. Run getUserEntitlements() to get a list of users and get the user id.

Throws:

AzDException - Default Api Exception handler.

getUserEntitlement

public UserEntitlement getUserEntitlement(String userId)
                                   throws AzDException

Get User Entitlement for a user.

Specified by:

getUserEntitlement in interface MemberEntitlementManagementDetails

Parameters:

userId - userId ID of the user. Run getUserEntitlements() to get a list of users and get the user id.

Returns:

UserEntitlement UserEntitlement

Throws:

AzDException - Default Api Exception handler.

getUserEntitlements

public PagedGraphMemberList getUserEntitlements()
                                         throws AzDException

Get a list of users/members entitlements.

Specified by:

getUserEntitlements in interface MemberEntitlementManagementDetails

Returns:

PagedGraphMemberList PagedGraphMemberList

Throws:

AzDException - Default Api Exception handler.

updateUserEntitlement

public UserEntitlementsResponse updateUserEntitlement(String userId,
 List<Object> requestBody)
                                               throws AzDException

Edit the entitlements (License, Extensions, Projects, Teams etc) for a user. Pass a list of items that you want to edit for a user.

Specified by:

updateUserEntitlement in interface MemberEntitlementManagementDetails

Parameters:

userId - ID of the user. Run getUserEntitlements() to get a list of users and get the user id.

Returns:

UserEntitlementsResponse UserEntitlementsResponse

Throws:

AzDException - Default Api Exception handler.

updateUserEntitlement

public UserEntitlementsResponse updateUserEntitlement(String userId,
 AccountLicenseType accountLicenseType,
 LicensingSource licensingSource)
                                               throws AzDException

Edit the entitlements License for a user. Set the license account type and license source type for a user.

Specified by:

updateUserEntitlement in interface MemberEntitlementManagementDetails

Parameters:

userId - ID of the user. Run getUserEntitlements() to get a list of users and get the user id.

accountLicenseType - Type of Accounts License (e.g. Express, Stakeholder etc.) AccountLicenseType

licensingSource - Licensing Source (e.g. Accounts. MSDN etc.) LicensingSource

Returns:

UserEntitlementsResponse UserEntitlementsResponse

Throws:

AzDException - Default Api Exception handler.