Package com.docusign.admin.api

Class OrgConnectApi

java.lang.Object

com.docusign.admin.api.OrgConnectApi

public class OrgConnectApi
extends Object

OrgConnectApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OrgConnectApi.GetOrganizationConnectConfigsOptions	GetOrganizationConnectConfigsOptions Class.

Constructor Summary

Constructors

Constructor	Description
OrgConnectApi()	OrgConnectApi.
OrgConnectApi(ApiClient apiClient)	OrgConnectApi.

Method Summary

Modifier and Type	Method	Description
OrganizationConnectConfigurationDetailsResponse	createOrganizationConnectConfig(UUID organizationId, OrganizationConnectConfigurationRequest connectRequest)	Adds a Connect configuration for an organization.
ApiResponse<OrganizationConnectConfigurationDetailsResponse>	createOrganizationConnectConfigWithHttpInfo(UUID organizationId, OrganizationConnectConfigurationRequest connectRequest)	Adds a Connect configuration for an organization Required scopes: connect_org_config_write_api
OrganizationConnectHmacSecretsResponse	deleteConnectHmacSecret(UUID organizationId, UUID keyId)	Deletes information about a Connect HMAC secret.
ApiResponse<OrganizationConnectHmacSecretsResponse>	deleteConnectHmacSecretWithHttpInfo(UUID organizationId, UUID keyId)	Deletes information about a Connect HMAC secret Required scopes: connect_org_hmac_write_api
Object	deleteOrganizationConnectConfig(UUID organizationId, UUID connectId)	Deletes information about an organization-level Connect configuration.
ApiResponse<Object>	deleteOrganizationConnectConfigWithHttpInfo(UUID organizationId, UUID connectId)	Deletes information about an organization-level Connect configuration Required scopes: connect_org_config_write_api
Object	deleteOrganizationConnectOAuthConfiguration(UUID organizationId)	Deletes an organization-level Connect OAuth configuration.
ApiResponse<Object>	deleteOrganizationConnectOAuthConfigurationWithHttpInfo(UUID organizationId)	Deletes an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api
ApiClient	getApiClient()	getApiClient Method.
OrganizationConnectHmacSecretsResponse	getConnectHmacSecrets(UUID organizationId)	Returns information about Connect HMAC secrets.
ApiResponse<OrganizationConnectHmacSecretsResponse>	getConnectHmacSecretsWithHttpInfo(UUID organizationId)	Returns information about Connect HMAC secrets Required scopes: connect_org_hmac_read_api
OrganizationConnectConfigurationDetailsResponse	getOrganizationConnectConfig(UUID organizationId, UUID connectId)	Returns an organization-level Connect configuration.
OrganizationConnectConfigsResponse	getOrganizationConnectConfigs(UUID organizationId)	Returns a list of Connect configurations under an organization.
OrganizationConnectConfigsResponse	getOrganizationConnectConfigs(UUID organizationId, OrgConnectApi.GetOrganizationConnectConfigsOptions options)	Returns a list of Connect configurations under an organization.
ApiResponse<OrganizationConnectConfigsResponse>	getOrganizationConnectConfigsWithHttpInfo(UUID organizationId, OrgConnectApi.GetOrganizationConnectConfigsOptions options)	Returns a list of Connect configurations under an organization Required scopes: connect_org_config_read_api
ApiResponse<OrganizationConnectConfigurationDetailsResponse>	getOrganizationConnectConfigWithHttpInfo(UUID organizationId, UUID connectId)	Returns an organization-level Connect configuration Required scopes: connect_org_config_read_api
Object	getOrganizationConnectOAuthConfiguration(UUID organizationId)	Returns information about an organization-level Connect OAuth configuration.
ApiResponse<Object>	getOrganizationConnectOAuthConfigurationWithHttpInfo(UUID organizationId)	Returns information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_read_api
OrganizationConnectHmacSecretsResponse	postConnectHmacSecret(UUID organizationId)	Saves information about a Connect HMAC secret.
ApiResponse<OrganizationConnectHmacSecretsResponse>	postConnectHmacSecretWithHttpInfo(UUID organizationId)	Saves information about a Connect HMAC secret Required scopes: connect_org_hmac_write_api
OrganizationConnectOAuthConfiguration	postOrganizationConnectOAuthConfiguration(UUID organizationId, OrganizationConnectOAuthConfiguration _configuration)	Saves information about an organization-level Connect OAuth configuration.
ApiResponse<OrganizationConnectOAuthConfiguration>	postOrganizationConnectOAuthConfigurationWithHttpInfo(UUID organizationId, OrganizationConnectOAuthConfiguration _configuration)	Saves information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api
OrganizationConnectOAuthConfiguration	putOrganizationConnectOAuthConfiguration(UUID organizationId, OrganizationConnectOAuthConfiguration _configuration)	Updates information about an organization-level Connect OAuth configuration.
ApiResponse<OrganizationConnectOAuthConfiguration>	putOrganizationConnectOAuthConfigurationWithHttpInfo(UUID organizationId, OrganizationConnectOAuthConfiguration _configuration)	Updates information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api
void	setApiClient(ApiClient apiClient)	setApiClient Method.
OrganizationConnectConfigurationDetailsResponse	updateOrganizationConnectConfig(UUID organizationId, UUID connectId, OrganizationConnectConfigurationRequest connectRequest)	Updates an organization-level Connect configuration.
ApiResponse<OrganizationConnectConfigurationDetailsResponse>	updateOrganizationConnectConfigWithHttpInfo(UUID organizationId, UUID connectId, OrganizationConnectConfigurationRequest connectRequest)	Updates an organization-level Connect configuration Required scopes: connect_org_config_write_api

Methods inherited from class java.lang.Object

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

Constructor Detail

OrgConnectApi

public OrgConnectApi()

OrgConnectApi.

OrgConnectApi

public OrgConnectApi(ApiClient apiClient)

OrgConnectApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

createOrganizationConnectConfig

public OrganizationConnectConfigurationDetailsResponse createOrganizationConnectConfig(UUID organizationId,
                                                                                       OrganizationConnectConfigurationRequest connectRequest)
                                                                                throws ApiException

Adds a Connect configuration for an organization. Required scopes: connect_org_config_write_api

Parameters:

organizationId - The organization ID Guid (required)

connectRequest - Add an organization Connect request (required)

Returns:

OrganizationConnectConfigurationDetailsResponse

Throws:

ApiException - if fails to make API call

createOrganizationConnectConfigWithHttpInfo

public ApiResponse<OrganizationConnectConfigurationDetailsResponse> createOrganizationConnectConfigWithHttpInfo(UUID organizationId,
                                                                                                                OrganizationConnectConfigurationRequest connectRequest)
                                                                                                         throws ApiException

Adds a Connect configuration for an organization Required scopes: connect_org_config_write_api

Parameters:

organizationId - The organization ID Guid (required)

connectRequest - Add an organization Connect request (required)

Returns:

OrganizationConnectConfigurationDetailsResponse

Throws:

ApiException - if fails to make API call

deleteConnectHmacSecret

public OrganizationConnectHmacSecretsResponse deleteConnectHmacSecret(UUID organizationId,
                                                                      UUID keyId)
                                                               throws ApiException

Deletes information about a Connect HMAC secret. Required scopes: connect_org_hmac_write_api

Parameters:

organizationId - The organization ID Guid (required)

keyId - The key ID Guid (required)

Returns:

OrganizationConnectHmacSecretsResponse

Throws:

ApiException - if fails to make API call

deleteConnectHmacSecretWithHttpInfo

public ApiResponse<OrganizationConnectHmacSecretsResponse> deleteConnectHmacSecretWithHttpInfo(UUID organizationId,
                                                                                               UUID keyId)
                                                                                        throws ApiException

Deletes information about a Connect HMAC secret Required scopes: connect_org_hmac_write_api

Parameters:

organizationId - The organization ID Guid (required)

keyId - The key ID Guid (required)

Returns:

OrganizationConnectHmacSecretsResponse

Throws:

ApiException - if fails to make API call

deleteOrganizationConnectConfig

public Object deleteOrganizationConnectConfig(UUID organizationId,
                                              UUID connectId)
                                       throws ApiException

Deletes information about an organization-level Connect configuration. Required scopes: connect_org_config_write_api

Parameters:

organizationId - The organization ID Guid (required)

connectId - The configuration ID Guid (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

deleteOrganizationConnectConfigWithHttpInfo

public ApiResponse<Object> deleteOrganizationConnectConfigWithHttpInfo(UUID organizationId,
                                                                       UUID connectId)
                                                                throws ApiException

Deletes information about an organization-level Connect configuration Required scopes: connect_org_config_write_api

Parameters:

organizationId - The organization ID Guid (required)

connectId - The configuration ID Guid (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

deleteOrganizationConnectOAuthConfiguration

public Object deleteOrganizationConnectOAuthConfiguration(UUID organizationId)
                                                   throws ApiException

Deletes an organization-level Connect OAuth configuration. Required scopes: connect_org_oauth_write_api

Parameters:

organizationId - The organization ID Guid (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

deleteOrganizationConnectOAuthConfigurationWithHttpInfo

public ApiResponse<Object> deleteOrganizationConnectOAuthConfigurationWithHttpInfo(UUID organizationId)
                                                                            throws ApiException

Deletes an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api

Parameters:

organizationId - The organization ID Guid (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

getConnectHmacSecrets

public OrganizationConnectHmacSecretsResponse getConnectHmacSecrets(UUID organizationId)
                                                             throws ApiException

Returns information about Connect HMAC secrets. Required scopes: connect_org_hmac_read_api

Parameters:

organizationId - The organization ID Guid (required)

Returns:

OrganizationConnectHmacSecretsResponse

Throws:

ApiException - if fails to make API call

getConnectHmacSecretsWithHttpInfo

public ApiResponse<OrganizationConnectHmacSecretsResponse> getConnectHmacSecretsWithHttpInfo(UUID organizationId)
                                                                                      throws ApiException

Returns information about Connect HMAC secrets Required scopes: connect_org_hmac_read_api

Parameters:

organizationId - The organization ID Guid (required)

Returns:

OrganizationConnectHmacSecretsResponse

Throws:

ApiException - if fails to make API call

getOrganizationConnectConfig

public OrganizationConnectConfigurationDetailsResponse getOrganizationConnectConfig(UUID organizationId,
                                                                                    UUID connectId)
                                                                             throws ApiException

Returns an organization-level Connect configuration. Required scopes: connect_org_config_read_api

Parameters:

organizationId - The organization ID Guid (required)

connectId - The configuration ID Guid (required)

Returns:

OrganizationConnectConfigurationDetailsResponse

Throws:

ApiException - if fails to make API call

getOrganizationConnectConfigWithHttpInfo

public ApiResponse<OrganizationConnectConfigurationDetailsResponse> getOrganizationConnectConfigWithHttpInfo(UUID organizationId,
                                                                                                             UUID connectId)
                                                                                                      throws ApiException

Returns an organization-level Connect configuration Required scopes: connect_org_config_read_api

Parameters:

organizationId - The organization ID Guid (required)

connectId - The configuration ID Guid (required)

Returns:

OrganizationConnectConfigurationDetailsResponse

Throws:

ApiException - if fails to make API call

getOrganizationConnectConfigs

public OrganizationConnectConfigsResponse getOrganizationConnectConfigs(UUID organizationId)
                                                                 throws ApiException

Returns a list of Connect configurations under an organization. Required scopes: connect_org_config_read_api

Parameters:

organizationId - The organization ID Guid (required)

Returns:

OrganizationConnectConfigsResponse

Throws:

ApiException

getOrganizationConnectConfigs

public OrganizationConnectConfigsResponse getOrganizationConnectConfigs(UUID organizationId,
                                                                        OrgConnectApi.GetOrganizationConnectConfigsOptions options)
                                                                 throws ApiException

Returns a list of Connect configurations under an organization. Required scopes: connect_org_config_read_api

Parameters:

organizationId - The organization ID Guid (required)

options - for modifying the method behavior.

Returns:

OrganizationConnectConfigsResponse

Throws:

ApiException - if fails to make API call

getOrganizationConnectConfigsWithHttpInfo

public ApiResponse<OrganizationConnectConfigsResponse> getOrganizationConnectConfigsWithHttpInfo(UUID organizationId,
                                                                                                 OrgConnectApi.GetOrganizationConnectConfigsOptions options)
                                                                                          throws ApiException

Returns a list of Connect configurations under an organization Required scopes: connect_org_config_read_api

Parameters:

organizationId - The organization ID Guid (required)

options - for modifying the method behavior.

Returns:

OrganizationConnectConfigsResponse

Throws:

ApiException - if fails to make API call

getOrganizationConnectOAuthConfiguration

public Object getOrganizationConnectOAuthConfiguration(UUID organizationId)
                                                throws ApiException

Returns information about an organization-level Connect OAuth configuration. Required scopes: connect_org_oauth_read_api

Parameters:

organizationId - The organization ID Guid (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

getOrganizationConnectOAuthConfigurationWithHttpInfo

public ApiResponse<Object> getOrganizationConnectOAuthConfigurationWithHttpInfo(UUID organizationId)
                                                                         throws ApiException

Returns information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_read_api

Parameters:

organizationId - The organization ID Guid (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

postConnectHmacSecret

public OrganizationConnectHmacSecretsResponse postConnectHmacSecret(UUID organizationId)
                                                             throws ApiException

Saves information about a Connect HMAC secret. Required scopes: connect_org_hmac_write_api

Parameters:

organizationId - The organization ID Guid (required)

Returns:

OrganizationConnectHmacSecretsResponse

Throws:

ApiException - if fails to make API call

postConnectHmacSecretWithHttpInfo

public ApiResponse<OrganizationConnectHmacSecretsResponse> postConnectHmacSecretWithHttpInfo(UUID organizationId)
                                                                                      throws ApiException

Saves information about a Connect HMAC secret Required scopes: connect_org_hmac_write_api

Parameters:

organizationId - The organization ID Guid (required)

Returns:

OrganizationConnectHmacSecretsResponse

Throws:

ApiException - if fails to make API call

postOrganizationConnectOAuthConfiguration

public OrganizationConnectOAuthConfiguration postOrganizationConnectOAuthConfiguration(UUID organizationId,
                                                                                       OrganizationConnectOAuthConfiguration _configuration)
                                                                                throws ApiException

Saves information about an organization-level Connect OAuth configuration. Required scopes: connect_org_oauth_write_api

Parameters:

organizationId - The organization ID Guid (required)

_configuration - Add an organization-level Connect OAuth configuration (required)

Returns:

OrganizationConnectOAuthConfiguration

Throws:

ApiException - if fails to make API call

postOrganizationConnectOAuthConfigurationWithHttpInfo

public ApiResponse<OrganizationConnectOAuthConfiguration> postOrganizationConnectOAuthConfigurationWithHttpInfo(UUID organizationId,
                                                                                                                OrganizationConnectOAuthConfiguration _configuration)
                                                                                                         throws ApiException

Saves information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api

Parameters:

organizationId - The organization ID Guid (required)

_configuration - Add an organization-level Connect OAuth configuration (required)

Returns:

OrganizationConnectOAuthConfiguration

Throws:

ApiException - if fails to make API call

putOrganizationConnectOAuthConfiguration

public OrganizationConnectOAuthConfiguration putOrganizationConnectOAuthConfiguration(UUID organizationId,
                                                                                      OrganizationConnectOAuthConfiguration _configuration)
                                                                               throws ApiException

Updates information about an organization-level Connect OAuth configuration. Required scopes: connect_org_oauth_write_api

Parameters:

organizationId - The organization ID Guid (required)

_configuration - Update an organization-level Connect OAuth configuration (required)

Returns:

OrganizationConnectOAuthConfiguration

Throws:

ApiException - if fails to make API call

putOrganizationConnectOAuthConfigurationWithHttpInfo

public ApiResponse<OrganizationConnectOAuthConfiguration> putOrganizationConnectOAuthConfigurationWithHttpInfo(UUID organizationId,
                                                                                                               OrganizationConnectOAuthConfiguration _configuration)
                                                                                                        throws ApiException

Updates information about an organization-level Connect OAuth configuration Required scopes: connect_org_oauth_write_api

Parameters:

organizationId - The organization ID Guid (required)

_configuration - Update an organization-level Connect OAuth configuration (required)

Returns:

OrganizationConnectOAuthConfiguration

Throws:

ApiException - if fails to make API call

updateOrganizationConnectConfig

public OrganizationConnectConfigurationDetailsResponse updateOrganizationConnectConfig(UUID organizationId,
                                                                                       UUID connectId,
                                                                                       OrganizationConnectConfigurationRequest connectRequest)
                                                                                throws ApiException

Updates an organization-level Connect configuration. Required scopes: connect_org_config_write_api

Parameters:

organizationId - The organization ID Guid (required)

connectId - The configuration ID Guid (required)

connectRequest - Add an organization Connect request (required)

Returns:

OrganizationConnectConfigurationDetailsResponse

Throws:

ApiException - if fails to make API call

updateOrganizationConnectConfigWithHttpInfo

public ApiResponse<OrganizationConnectConfigurationDetailsResponse> updateOrganizationConnectConfigWithHttpInfo(UUID organizationId,
                                                                                                                UUID connectId,
                                                                                                                OrganizationConnectConfigurationRequest connectRequest)
                                                                                                         throws ApiException

Updates an organization-level Connect configuration Required scopes: connect_org_config_write_api

Parameters:

organizationId - The organization ID Guid (required)

connectId - The configuration ID Guid (required)

connectRequest - Add an organization Connect request (required)

Returns:

OrganizationConnectConfigurationDetailsResponse

Throws:

ApiException - if fails to make API call