Package com.docusign.admin.api

Class ProductPermissionProfilesApi

java.lang.Object

com.docusign.admin.api.ProductPermissionProfilesApi

public class ProductPermissionProfilesApi
extends Object

ProductPermissionProfilesApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ProductPermissionProfilesApi.GetUserProductPermissionProfilesByEmailOptions	GetUserProductPermissionProfilesByEmailOptions Class.

Constructor Summary

Constructors

Constructor	Description
ProductPermissionProfilesApi()	ProductPermissionProfilesApi.
ProductPermissionProfilesApi(ApiClient apiClient)	ProductPermissionProfilesApi.

Method Summary

Modifier and Type	Method	Description
UserProductPermissionProfilesResponse	addUserProductPermissionProfiles(UUID organizationId, UUID accountId, UUID userId, ProductPermissionProfilesRequest productPermissionProfilesRequest)	Assign user to permission profiles for one or more products.
UserProductPermissionProfilesResponse	addUserProductPermissionProfilesByEmail(UUID organizationId, UUID accountId, UserProductPermissionProfilesRequest userProductPermissionProfilesRequest)	Assign user to permission profiles for one or more products.
ApiResponse<UserProductPermissionProfilesResponse>	addUserProductPermissionProfilesByEmailWithHttpInfo(UUID organizationId, UUID accountId, UserProductPermissionProfilesRequest userProductPermissionProfilesRequest)	Assign user to permission profiles for one or more products Required scopes: user_write
ApiResponse<UserProductPermissionProfilesResponse>	addUserProductPermissionProfilesWithHttpInfo(UUID organizationId, UUID accountId, UUID userId, ProductPermissionProfilesRequest productPermissionProfilesRequest)	Assign user to permission profiles for one or more products Required scopes: user_write
ApiClient	getApiClient()	getApiClient Method.
ProductPermissionProfilesResponse	getProductPermissionProfiles(UUID organizationId, UUID accountId)	Get products associated with the account and the available permission profiles.
ApiResponse<ProductPermissionProfilesResponse>	getProductPermissionProfilesWithHttpInfo(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.
UserProductPermissionProfilesResponse	getUserProductPermissionProfilesByEmail(UUID organizationId, UUID accountId)	Remove user from permission profiles for one or more products.
UserProductPermissionProfilesResponse	getUserProductPermissionProfilesByEmail(UUID organizationId, UUID accountId, ProductPermissionProfilesApi.GetUserProductPermissionProfilesByEmailOptions options)	Remove user from permission profiles for one or more products.
ApiResponse<UserProductPermissionProfilesResponse>	getUserProductPermissionProfilesByEmailWithHttpInfo(UUID organizationId, UUID accountId, ProductPermissionProfilesApi.GetUserProductPermissionProfilesByEmailOptions options)	Remove user from permission profiles for one or more products Required scopes: user_write
ApiResponse<ProductPermissionProfilesResponse>	getUserProductPermissionProfilesWithHttpInfo(UUID organizationId, UUID accountId, UUID userId)	Retrieve list of user's permission profiles for each account's product Required scopes: user_read
RemoveUserProductsResponse	removeUserProductPermission(UUID organizationId, UUID accountId, UserProductProfileDeleteRequest userProductPermissionProfilesRequest)	Remove user from permission profiles for one or more products.
ApiResponse<RemoveUserProductsResponse>	removeUserProductPermissionWithHttpInfo(UUID organizationId, UUID accountId, UserProductProfileDeleteRequest userProductPermissionProfilesRequest)	Remove user from permission profiles for one or more products Required scopes: user_write
void	setApiClient(ApiClient apiClient)	setApiClient Method.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductPermissionProfilesApi

public ProductPermissionProfilesApi()

ProductPermissionProfilesApi.

ProductPermissionProfilesApi

public ProductPermissionProfilesApi(ApiClient apiClient)

ProductPermissionProfilesApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

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

addUserProductPermissionProfilesWithHttpInfo

public ApiResponse<UserProductPermissionProfilesResponse> addUserProductPermissionProfilesWithHttpInfo(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

addUserProductPermissionProfilesByEmail

public UserProductPermissionProfilesResponse addUserProductPermissionProfilesByEmail(UUID organizationId,
                                                                                     UUID accountId,
                                                                                     UserProductPermissionProfilesRequest userProductPermissionProfilesRequest)
                                                                              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)

userProductPermissionProfilesRequest - Request object (required)

Returns:

UserProductPermissionProfilesResponse

Throws:

ApiException - if fails to make API call

addUserProductPermissionProfilesByEmailWithHttpInfo

public ApiResponse<UserProductPermissionProfilesResponse> addUserProductPermissionProfilesByEmailWithHttpInfo(UUID organizationId,
                                                                                                              UUID accountId,
                                                                                                              UserProductPermissionProfilesRequest userProductPermissionProfilesRequest)
                                                                                                       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)

userProductPermissionProfilesRequest - 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

getProductPermissionProfilesWithHttpInfo

public ApiResponse<ProductPermissionProfilesResponse> getProductPermissionProfilesWithHttpInfo(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

getUserProductPermissionProfilesWithHttpInfo

public ApiResponse<ProductPermissionProfilesResponse> getUserProductPermissionProfilesWithHttpInfo(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

getUserProductPermissionProfilesByEmail

public UserProductPermissionProfilesResponse getUserProductPermissionProfilesByEmail(UUID organizationId,
                                                                                     UUID accountId)
                                                                              throws ApiException

Remove user from permission profiles for one or more products. Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

Returns:

UserProductPermissionProfilesResponse

Throws:

ApiException

getUserProductPermissionProfilesByEmail

public UserProductPermissionProfilesResponse getUserProductPermissionProfilesByEmail(UUID organizationId,
                                                                                     UUID accountId,
                                                                                     ProductPermissionProfilesApi.GetUserProductPermissionProfilesByEmailOptions options)
                                                                              throws ApiException

Remove user from permission profiles for one or more products. Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

options - for modifying the method behavior.

Returns:

UserProductPermissionProfilesResponse

Throws:

ApiException - if fails to make API call

getUserProductPermissionProfilesByEmailWithHttpInfo

public ApiResponse<UserProductPermissionProfilesResponse> getUserProductPermissionProfilesByEmailWithHttpInfo(UUID organizationId,
                                                                                                              UUID accountId,
                                                                                                              ProductPermissionProfilesApi.GetUserProductPermissionProfilesByEmailOptions options)
                                                                                                       throws ApiException

Remove user from permission profiles for one or more products Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

options - for modifying the method behavior.

Returns:

UserProductPermissionProfilesResponse

Throws:

ApiException - if fails to make API call

removeUserProductPermission

public RemoveUserProductsResponse removeUserProductPermission(UUID organizationId,
                                                              UUID accountId,
                                                              UserProductProfileDeleteRequest userProductPermissionProfilesRequest)
                                                       throws ApiException

Remove user from permission profiles for one or more products. Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

userProductPermissionProfilesRequest - Request object (required)

Returns:

RemoveUserProductsResponse

Throws:

ApiException - if fails to make API call

removeUserProductPermissionWithHttpInfo

public ApiResponse<RemoveUserProductsResponse> removeUserProductPermissionWithHttpInfo(UUID organizationId,
                                                                                       UUID accountId,
                                                                                       UserProductProfileDeleteRequest userProductPermissionProfilesRequest)
                                                                                throws ApiException

Remove user from permission profiles for one or more products Required scopes: user_write

Parameters:

organizationId - The organization ID GUID (required)

accountId - The account ID GUID (required)

userProductPermissionProfilesRequest - Request object (required)

Returns:

RemoveUserProductsResponse

Throws:

ApiException - if fails to make API call