com.docusign.admin.api

Class ProductPermissionProfilesApi

java.lang.Object

com.docusign.admin.api.ProductPermissionProfilesApi

public class ProductPermissionProfilesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ProductPermissionProfilesApi()
ProductPermissionProfilesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
UserProductPermissionProfilesResponse	addUserProductPermissionProfiles(UUID organizationId, UUID accountId, UUID userId, ProductPermissionProfilesRequest productPermissionProfilesRequest) Assign user to permission profiles for one or more products Required scopes: user_write
ApiClient	getApiClient()
ProductPermissionProfilesResponse	getProductPermissionProfiles(UUID organizationId, UUID accountId) Get products associated with the account and the available permission profiles Required scopes: user_read
ProductPermissionProfilesResponse	getUserProductPermissionProfiles(UUID organizationId, UUID accountId, UUID userId) Retrieve list of user's permission profiles for each account's product Required scopes: user_read
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductPermissionProfilesApi

public ProductPermissionProfilesApi()

ProductPermissionProfilesApi

public ProductPermissionProfilesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addUserProductPermissionProfiles

public UserProductPermissionProfilesResponse addUserProductPermissionProfiles(UUID organizationId,
                                                                              UUID accountId,
                                                                              UUID userId,
                                                                              ProductPermissionProfilesRequest productPermissionProfilesRequest)
                                                                       throws ApiException

Assign user to permission profiles for one or more products Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

userId - The user ID GUID (required)

productPermissionProfilesRequest - Request object (required)

Returns:

UserProductPermissionProfilesResponse

Throws:

ApiException - if fails to make API call

getProductPermissionProfiles

public ProductPermissionProfilesResponse getProductPermissionProfiles(UUID organizationId,
                                                                      UUID accountId)
                                                               throws ApiException

Get products associated with the account and the available permission profiles Required scopes: user_read

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

Returns:

ProductPermissionProfilesResponse

Throws:

ApiException - if fails to make API call

getUserProductPermissionProfiles

public ProductPermissionProfilesResponse getUserProductPermissionProfiles(UUID organizationId,
                                                                          UUID accountId,
                                                                          UUID userId)
                                                                   throws ApiException

Retrieve list of user's permission profiles for each account's product Required scopes: user_read

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

userId - The user ID GUID (required)

Returns:

ProductPermissionProfilesResponse

Throws:

ApiException - if fails to make API call