com.manageengine.pam360.sdk.resources

Class Account

java.lang.Object

com.manageengine.pam360.sdk.resources.Account

public final class Account
extends java.lang.Object

Contains methods that can be used to perform operations over accounts (under a resource)

Constructor Summary

Constructors

Constructor and Description
Account(PAMService service, APIRequestHandler rest)

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	createAccount(java.lang.String resourceName, java.util.List<AccountModel> accountModels) Create an account under a resource
boolean	deleteAccount(java.lang.String resourceName, java.lang.String accountName) Delete an account under a resource using resource and account name
boolean	editAccount(java.lang.String resourceName, java.lang.String currentAccountName, AccountModel accountModel) Edit an existing account under a resource using resource name and account name
AccountDetails	getDetails(long resourceID, long accountID) Get the details of an account in a resource
AccountDetails	getDetails(java.lang.String resourceName, java.lang.String accountName) Get the details of an account under a resource
boolean	shareAccountToUser(java.lang.String resourceName, java.lang.String accountName, java.lang.String userName, sdkEnumConstants.AccessPermission accessPermission) Share the account to a particular user using resource, account and user names
boolean	shareAccountToUserGroup(java.lang.String resourceName, java.lang.String accountName, java.lang.String userGroupName, sdkEnumConstants.AccessPermission accessPermission) Share the account to a particular usergroup using resource, account and user names

Methods inherited from class java.lang.Object

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

Constructor Detail

Account

public Account(PAMService service,
               APIRequestHandler rest)
        throws SDKRegistrationException

Throws:

SDKRegistrationException

Method Detail

getDetails

public AccountDetails getDetails(long resourceID,
                                 long accountID)
                          throws SDKConnectionException,
                                 SDKOperationFailedException,
                                 SDKInvalidArgumentException

Get the details of an account in a resource

Parameters:

resourceID - mandatory,non negative, unique id of resource

accountID - mandatory,id of account inside the resource whose details is to be fetched

Returns:

an instance of AccountDetails

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

getDetails

public AccountDetails getDetails(java.lang.String resourceName,
                                 java.lang.String accountName)
                          throws SDKConnectionException,
                                 SDKOperationFailedException,
                                 SDKInvalidArgumentException

Get the details of an account under a resource

Parameters:

resourceName - mandatory,not null, non empty unique name of resource

accountName - mandatory,not null, non empty unique name of account inside the resource whose details is to be fetched

Returns:

an instance of AccountDetails

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

deleteAccount

public boolean deleteAccount(java.lang.String resourceName,
                             java.lang.String accountName)
                      throws SDKInvalidArgumentException,
                             SDKConnectionException,
                             SDKOperationFailedException

Delete an account under a resource using resource and account name

Parameters:

resourceName - mandatory, not null, non empty name of resource

accountName - mandatory, not null, non empty name of account inside the resource to be deleted

Returns:

true if account is deleted successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

createAccount

public org.json.JSONObject createAccount(java.lang.String resourceName,
                                         java.util.List<AccountModel> accountModels)
                                  throws SDKConnectionException,
                                         SDKOperationFailedException,
                                         SDKInvalidArgumentException,
                                         SDKRegistrationException

Create an account under a resource

Parameters:

resourceName - mandatory,mandatory not null name of resource

accountModels - mandatory,an instance of AccountModel containing necessary information about account

Returns:

SDKResponse object

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

SDKRegistrationException

editAccount

public boolean editAccount(java.lang.String resourceName,
                           java.lang.String currentAccountName,
                           AccountModel accountModel)
                    throws SDKInvalidArgumentException,
                           SDKConnectionException,
                           SDKOperationFailedException

Edit an existing account under a resource using resource name and account name

Parameters:

resourceName - mandatory, not null, non empty unique name of resource

currentAccountName - mandatory, not null, non empty unique name of account inside the resource which is to be edited

accountModel - mandatory, AccountModel object containing necessary details

Returns:

true if account has been edited successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

shareAccountToUser

public boolean shareAccountToUser(java.lang.String resourceName,
                                  java.lang.String accountName,
                                  java.lang.String userName,
                                  sdkEnumConstants.AccessPermission accessPermission)
                           throws SDKInvalidArgumentException,
                                  SDKConnectionException,
                                  SDKOperationFailedException

Share the account to a particular user using resource, account and user names

Parameters:

resourceName - mandatory, not null, non empty name of resource

accountName - mandatory, not null, non empty name of resource of account to be shared

userName - mandatory, not null, non empty name of user to whom the account is to be shared

accessPermission - mandatory, the access type/level to be provided to the user

Returns:

true if account has been shared to user successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

shareAccountToUserGroup

public boolean shareAccountToUserGroup(java.lang.String resourceName,
                                       java.lang.String accountName,
                                       java.lang.String userGroupName,
                                       sdkEnumConstants.AccessPermission accessPermission)
                                throws SDKInvalidArgumentException,
                                       SDKConnectionException,
                                       SDKOperationFailedException

Share the account to a particular usergroup using resource, account and user names

Parameters:

resourceName - mandatory, not null, non empty name of resource

accountName - mandatory, not null, non empty name of resource of account to be shared

userGroupName - mandatory, not null, non empty name of usergroup to whom the account is to be shared

accessPermission - mandatory, the access type/level to be provided to the user

Returns:

true if account has been shared to usergroup successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided