usermanagement

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 12, 2023 License: BSD-3-Clause Imports: 6 Imported by: 0

Documentation

Overview

Package usermanagement implements the DocuSign SDK category UserManagement.

Methods to manage users in an account.

Service Api documentation may be found at: https://developers.docusign.com/docs/admin-api/reference/UserManagement Usage example: 

import (
    "github.com/jfcote87/esign"
    "github.com/jfcote87/esign/admin"
)
...
usermanagementService := usermanagement.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateMembershipOp 

type ActivateMembershipOp esign.Op

ActivateMembershipOp implements DocuSign API SDK UserManagement::activateMembership

func (*ActivateMembershipOp) Do 

func (op *ActivateMembershipOp) Do(ctx context.Context) (*admin.UpdateResponse, error)

Do executes the op. A nil context will return error.

type AddDSGroupOp 

type AddDSGroupOp esign.Op

AddDSGroupOp implements DocuSign API SDK UserManagement::addDSGroup

func (*AddDSGroupOp) Do 

func (op *AddDSGroupOp) Do(ctx context.Context) (*admin.DSGroupResponse, error)

Do executes the op. A nil context will return error.

type AddDSGroupUsersOp 

type AddDSGroupUsersOp esign.Op

AddDSGroupUsersOp implements DocuSign API SDK UserManagement::addDSGroupUsers

func (*AddDSGroupUsersOp) Do 

func (op *AddDSGroupUsersOp) Do(ctx context.Context) (*admin.AddDSGroupAndUsersResponse, error)

Do executes the op. A nil context will return error.

type AddOrUpdateUserOp 

type AddOrUpdateUserOp esign.Op

AddOrUpdateUserOp implements DocuSign API SDK UserManagement::addOrUpdateUser

func (*AddOrUpdateUserOp) Do 

func (op *AddOrUpdateUserOp) Do(ctx context.Context) (*admin.AddUserResponse, error)

Do executes the op. A nil context will return error.

type AddUserProductPermissionProfilesOp 

type AddUserProductPermissionProfilesOp esign.Op

AddUserProductPermissionProfilesOp implements DocuSign API SDK UserManagement::addUserProductPermissionProfiles

func (*AddUserProductPermissionProfilesOp) Do 

func (op *AddUserProductPermissionProfilesOp) Do(ctx context.Context) (*admin.UserProductPermissionProfilesResponse, error)

Do executes the op. A nil context will return error.

type AddUsersOp 

type AddUsersOp esign.Op

AddUsersOp implements DocuSign API SDK UserManagement::addUsers

func (*AddUsersOp) Do 

func (op *AddUsersOp) Do(ctx context.Context) (*admin.NewUserResponse, error)

Do executes the op. A nil context will return error.

type CloseMembershipsOp 

type CloseMembershipsOp esign.Op

CloseMembershipsOp implements DocuSign API SDK UserManagement::closeMemberships

func (*CloseMembershipsOp) Do 

func (op *CloseMembershipsOp) Do(ctx context.Context) (*admin.DeleteMembershipsResponse, error)

Do executes the op. A nil context will return error.

type CreateUserOp 

type CreateUserOp esign.Op

CreateUserOp implements DocuSign API SDK UserManagement::createUser

func (*CreateUserOp) Do 

func (op *CreateUserOp) Do(ctx context.Context) (*admin.NewUserResponse, error)

Do executes the op. A nil context will return error.

type DeleteDSGroupOp 

type DeleteDSGroupOp esign.Op

DeleteDSGroupOp implements DocuSign API SDK UserManagement::deleteDSGroup

func (*DeleteDSGroupOp) Do 

func (op *DeleteDSGroupOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type DeleteIdentitiesOp 

type DeleteIdentitiesOp esign.Op

DeleteIdentitiesOp implements DocuSign API SDK UserManagement::deleteIdentities

func (*DeleteIdentitiesOp) Do 

func (op *DeleteIdentitiesOp) Do(ctx context.Context) (*admin.DeleteResponse, error)

Do executes the op. A nil context will return error.

type GetDSGroupOp 

type GetDSGroupOp esign.Op

GetDSGroupOp implements DocuSign API SDK UserManagement::getDSGroup

func (*GetDSGroupOp) Do 

func (op *GetDSGroupOp) Do(ctx context.Context) (*admin.DSGroupResponse, error)

Do executes the op. A nil context will return error.

type GetDSGroupUsersOp 

type GetDSGroupUsersOp esign.Op

GetDSGroupUsersOp implements DocuSign API SDK UserManagement::getDSGroupUsers

func (*GetDSGroupUsersOp) Do 

func (op *GetDSGroupUsersOp) Do(ctx context.Context) (*admin.DSGroupAndUsersResponse, error)

Do executes the op. A nil context will return error.

func (*GetDSGroupUsersOp) Page 

func (op *GetDSGroupUsersOp) Page(val int) *GetDSGroupUsersOp

Page start page of DSGroups.

func (*GetDSGroupUsersOp) PageSize 

func (op *GetDSGroupUsersOp) PageSize(val int) *GetDSGroupUsersOp

PageSize page size of DSGroups.

type GetDSGroupsOp 

type GetDSGroupsOp esign.Op

GetDSGroupsOp implements DocuSign API SDK UserManagement::getDSGroups

func (*GetDSGroupsOp) Do 

func (op *GetDSGroupsOp) Do(ctx context.Context) (*admin.DSGroupListResponse, error)

Do executes the op. A nil context will return error.

func (*GetDSGroupsOp) Page 

func (op *GetDSGroupsOp) Page(val int) *GetDSGroupsOp

Page start page of DSGroups.

func (*GetDSGroupsOp) PageSize 

func (op *GetDSGroupsOp) PageSize(val int) *GetDSGroupsOp

PageSize page size of DSGroups.

type GetGroupsOp 

type GetGroupsOp esign.Op

GetGroupsOp implements DocuSign API SDK UserManagement::getGroups

func (*GetGroupsOp) Do 

func (op *GetGroupsOp) Do(ctx context.Context) (*admin.MemberGroupsResponse, error)

Do executes the op. A nil context will return error.

func (*GetGroupsOp) End 

func (op *GetGroupsOp) End(val int) *GetGroupsOp

End index of the last item to include in the response. Ignored if `take` parameter is specified.

func (*GetGroupsOp) Start 

func (op *GetGroupsOp) Start(val int) *GetGroupsOp

Start index of first item to include in the response. The default value is 0.

func (*GetGroupsOp) Take 

func (op *GetGroupsOp) Take(val int) *GetGroupsOp

Take page size of the response. The default value is 20.

type GetPermissionsOp 

type GetPermissionsOp esign.Op

GetPermissionsOp implements DocuSign API SDK UserManagement::getPermissions

func (*GetPermissionsOp) Do 

func (op *GetPermissionsOp) Do(ctx context.Context) (*admin.PermissionsResponse, error)

Do executes the op. A nil context will return error.

type GetProductPermissionProfilesOp 

type GetProductPermissionProfilesOp esign.Op

GetProductPermissionProfilesOp implements DocuSign API SDK UserManagement::getProductPermissionProfiles

func (*GetProductPermissionProfilesOp) Do 

func (op *GetProductPermissionProfilesOp) Do(ctx context.Context) (*admin.ProductPermissionProfilesResponse, error)

Do executes the op. A nil context will return error.

type GetUserProductPermissionProfilesOp 

type GetUserProductPermissionProfilesOp esign.Op

GetUserProductPermissionProfilesOp implements DocuSign API SDK UserManagement::getUserProductPermissionProfiles

func (*GetUserProductPermissionProfilesOp) Do 

func (op *GetUserProductPermissionProfilesOp) Do(ctx context.Context) (*admin.ProductPermissionProfilesResponse, error)

Do executes the op. A nil context will return error.

type GetUserProfilesOp 

type GetUserProfilesOp esign.Op

GetUserProfilesOp implements DocuSign API SDK UserManagement::getUserProfiles

func (*GetUserProfilesOp) Do 

func (op *GetUserProfilesOp) Do(ctx context.Context) (*admin.UsersDrilldownResponse, error)

Do executes the op. A nil context will return error.

func (*GetUserProfilesOp) Email 

func (op *GetUserProfilesOp) Email(val string) *GetUserProfilesOp

Email is the email address associated with the users you want to retrieve.

type GetUsersOp 

type GetUsersOp esign.Op

GetUsersOp implements DocuSign API SDK UserManagement::getUsers

func (*GetUsersOp) AccountID 

func (op *GetUsersOp) AccountID(val string) *GetUsersOp

AccountID select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.

func (*GetUsersOp) Do 

func (op *GetUsersOp) Do(ctx context.Context) (*admin.OrganizationUsersResponse, error)

Do executes the op. A nil context will return error.

func (*GetUsersOp) Email 

func (op *GetUsersOp) Email(val string) *GetUsersOp

Email email address of the desired user. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.

func (*GetUsersOp) EmailUserNameLike 

func (op *GetUsersOp) EmailUserNameLike(val string) *GetUsersOp

EmailUserNameLike selects users by pattern matching on the user's email address

func (*GetUsersOp) End 

func (op *GetUsersOp) End(val int) *GetUsersOp

End index of the last item to include in the response. Ignored if `take` parameter is specified.

func (*GetUsersOp) LastModifiedSince 

func (op *GetUsersOp) LastModifiedSince(val string) *GetUsersOp

LastModifiedSince select users whose data have been modified since the date specified. `account_id` or `organization_reserved_domain_id` must be specified.

func (*GetUsersOp) MembershipStatus 

func (op *GetUsersOp) MembershipStatus(val string) *GetUsersOp

MembershipStatus is the user's membership status. One of:

- `activation_required` - `activation_sent` - `active` - `closed` - `disabled`

func (*GetUsersOp) OrganizationReservedDomainID 

func (op *GetUsersOp) OrganizationReservedDomainID(val string) *GetUsersOp

OrganizationReservedDomainID select users that are in the specified domain. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.

func (*GetUsersOp) Start 

func (op *GetUsersOp) Start(val int) *GetUsersOp

Start index of first item to include in the response. The default value is 0.

func (*GetUsersOp) Status 

func (op *GetUsersOp) Status(val string) *GetUsersOp

Status status.

func (*GetUsersOp) Take 

func (op *GetUsersOp) Take(val int) *GetUsersOp

Take page size of the response. The default value is 20.

type RemoveDSGroupUsersOp 

type RemoveDSGroupUsersOp esign.Op

RemoveDSGroupUsersOp implements DocuSign API SDK UserManagement::removeDSGroupUsers

func (*RemoveDSGroupUsersOp) Do 

func (op *RemoveDSGroupUsersOp) Do(ctx context.Context) (*admin.RemoveDSGroupUsersResponse, error)

Do executes the op. A nil context will return error.

type Service 

type Service struct {
	// contains filtered or unexported fields
}

Service implements DocuSign UserManagement API operations

func New 

func New(cred esign.Credential) *Service

New initializes a usermanagement service using cred to authorize ops.

func (*Service) ActivateMembership 

func (s *Service) ActivateMembership(organizationID string, userID string, membershipID string, request *admin.ForceActivateMembershipRequest) *ActivateMembershipOp

ActivateMembership activates user memberships.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/esignusermanagement/activatemembership

SDK Method UserManagement::activateMembership

func (*Service) AddDSGroup 

func (s *Service) AddDSGroup(organizationID string, addRequest *admin.DSGroupAddRequest) *AddDSGroupOp

AddDSGroup creates a new DSGroup.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/adddsgroup

SDK Method UserManagement::addDSGroup

func (*Service) AddDSGroupUsers 

func (s *Service) AddDSGroupUsers(organizationID string, dsGroupID string, dSGroupUsersAddRequest *admin.DSGroupUsersAddRequest) *AddDSGroupUsersOp

AddDSGroupUsers adds a list of users to a DSGroup.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/adddsgroupusers

SDK Method UserManagement::addDSGroupUsers

func (*Service) AddOrUpdateUser 

func (s *Service) AddOrUpdateUser(organizationID string, request *admin.NewMultiProductUserAddRequest) *AddOrUpdateUserOp

AddOrUpdateUser creates and updates a multi-product user.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/addorupdateuser

SDK Method UserManagement::addOrUpdateUser

func (*Service) AddUserProductPermissionProfiles 

func (s *Service) AddUserProductPermissionProfiles(organizationID string, userID string, productPermissionProfilesRequest *admin.ProductPermissionProfilesRequest) *AddUserProductPermissionProfilesOp

AddUserProductPermissionProfiles assigns user to permission profiles for one or more products.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/adduserproductpermissionprofiles

SDK Method UserManagement::addUserProductPermissionProfiles

func (*Service) AddUsers 

func (s *Service) AddUsers(organizationID string, request *admin.NewAccountUserRequest) *AddUsersOp

AddUsers adds users to an account.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/esignusermanagement/addusers

SDK Method UserManagement::addUsers

func (*Service) CloseMemberships 

func (s *Service) CloseMemberships(organizationID string, userID string, request *admin.DeleteMembershipsRequest) *CloseMembershipsOp

CloseMemberships closes a user's memberships.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/esignusermanagement/closememberships

SDK Method UserManagement::closeMemberships

func (*Service) CreateUser 

func (s *Service) CreateUser(organizationID string, request *admin.NewUserRequest) *CreateUserOp

CreateUser creates a new user.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/esignusermanagement/createuser

SDK Method UserManagement::createUser

func (*Service) DeleteDSGroup 

func (s *Service) DeleteDSGroup(organizationID string, dsGroupID string) *DeleteDSGroupOp

DeleteDSGroup deletes a DSGroup.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/deletedsgroup

SDK Method UserManagement::deleteDSGroup

func (*Service) DeleteIdentities 

func (s *Service) DeleteIdentities(organizationID string, userID string, requestModel *admin.DeleteUserIdentityRequest) *DeleteIdentitiesOp

DeleteIdentities deletes user identities.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/esignusermanagement/deleteidentities

SDK Method UserManagement::deleteIdentities

func (*Service) GetDSGroup 

func (s *Service) GetDSGroup(organizationID string, dsGroupID string) *GetDSGroupOp

GetDSGroup returns details about a single DSGroup.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/getdsgroup

SDK Method UserManagement::getDSGroup

func (*Service) GetDSGroupUsers 

func (s *Service) GetDSGroupUsers(organizationID string, dsGroupID string) *GetDSGroupUsersOp

GetDSGroupUsers gets a list of users in a DSGroup.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/getdsgroupusers

SDK Method UserManagement::getDSGroupUsers

func (*Service) GetDSGroups 

func (s *Service) GetDSGroups(organizationID string) *GetDSGroupsOp

GetDSGroups returns a list of DSGroups.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/getdsgroups

SDK Method UserManagement::getDSGroups

func (*Service) GetGroups 

func (s *Service) GetGroups(organizationID string) *GetGroupsOp

GetGroups returns the list of groups in an account.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/esignusermanagement/getgroups

SDK Method UserManagement::getGroups

func (*Service) GetPermissions 

func (s *Service) GetPermissions(organizationID string) *GetPermissionsOp

GetPermissions returns the list of permission profiles in an account.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/esignusermanagement/getpermissions

SDK Method UserManagement::getPermissions

func (*Service) GetProductPermissionProfiles 

func (s *Service) GetProductPermissionProfiles(organizationID string) *GetProductPermissionProfilesOp

GetProductPermissionProfiles gets products associated with the account and the available permission profiles.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/getproductpermissionprofiles

SDK Method UserManagement::getProductPermissionProfiles

func (*Service) GetUserProductPermissionProfiles 

func (s *Service) GetUserProductPermissionProfiles(organizationID string, userID string) *GetUserProductPermissionProfilesOp

GetUserProductPermissionProfiles retrieves a list of user's permission profiles for each account's product.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/getuserproductpermissionprofiles

SDK Method UserManagement::getUserProductPermissionProfiles

func (*Service) GetUserProfiles 

func (s *Service) GetUserProfiles(organizationID string) *GetUserProfilesOp

GetUserProfiles returns information about recently modified users.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/esignusermanagement/getuserprofiles

SDK Method UserManagement::getUserProfiles

func (*Service) GetUsers 

func (s *Service) GetUsers(organizationID string) *GetUsersOp

GetUsers returns information about the users in an organization.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/users/getusers

SDK Method UserManagement::getUsers

func (*Service) RemoveDSGroupUsers 

func (s *Service) RemoveDSGroupUsers(organizationID string, dsGroupID string, dSGroupUsersRemoveRequest *admin.DSGroupUsersRemoveRequest) *RemoveDSGroupUsersOp

RemoveDSGroupUsers removes a list of users from a DSGroup.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/multiproductusermanagement/removedsgroupusers

SDK Method UserManagement::removeDSGroupUsers

func (*Service) UpdateEmailAddress 

func (s *Service) UpdateEmailAddress(organizationID string, request *admin.UpdateUsersEmailRequest) *UpdateEmailAddressOp

UpdateEmailAddress updates a user's email address.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/users/updateemailaddress

SDK Method UserManagement::updateEmailAddress

func (*Service) UpdateUser 

func (s *Service) UpdateUser(organizationID string, request *admin.UpdateUsersRequest) *UpdateUserOp

UpdateUser updates a user's information.

https://developers.docusign.com/docs/admin-api/reference/usermanagement/esignusermanagement/updateuser

SDK Method UserManagement::updateUser

type UpdateEmailAddressOp 

type UpdateEmailAddressOp esign.Op

UpdateEmailAddressOp implements DocuSign API SDK UserManagement::updateEmailAddress

func (*UpdateEmailAddressOp) Do 

func (op *UpdateEmailAddressOp) Do(ctx context.Context) (*admin.UsersUpdateResponse, error)

Do executes the op. A nil context will return error.

type UpdateUserOp 

type UpdateUserOp esign.Op

UpdateUserOp implements DocuSign API SDK UserManagement::updateUser

func (*UpdateUserOp) Do 

func (op *UpdateUserOp) Do(ctx context.Context) (*admin.UsersUpdateResponse, error)

Do executes the op. A nil context will return error.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.