authentication

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/ofio/esign"
    "github.com/ofio/esign/v2/authentication"
    "github.com/ofio/esign/v2/model"
)
...
authenticationService := authentication.New(esignCredential)

Index

• type LoginOp
  • func (op *LoginOp) APIPassword(val string) *LoginOp
  • func (op *LoginOp) Do(ctx context.Context) (*model.LoginInformation, error)
  • func (op *LoginOp) EmbedAccountIDGUID(val string) *LoginOp
  • func (op *LoginOp) IncludeAccountIDGUID() *LoginOp
  • func (op *LoginOp) LoginSettings(val string) *LoginOp
• type Service
  • func New(cred esign.Credential) *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
  • func (op *UpdatePasswordOp) Do(ctx context.Context) error
• type UserSocialAccountLoginsDeleteOp
  • func (op *UserSocialAccountLoginsDeleteOp) Do(ctx context.Context) error
• type UserSocialAccountLoginsListOp
  • func (op *UserSocialAccountLoginsListOp) Do(ctx context.Context) (*model.UserSocialIDResult, error)
• type UserSocialAccountLoginsUpdateOp
  • func (op *UserSocialAccountLoginsUpdateOp) Do(ctx context.Context) error

Types

type LoginOp

type LoginOp esign.Op

LoginOp implements DocuSign API SDK Authentication::login

func (*LoginOp) APIPassword

func (op *LoginOp) APIPassword(val string) *LoginOp

APIPassword reserved for DocuSign.

func (*LoginOp) Do

func (op *LoginOp) Do(ctx context.Context) (*model.LoginInformation, error)

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

func (*LoginOp) EmbedAccountIDGUID

func (op *LoginOp) EmbedAccountIDGUID(val string) *LoginOp

EmbedAccountIDGUID set the call query parameter embed_account_id_guid

func (*LoginOp) IncludeAccountIDGUID

func (op *LoginOp) IncludeAccountIDGUID() *LoginOp

IncludeAccountIDGUID when set to **true**, shows the account ID GUID in the response.

func (*LoginOp) LoginSettings

func (op *LoginOp) LoginSettings(val string) *LoginOp

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

func (s *Service) Login() *LoginOp

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.

https://developers.docusign.com/esign-rest-api/v2/reference/authentication/authentication/updatepassword

SDK Method Authentication::updatePassword

func (*Service) UserSocialAccountLoginsDelete

func (s *Service) UserSocialAccountLoginsDelete(userID string, userSocialAccountLogins *model.SocialAccountInformation) *UserSocialAccountLoginsDeleteOp

UserSocialAccountLoginsDelete deletes user's social account.

https://developers.docusign.com/esign-rest-api/v2/reference/authentication/usersocialaccountlogins/delete

SDK Method Authentication::deleteSocialLogin

func (*Service) UserSocialAccountLoginsList

func (s *Service) UserSocialAccountLoginsList(userID string) *UserSocialAccountLoginsListOp

UserSocialAccountLoginsList gets a list of a user's social accounts.

https://developers.docusign.com/esign-rest-api/v2/reference/authentication/usersocialaccountlogins/list

SDK Method Authentication::listSocialLogins

func (*Service) UserSocialAccountLoginsUpdate

func (s *Service) UserSocialAccountLoginsUpdate(userID string, userSocialAccountLogins *model.SocialAccountInformation) *UserSocialAccountLoginsUpdateOp

UserSocialAccountLoginsUpdate adds social account for a user.

https://developers.docusign.com/esign-rest-api/v2/reference/authentication/usersocialaccountlogins/update

SDK Method Authentication::updateSocialLogin

type UpdatePasswordOp

type UpdatePasswordOp esign.Op

UpdatePasswordOp implements DocuSign API SDK Authentication::updatePassword

func (*UpdatePasswordOp) Do

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

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

type UserSocialAccountLoginsDeleteOp

type UserSocialAccountLoginsDeleteOp esign.Op

UserSocialAccountLoginsDeleteOp implements DocuSign API SDK Authentication::deleteSocialLogin

func (*UserSocialAccountLoginsDeleteOp) Do

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

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

type UserSocialAccountLoginsListOp

type UserSocialAccountLoginsListOp esign.Op

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

type UserSocialAccountLoginsUpdateOp esign.Op

UserSocialAccountLoginsUpdateOp implements DocuSign API SDK Authentication::updateSocialLogin

func (*UserSocialAccountLoginsUpdateOp) Do

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

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