Package com.docusign.admin.api

Class UsersApi

  • public class UsersApi
extends Object
    UsersApi class.

    • Constructor Detail

      • UsersApi

        public UsersApi()
        UsersApi.

      • UsersApi

        public UsersApi​(ApiClient apiClient)
        UsersApi.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        getApiClient Method.
        Returns:
        ApiClient

      • setApiClient

        public void setApiClient​(ApiClient apiClient)
        setApiClient Method.

      • activateMembership

        public UpdateResponse activateMembership​(UUID organizationId,
                                         UUID userId,
                                         UUID membershipId,
                                         ForceActivateMembershipRequest request)
                                  throws ApiException
        Activates user memberships. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        userId - The user ID Guid (required)
        membershipId - The membership ID Guid (required)
        request - Additional details about the user's membership (required)
        Returns:
        UpdateResponse
        Throws:
        ApiException - if fails to make API call

      • activateMembershipWithHttpInfo

        public ApiResponse<UpdateResponse> activateMembershipWithHttpInfo​(UUID organizationId,
                                                                  UUID userId,
                                                                  UUID membershipId,
                                                                  ForceActivateMembershipRequest request)
                                                           throws ApiException
        Activates user memberships Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        userId - The user ID Guid (required)
        membershipId - The membership ID Guid (required)
        request - Additional details about the user's membership (required)
        Returns:
        UpdateResponse
        Throws:
        ApiException - if fails to make API call

      • addOrUpdateUser

        public AddUserResponse addOrUpdateUser​(UUID organizationId,
                                       UUID accountId,
                                       NewMultiProductUserAddRequest request)
                                throws ApiException
        Creates and updates a multi-product user. Required scopes: user_write
        Parameters:
        organizationId - The organization ID GUID (required)
        accountId - The account ID GUID (required)
        request - The request object (required)
        Returns:
        AddUserResponse
        Throws:
        ApiException - if fails to make API call

      • addOrUpdateUserWithHttpInfo

        public ApiResponse<AddUserResponse> addOrUpdateUserWithHttpInfo​(UUID organizationId,
                                                                UUID accountId,
                                                                NewMultiProductUserAddRequest request)
                                                         throws ApiException
        Creates and updates a multi-product user Required scopes: user_write
        Parameters:
        organizationId - The organization ID GUID (required)
        accountId - The account ID GUID (required)
        request - The request object (required)
        Returns:
        AddUserResponse
        Throws:
        ApiException - if fails to make API call

      • addUsers

        public NewUserResponse addUsers​(UUID organizationId,
                                UUID accountId,
                                NewAccountUserRequest request)
                         throws ApiException
        Adds users to an account.. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        accountId - The account ID Guid (required)
        request - The details for the users to add to the account (required)
        Returns:
        NewUserResponse
        Throws:
        ApiException - if fails to make API call

      • addUsersWithHttpInfo

        public ApiResponse<NewUserResponse> addUsersWithHttpInfo​(UUID organizationId,
                                                         UUID accountId,
                                                         NewAccountUserRequest request)
                                                  throws ApiException
        Adds users to an account. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        accountId - The account ID Guid (required)
        request - The details for the users to add to the account (required)
        Returns:
        NewUserResponse
        Throws:
        ApiException - if fails to make API call

      • closeMemberships

        public DeleteMembershipsResponse closeMemberships​(UUID organizationId,
                                                  UUID userId,
                                                  DeleteMembershipsRequest request)
                                           throws ApiException
        Closes a user's memberships.. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        userId - The user ID Guid (required)
        request - The details about which membership to close (required)
        Returns:
        DeleteMembershipsResponse
        Throws:
        ApiException - if fails to make API call

      • closeMembershipsWithHttpInfo

        public ApiResponse<DeleteMembershipsResponse> closeMembershipsWithHttpInfo​(UUID organizationId,
                                                                           UUID userId,
                                                                           DeleteMembershipsRequest request)
                                                                    throws ApiException
        Closes a user's memberships. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        userId - The user ID Guid (required)
        request - The details about which membership to close (required)
        Returns:
        DeleteMembershipsResponse
        Throws:
        ApiException - if fails to make API call

      • createUser

        public NewUserResponse createUser​(UUID organizationId,
                                  NewUserRequest request)
                           throws ApiException
        Creates a new user. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        request - Details about the user to be added (required)
        Returns:
        NewUserResponse
        Throws:
        ApiException - if fails to make API call

      • createUserWithHttpInfo

        public ApiResponse<NewUserResponse> createUserWithHttpInfo​(UUID organizationId,
                                                           NewUserRequest request)
                                                    throws ApiException
        Creates a new user Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        request - Details about the user to be added (required)
        Returns:
        NewUserResponse
        Throws:
        ApiException - if fails to make API call

      • deleteIdentities

        public DeleteResponse deleteIdentities​(UUID organizationId,
                                       UUID userId,
                                       DeleteUserIdentityRequest requestModel)
                                throws ApiException
        Deletes user identities.. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        userId - The user ID Guid (required)
        requestModel - The details for the user identities to be deleted (required)
        Returns:
        DeleteResponse
        Throws:
        ApiException - if fails to make API call

      • deleteIdentitiesWithHttpInfo

        public ApiResponse<DeleteResponse> deleteIdentitiesWithHttpInfo​(UUID organizationId,
                                                                UUID userId,
                                                                DeleteUserIdentityRequest requestModel)
                                                         throws ApiException
        Deletes user identities. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        userId - The user ID Guid (required)
        requestModel - The details for the user identities to be deleted (required)
        Returns:
        DeleteResponse
        Throws:
        ApiException - if fails to make API call

      • getUserDSProfile

        public UsersDrilldownResponse getUserDSProfile​(UUID organizationId,
                                               UUID userId)
                                        throws ApiException
        Returns user information using the userId for lookup.. Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        userId - The user ID Guid (required)
        Returns:
        UsersDrilldownResponse
        Throws:
        ApiException

      • getUserDSProfile

        public UsersDrilldownResponse getUserDSProfile​(UUID organizationId,
                                               UUID userId,
                                               UsersApi.GetUserDSProfileOptions options)
                                        throws ApiException
        Returns user information using the userId for lookup.. Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        userId - The user ID Guid (required)
        options - for modifying the method behavior.
        Returns:
        UsersDrilldownResponse
        Throws:
        ApiException - if fails to make API call

      • getUserDSProfileWithHttpInfo

        public ApiResponse<UsersDrilldownResponse> getUserDSProfileWithHttpInfo​(UUID organizationId,
                                                                        UUID userId,
                                                                        UsersApi.GetUserDSProfileOptions options)
                                                                 throws ApiException
        Returns user information using the userId for lookup. Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        userId - The user ID Guid (required)
        options - for modifying the method behavior.
        Returns:
        UsersDrilldownResponse
        Throws:
        ApiException - if fails to make API call

      • getUserDSProfilesByEmail

        public UsersDrilldownResponse getUserDSProfilesByEmail​(UUID organizationId)
                                                throws ApiException
        Returns DS user profile information.. Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        Returns:
        UsersDrilldownResponse
        Throws:
        ApiException

      • getUserProfiles

        public UsersDrilldownResponse getUserProfiles​(UUID organizationId)
                                       throws ApiException
        Returns user information.. Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        Returns:
        UsersDrilldownResponse
        Throws:
        ApiException

      • getUsers

        public OrganizationUsersResponse getUsers​(UUID organizationId)
                                   throws ApiException
        Returns information about the users in the organization. Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        Returns:
        OrganizationUsersResponse
        Throws:
        ApiException

      • getUsers

        public OrganizationUsersResponse getUsers​(UUID organizationId,
                                          UsersApi.GetUsersOptions options)
                                   throws ApiException
        Returns information about the users in the organization. Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        options - for modifying the method behavior.
        Returns:
        OrganizationUsersResponse
        Throws:
        ApiException - if fails to make API call

      • getUsersWithHttpInfo

        public ApiResponse<OrganizationUsersResponse> getUsersWithHttpInfo​(UUID organizationId,
                                                                   UsersApi.GetUsersOptions options)
                                                            throws ApiException
        Returns information about the users in the organization Required scopes: user_read
        Parameters:
        organizationId - The organization ID Guid (required)
        options - for modifying the method behavior.
        Returns:
        OrganizationUsersResponse
        Throws:
        ApiException - if fails to make API call

      • updateEmailAddress

        public UsersUpdateResponse updateEmailAddress​(UUID organizationId,
                                              UpdateUsersEmailRequest request)
                                       throws ApiException
        Updates a user's email address.. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        request - The details about which email addresses to update (required)
        Returns:
        UsersUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • updateEmailAddressWithHttpInfo

        public ApiResponse<UsersUpdateResponse> updateEmailAddressWithHttpInfo​(UUID organizationId,
                                                                       UpdateUsersEmailRequest request)
                                                                throws ApiException
        Updates a user's email address. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        request - The details about which email addresses to update (required)
        Returns:
        UsersUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • updateUser

        public UsersUpdateResponse updateUser​(UUID organizationId,
                                      UpdateUsersRequest request)
                               throws ApiException
        Updates a user.. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        request - The user details to update (required)
        Returns:
        UsersUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • updateUserWithHttpInfo

        public ApiResponse<UsersUpdateResponse> updateUserWithHttpInfo​(UUID organizationId,
                                                               UpdateUsersRequest request)
                                                        throws ApiException
        Updates a user. Required scopes: user_write
        Parameters:
        organizationId - The organization ID Guid (required)
        request - The user details to update (required)
        Returns:
        UsersUpdateResponse
        Throws:
        ApiException - if fails to make API call