Documentation
¶
Overview ¶
Package authentication implements the DocuSign SDK category Authentication.
Use the Authentication category to manage various account login tasks including:
* Getting login information for a user. * Managing linked social accounts. * Getting and revoking OAuth tokens.
Service Api documentation may be found at: https://developers.docusign.com/esign-rest-api/v2/reference/Authentication Usage example:
import (
"github.com/jfcote87/esign"
"github.com/jfcote87/esign/v2/authentication"
"github.com/jfcote87/esign/v2/model"
)
...
authenticationService := authentication.New(esignCredential)
Index ¶
- type LoginOp
- type Service
- func (s *Service) Login() *LoginOp
- func (s *Service) UpdatePassword(loginPart string, userPasswordInformation *model.UserPasswordInformation) *UpdatePasswordOp
- func (s *Service) UserSocialAccountLoginsDelete(userID string, userSocialAccountLogins *model.SocialAccountInformation) *UserSocialAccountLoginsDeleteOp
- func (s *Service) UserSocialAccountLoginsList(userID string) *UserSocialAccountLoginsListOp
- func (s *Service) UserSocialAccountLoginsUpdate(userID string, userSocialAccountLogins *model.SocialAccountInformation) *UserSocialAccountLoginsUpdateOp
- type UpdatePasswordOp
- type UserSocialAccountLoginsDeleteOp
- type UserSocialAccountLoginsListOp
- type UserSocialAccountLoginsUpdateOp
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LoginOp ¶
LoginOp implements DocuSign API SDK Authentication::login
func (*LoginOp) APIPassword ¶
APIPassword reserved for DocuSign.
func (*LoginOp) EmbedAccountIDGUID ¶
EmbedAccountIDGUID set the call query parameter embed_account_id_guid
func (*LoginOp) IncludeAccountIDGUID ¶
IncludeAccountIDGUID when set to **true**, shows the account ID GUID in the response.
func (*LoginOp) LoginSettings ¶
LoginSettings determines whether login settings are returned in the response.
Valid Values:
* all - All the login settings are returned. * none - no login settings are returned.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service implements DocuSign Authentication Category API operations
func New ¶
func New(cred esign.Credential) *Service
New initializes a authentication service using cred to authorize ops.
func (*Service) Login ¶
Login gets login information for a specified user.
https://developers.docusign.com/esign-rest-api/v2/reference/authentication/authentication/login
SDK Method Authentication::login
func (*Service) UpdatePassword ¶
func (s *Service) UpdatePassword(loginPart string, userPasswordInformation *model.UserPasswordInformation) *UpdatePasswordOp
UpdatePassword updates the password for a specified user.
SDK Method Authentication::updatePassword
func (*Service) UserSocialAccountLoginsDelete ¶
func (s *Service) UserSocialAccountLoginsDelete(userID string, userSocialAccountLogins *model.SocialAccountInformation) *UserSocialAccountLoginsDeleteOp
UserSocialAccountLoginsDelete deletes user's social account.
SDK Method Authentication::deleteSocialLogin
func (*Service) UserSocialAccountLoginsList ¶
func (s *Service) UserSocialAccountLoginsList(userID string) *UserSocialAccountLoginsListOp
UserSocialAccountLoginsList gets a list of a user's social accounts.
SDK Method Authentication::listSocialLogins
func (*Service) UserSocialAccountLoginsUpdate ¶
func (s *Service) UserSocialAccountLoginsUpdate(userID string, userSocialAccountLogins *model.SocialAccountInformation) *UserSocialAccountLoginsUpdateOp
UserSocialAccountLoginsUpdate adds social account for a user.
SDK Method Authentication::updateSocialLogin
type UpdatePasswordOp ¶
UpdatePasswordOp implements DocuSign API SDK Authentication::updatePassword
type UserSocialAccountLoginsDeleteOp ¶
UserSocialAccountLoginsDeleteOp implements DocuSign API SDK Authentication::deleteSocialLogin
type UserSocialAccountLoginsListOp ¶
UserSocialAccountLoginsListOp implements DocuSign API SDK Authentication::listSocialLogins
func (*UserSocialAccountLoginsListOp) Do ¶
func (op *UserSocialAccountLoginsListOp) Do(ctx context.Context) (*model.UserSocialIDResult, error)
Do executes the op. A nil context will return error.
type UserSocialAccountLoginsUpdateOp ¶
UserSocialAccountLoginsUpdateOp implements DocuSign API SDK Authentication::updateSocialLogin
Source Files