| Package | Description |
|---|---|
| com.docusign.admin.api | |
| com.docusign.admin.client | |
| com.docusign.admin.client.auth |
| Modifier and Type | Method and Description |
|---|---|
UpdateResponse |
UsersApi.activateMembership(UUID organizationId,
UUID userId,
UUID membershipId,
ForceActivateMembershipRequest request)
Activates user memberships
Required scopes: user_write
|
OrganizationAccountSettingsImportResponse |
BulkImportsApi.addBulkAccountSettingsImport(UUID organizationId,
byte[] fileCsv)
Creates a new account settings import request.
|
DSGroupResponse |
DsGroupsApi.addDSGroup(UUID organizationId,
UUID accountId,
DSGroupAddRequest addRequest)
Add a new DSGroup
Required scopes: user_write
|
AddDSGroupAndUsersResponse |
DsGroupsApi.addDSGroupUsers(UUID organizationId,
UUID accountId,
UUID dsGroupId,
DSGroupUsersAddRequest dSGroupUsersAddRequest)
Add list of users to a DSGroup
Required scopes: user_write
|
AddUserResponse |
UsersApi.addOrUpdateUser(UUID organizationId,
UUID accountId,
NewMultiProductUserAddRequest request)
Creates and updates a multi-product user
Required scopes: user_write
|
UserProductPermissionProfilesResponse |
ProductPermissionProfilesApi.addUserProductPermissionProfiles(UUID organizationId,
UUID accountId,
UUID userId,
ProductPermissionProfilesRequest productPermissionProfilesRequest)
Assign user to permission profiles for one or more products
Required scopes: user_write
|
NewUserResponse |
UsersApi.addUsers(UUID organizationId,
UUID accountId,
NewAccountUserRequest request)
Adds users to an account.
|
DeleteMembershipsResponse |
UsersApi.closeMemberships(UUID organizationId,
UUID userId,
DeleteMembershipsRequest request)
Closes a user's memberships.
|
OrganizationExportResponse |
BulkExportsApi.createAccountSettingsExport(UUID organizationId,
OrganizationAccountsRequest request)
Creates a new Account Setting Export request.
|
OrganizationImportResponse |
BulkImportsApi.createBulkImportAddUsersRequest(UUID organizationId,
byte[] fileCsv)
Import request for adding users to accounts within the organization.
|
OrganizationImportResponse |
BulkImportsApi.createBulkImportCloseUsersRequest(UUID organizationId)
Closes the Bulk User Import request
Required scopes: user_write
|
OrganizationImportResponse |
BulkImportsApi.createBulkImportExternalCloseUsersRequest(UUID organizationId)
Closes memberships which are not in an account which is part of the organization, but which do have email addresses which are @ a verified reserved web domain which belongs to the organization
Required scopes: user_write
|
OrganizationImportResponse |
BulkImportsApi.createBulkImportSingleAccountAddUsersRequest(UUID organizationId,
UUID accountId,
byte[] fileCsv)
Import request for adding user to a single account within the organization.
|
OrganizationImportResponse |
BulkImportsApi.createBulkImportSingleAccountUpdateUsersRequest(UUID organizationId,
UUID accountId,
byte[] fileCsv)
Import request for updating users for a single account within the organization.
|
OrganizationImportResponse |
BulkImportsApi.createBulkImportUpdateUsersRequest(UUID organizationId,
byte[] fileCsv)
Import request for updating users to accounts within the organization.
|
NewUserResponse |
UsersApi.createUser(UUID organizationId,
NewUserRequest request)
Creates a new user
Required scopes: user_write
|
OrganizationExportResponse |
BulkExportsApi.createUserListExport(UUID organizationId,
OrganizationExportRequest request)
Creates a new User List Export request.
|
Object |
BulkExportsApi.deleteAccountSettingsExport(UUID organizationId,
UUID exportId)
Deletes a single Account Settings Export request
Required scopes: account_read
|
Object |
BulkImportsApi.deleteBulkAccountSettingsImport(UUID organizationId,
UUID importId)
Deletes a Bulk Account Settings Import request
Required scopes: account_write
|
Object |
BulkImportsApi.deleteBulkUserImport(UUID organizationId,
UUID importId)
Deletes a User Import request
Required scopes: user_write
|
void |
DsGroupsApi.deleteDSGroup(UUID organizationId,
UUID accountId,
UUID dsGroupId)
Delete a DSGroup
Required scopes: user_write
|
DeleteResponse |
UsersApi.deleteIdentities(UUID organizationId,
UUID userId,
DeleteUserIdentityRequest requestModel)
Deletes user identities.
|
Object |
BulkExportsApi.deleteUserListExport(UUID organizationId,
UUID exportId)
Deletes a single User List Export request
Required scopes: user_read
|
OrganizationExportResponse |
BulkExportsApi.getAccountSettingsExport(UUID organizationId,
UUID exportId)
Returns the details/metadata for a single Account Setting Export request
Required scopes: account_read
|
OrganizationExportsResponse |
BulkExportsApi.getAccountSettingsExports(UUID organizationId)
Returns the details/metadata for Account Setting Export requests
Required scopes: account_read
|
OrganizationAccountSettingsImportResponse |
BulkImportsApi.getBulkAccountSettingsImport(UUID organizationId,
UUID importId)
Returns the details/metadata for a Bulk Account Settings Import request
Required scopes: account_read
|
List<OrganizationAccountSettingsImportResponse> |
BulkImportsApi.getBulkAccountSettingsImports(UUID organizationId)
Returns the details/metadata for Bulk Account Settings Import requests in the organization
Required scopes: account_read
|
Object |
BulkImportsApi.getBulkUserImportCSV(UUID organizationId,
UUID importId)
Returns a text/csv file with user details for a User Import request
Required scopes: user_read
|
OrganizationImportResponse |
BulkImportsApi.getBulkUserImportRequest(UUID organizationId,
UUID importId)
Returns the details/metadata for a User Import request
Required scopes: user_read
|
OrganizationImportsResponse |
BulkImportsApi.getBulkUserImportRequests(UUID organizationId)
Returns the details/metadata for Bulk User Import requests in the organization
Required scopes: user_read
|
DSGroupResponse |
DsGroupsApi.getDSGroup(UUID organizationId,
UUID accountId,
UUID dsGroupId)
Get list of DSGroup
Required scopes: user_read
|
DSGroupListResponse |
DsGroupsApi.getDSGroups(UUID organizationId,
UUID accountId)
Get list of DSGroups
Required scopes: user_read
|
DSGroupListResponse |
DsGroupsApi.getDSGroups(UUID organizationId,
UUID accountId,
DsGroupsApi.GetDSGroupsOptions options)
Get list of DSGroups
Required scopes: user_read
|
DSGroupAndUsersResponse |
DsGroupsApi.getDSGroupUsers(UUID organizationId,
UUID accountId,
UUID dsGroupId)
Get list of users in a DSGroup
Required scopes: user_read
|
DSGroupAndUsersResponse |
DsGroupsApi.getDSGroupUsers(UUID organizationId,
UUID accountId,
UUID dsGroupId,
DsGroupsApi.GetDSGroupUsersOptions options)
Get list of users in a DSGroup
Required scopes: user_read
|
MemberGroupsResponse |
AccountsApi.getGroups(UUID organizationId,
UUID accountId)
Returns the list of groups in an account.
|
MemberGroupsResponse |
AccountsApi.getGroups(UUID organizationId,
UUID accountId,
AccountsApi.GetGroupsOptions options)
Returns the list of groups in an account.
|
IdentityProvidersResponse |
IdentityProvidersApi.getIdentityProviders(UUID organizationId)
Returns the list of identity providers for the organization.
|
OrganizationsResponse |
AccountsApi.getOrganizations()
Returns the list of organizations of which the authenticated user is a member.
|
OrganizationsResponse |
AccountsApi.getOrganizations(AccountsApi.GetOrganizationsOptions options)
Returns the list of organizations of which the authenticated user is a member.
|
PermissionsResponse |
AccountsApi.getPermissions(UUID organizationId,
UUID accountId)
Returns the list of permission profiles in an account.
|
ProductPermissionProfilesResponse |
ProductPermissionProfilesApi.getProductPermissionProfiles(UUID organizationId,
UUID accountId)
Get products associated with the account and the available permission profiles
Required scopes: user_read
|
DomainsResponse |
ReservedDomainsApi.getReservedDomains(UUID organizationId)
Returns the list of reserved domains for the organization.
|
OrganizationExportResponse |
BulkExportsApi.getUserListExport(UUID organizationId,
UUID exportId)
Returns the details/metadata for a single User List Export request
Required scopes: user_read
|
OrganizationExportsResponse |
BulkExportsApi.getUserListExports(UUID organizationId)
Returns a list of existing User List Exports (requests and completed exports) and their details/metadata
Required scopes: user_read
|
ProductPermissionProfilesResponse |
ProductPermissionProfilesApi.getUserProductPermissionProfiles(UUID organizationId,
UUID accountId,
UUID userId)
Retrieve list of user's permission profiles for each account's product
Required scopes: user_read
|
UsersDrilldownResponse |
UsersApi.getUserProfiles(UUID organizationId)
Returns user information.
|
UsersDrilldownResponse |
UsersApi.getUserProfiles(UUID organizationId,
UsersApi.GetUserProfilesOptions options)
Returns user information.
|
OrganizationUsersResponse |
UsersApi.getUsers(UUID organizationId)
Returns information about the users in the organization
Required scopes: user_read
|
OrganizationUsersResponse |
UsersApi.getUsers(UUID organizationId,
UsersApi.GetUsersOptions options)
Returns information about the users in the organization
Required scopes: user_read
|
RemoveDSGroupUsersResponse |
DsGroupsApi.removeDSGroupUsers(UUID organizationId,
UUID accountId,
UUID dsGroupId,
DSGroupUsersRemoveRequest dSGroupUsersRemoveRequest)
Remove users from a DSGroup
Required scopes: user_write
|
UsersUpdateResponse |
UsersApi.updateEmailAddress(UUID organizationId,
UpdateUsersEmailRequest request)
Updates a user's email address.
|
UsersUpdateResponse |
UsersApi.updateUser(UUID organizationId,
UpdateUsersRequest request)
Updates a user.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ApiClient.configureJWTAuthorizationFlow(String publicKeyFilename,
String privateKeyFilename,
String oAuthBasePath,
String clientId,
String userId,
long expiresIn)
Deprecated.
As of release 2.7.0, replaced by
ApiClient.requestJWTUserToken(String, String, List, byte[], long) ()} and ApiClient.requestJWTApplicationToken(String, List, byte[], long) |
<T> T |
ApiClient.deserialize(javax.ws.rs.core.Response response,
javax.ws.rs.core.GenericType<T> returnType)
Deserialize response body to Java object according to the Content-Type.
|
File |
ApiClient.downloadFileFromResponse(javax.ws.rs.core.Response response)
Download file from the given response.
|
OAuth.OAuthToken |
ApiClient.generateAccessToken(String clientId,
String clientSecret,
String code) |
OAuth.UserInfo |
ApiClient.getUserInfo(String accessToken) |
<T> T |
ApiClient.invokeAPI(String path,
String method,
List<Pair> queryParams,
List<Pair> collectionQueryParams,
Object body,
Map<String,String> headerParams,
Map<String,Object> formParams,
String accept,
String contentType,
String[] authNames,
javax.ws.rs.core.GenericType<T> returnType)
Invoke API by sending HTTP request with the given options.
|
OAuth.OAuthToken |
ApiClient.requestJWTApplicationToken(String clientId,
List<String> scopes,
byte[] rsaPrivateKey,
long expiresIn)
RESERVED FOR PARTNERS Request JWT Application Token
Configures the current instance of ApiClient with a fresh OAuth JWT access token from DocuSign
|
OAuth.OAuthToken |
ApiClient.requestJWTUserToken(String clientId,
String userId,
List<String> scopes,
byte[] rsaPrivateKey,
long expiresIn)
Configures the current instance of ApiClient with a fresh OAuth JWT access token from DocuSign
|
javax.ws.rs.client.Entity<?> |
ApiClient.serialize(Object obj,
Map<String,Object> formParams,
String contentType)
Serialize the given Java object into string entity according the given
Content-Type (only JSON is supported for now).
|
Object |
ApiClient.serialize(Object obj,
String contentType,
Map<String,Object> formParams)
Serialize the given Java object into string according the given
Content-Type (only JSON is supported for now).
|
| Modifier and Type | Method and Description |
|---|---|
void |
OAuth.updateAccessToken() |
Copyright © 2021. All rights reserved.