Package org.azd.accounts

Class AccountsApi

java.lang.Object

org.azd.utils.AzDAsyncApi<AccountsApi>

org.azd.accounts.AccountsApi

All Implemented Interfaces:

AccountsDetails

public class AccountsApi
extends AzDAsyncApi<AccountsApi>
implements AccountsDetails

Accounts class to manage Accounts Api

Constructor Summary

Constructors

Constructor	Description
AccountsApi(Connection connection)	Pass the connection object to work with Accounts Api

Method Summary

Modifier and Type	Method	Description
Accounts	getAccounts(String memberId)	Get a list of accounts for a specific member.
Organizations	getOrganizations()	Get the list of organizations that you have access to.
Profile	getProfile()	Gets the logged in user profile.
Profile	getProfile(String id)	Gets a user profile.

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

AccountsApi

public AccountsApi(Connection connection)

Pass the connection object to work with Accounts Api

Parameters:

connection - Connection object

Method Details

getAccounts

public Accounts getAccounts(String memberId)
                     throws AzDException

Get a list of accounts for a specific member.

Specified by:

getAccounts in interface AccountsDetails

Parameters:

memberId - Specify the member Id. This can be obtained by running getUserEntitlements() from MemberEntitlementManagementApi.

Returns:

Accounts object Accounts

Throws:

AzDException - Default Api Exception handler.

getOrganizations

public Organizations getOrganizations()
                               throws AzDException

Get the list of organizations that you have access to. Note that while creating and granting access to the personal access token select all organizations to apply the access on all available organizations.

Specified by:

getOrganizations in interface AccountsDetails

Returns:

A list of Organization. Organizations

Throws:

AzDException - Default Api Exception handler.

getProfile

public Profile getProfile()
                   throws AzDException

Gets the logged in user profile.

Specified by:

getProfile in interface AccountsDetails

Returns:

a profile object. Profile

Throws:

AzDException - Default Api Exception handler.

getProfile

public Profile getProfile(String id)
                   throws AzDException

Gets a user profile.

Specified by:

getProfile in interface AccountsDetails

Parameters:

id - pass the user id

Returns:

a profile object. Profile

Throws:

AzDException - Default Api Exception handler.