responses

Documentation

Index

• type AddUser
• type AuthenticationMethods
• type BusinessAddress
• type CredentialsManagement
• type General
• type GetAccount
• type GetPlatform
• type Internet
• type LinkedAccounts
• type ListAccount
• type ListApplication
• type ListApplicationAuthenticationMethods
• type ListApplications
• type ListAuthentication
• type ListPlatform
• type ListPlatforms
• type ListSafe
• type ListSafeMembers
• type ListSafes
• type ListUsers
• type Members
• type OptionalProperties
• type Permissions
• type PersonalDetails
• type PersonalDetailsResponse
• type Phones
• type PrivilegedAccessWorkflows
• type Properties
• type RequiredProperties
• type ServerVerify
• type SessionManagement
• type UpdateSafe
• type UserResponse

Types

type AddUser

type AddUser struct {
	EnableUser              bool            `json:"enableUser"`
	ChangePassOnNextLogon   bool            `json:"changePassOnNextLogon"`
	ExpiryDate              int             `json:"expiryDate"`
	Suspended               bool            `json:"suspended"`
	LastSuccessfulLoginDate int             `json:"lastSuccessfulLoginDate"`
	UnAuthorizedInterfaces  []string        `json:"unAuthorizedInterfaces"`
	AuthenticationMethod    []string        `json:"authenticationMethod"`
	PasswordNeverExpires    bool            `json:"passwordNeverExpires"`
	DistinguishedName       string          `json:"distinguishedName"`
	Description             string          `json:"description"`
	BusinessAddress         BusinessAddress `json:"businessAddress,omitempty"`
	Internet                Internet        `json:"internet,omitempty"`
	Phones                  Phones          `json:"phones,omitempty"`
	PersonalDetails         PersonalDetails `json:"personalDetails,omitempty"`
	ID                      int             `json:"id"`
	Username                string          `json:"username"`
	Source                  string          `json:"source"`
	UserType                string          `json:"userType"`
	ComponentUser           bool            `json:"componentUser"`
	VaultAuthorization      []string        `json:"vaultAuthorization"`
	Location                string          `json:"location"`
}

AddUser response

type AuthenticationMethods

type AuthenticationMethods struct {
	Enabled bool   `json:"Enabled"`
	ID      string `json:"Id"`
}

AuthenticationMethods feeds into ServerVerify

type BusinessAddress

type BusinessAddress struct {
	WorkStreet  string `json:"workStreet"`
	WorkCity    string `json:"workCity"`
	WorkState   string `json:"workState"`
	WorkZip     string `json:"workZip"`
	WorkCountry string `json:"workCountry"`
}

BusinessAddress of user

type CredentialsManagement

type CredentialsManagement struct {
	AllowedSafes                          string `json:"allowedSafes"`
	AllowManualChange                     bool   `json:"allowManualChange"`
	PerformPeriodicChange                 bool   `json:"performPeriodicChange"`
	RequirePasswordChangeEveryXDays       int    `json:"requirePasswordChangeEveryXDays"`
	AllowManualVerification               bool   `json:"allowManualVerification"`
	PerformPeriodicVerification           bool   `json:"performPeriodicVerification"`
	RequirePasswordVerificationEveryXDays int    `json:"requirePasswordVerificationEveryXDays"`
	AllowManualReconciliation             bool   `json:"allowManualReconciliation"`
	AutomaticReconcileWhenUnsynched       bool   `json:"automaticReconcileWhenUnsynched"`
}

CredentialsManagement contains the credentials management of a platform

type General

type General struct {
	ID             string `json:"id"`
	Name           string `json:"name"`
	SystemType     string `json:"systemType"`
	Active         bool   `json:"active"`
	Description    string `json:"description,omitempty"`
	PlatformBaseID string `json:"platformBaseId"`
	PlatformType   string `json:"platformType"`
}

General contains the general details of a platform

type GetAccount

type GetAccount struct {
	CategoryModificationTime  int                     `json:"categoryModificationTime"`
	ID                        string                  `json:"id"`
	Name                      string                  `json:"name"`
	Address                   string                  `json:"address"`
	UserName                  string                  `json:"userName"`
	PlatformID                string                  `json:"platformId"`
	SafeName                  string                  `json:"safeName"`
	SecretType                string                  `json:"secretType"`
	PlatformAccountProperties map[string]string       `json:"platformAccountProperties"`
	SecretManagement          shared.SecretManagement `json:"secretManagement"`
	CreatedTime               int                     `json:"createdTime"`
}

GetAccount response from getting specific account details

type GetPlatform

type GetPlatform struct {
	PlatformID string            `json:"PlatformID"`
	Details    map[string]string `json:"Details"`
	Active     bool              `json:"Active"`
}

GetPlatform response from getting specific account details

type Internet

type Internet struct {
	HomePage      string `json:"homePage"`
	HomeEmail     string `json:"homeEmail"`
	BusinessEmail string `json:"businessEmail"`
	OtherEmail    string `json:"otherEmail"`
}

Internet of user

type LinkedAccounts

type LinkedAccounts struct {
	Name        string `json:"name"`
	DisplayName string `json:"displayName,omitempty"`
}

LinkedAccounts contains the linked accounts of a platform

type ListAccount

type ListAccount struct {
	Value []GetAccount `json:"value"`
	Count int          `json:"count"`
}

ListAccount response from listing accounts

type ListApplication

type ListApplication struct {
	AccessPermittedFrom                     int       `json:"AccessPermittedFrom"`
	AccessPermittedTo                       int       `json:"AccessPermittedTo"`
	AllowExtendedAuthenticationRestrictions bool      `json:"AllowExtendedAuthenticationRestrict"`
	AppID                                   string    `json:"AppID"`
	BusinessOwnerEmail                      string    `json:"BusinessOwnerEmail"`
	BusinessOwnerFName                      string    `json:"BusinessOwnerFName"`
	BusinessOwnerLName                      string    `json:"BusinessOwnerLName"`
	BusinessOwnerPhone                      string    `json:"BusinessOwnerPhone"`
	Description                             string    `json:"Description"`
	Disabled                                bool      `json:"Disabled"`
	ExpirationDate                          time.Time `json:"ExpirationDate"`
	Location                                string    `json:"Location"`
}

ListApplication contains all specific application data for ListApplicationsResponse

type ListApplicationAuthenticationMethods

type ListApplicationAuthenticationMethods struct {
	Authentication []ListAuthentication `json:"authentication"`
}

ListApplicationAuthenticationMethods contains all auth methods for a specific App ID

type ListApplications

type ListApplications struct {
	Application []ListApplication `json:"application"`
}

ListApplications contains all applications and app data returned

type ListAuthentication

type ListAuthentication struct {
	AllowInternalScripts bool   `json:"AllowInternalScripts,omitempty"`
	AppID                string `json:"AppID"`
	AuthType             string `json:"AuthType"`
	AuthValue            string `json:"AuthValue"`
	Comment              string `json:"Comment,omitempty"`
	IsFolder             bool   `json:"IsFolder,omitempty"`
	AuthID               string `json:"authID"`
}

ListAuthentication contains details of the authentication method listed

type ListPlatform

type ListPlatform struct {
	General                   General                   `json:"general"`
	Properties                Properties                `json:"properties"`
	LinkedAccounts            []LinkedAccounts          `json:"linkedAccounts,omitempty"`
	CredentialsManagement     []CredentialsManagement   `json:"creditentialsManagement"`
	SessionManagement         SessionManagement         `json:"sessionManagement"`
	PrivilegedAccessWorkflows PrivilegedAccessWorkflows `json:"privilegedAccessWorkflows"`
}

ListPlatform contains the platform details of every platform for ListPlatformsResponse struct

type ListPlatforms

type ListPlatforms struct {
	Platforms []ListPlatform `json:"Platforms"`
}

ListPlatforms contains an array of all platforms

type ListSafe

type ListSafe struct {
	SafeURLId   string `json:"SafeUrlId"`
	SafeName    string `json:"SafeName"`
	Description string `json:"Description,omitempty"`
	Location    string `json:"Location"`
}

ListSafe contains the safe details of every safe the current user can read for ListSafesResponse struct

type ListSafeMembers

type ListSafeMembers struct {
	Members []Members `json:"value"`
	Count   int       `json:"count"`
}

ListSafeMembers contains data of all members of a specific safe

type ListSafes

type ListSafes struct {
	Safes []ListSafe `json:"value"`
}

ListSafes contains an array of all safes the current user can read

type ListUsers

type ListUsers struct {
	Users []UserResponse `json:"Users"`
	Total int            `json:"Total"`
}

ListUsers response when listing users

type Members

type Members struct {
	SafeName                  string      `json:"safeName"`
	SafeNumber                int         `json:"safeNumber"`
	MemberID                  interface{} `json:"memberId"`
	MemberName                string      `json:"memberName"`
	MemberType                string      `json:"memberType"`
	IsExpiredMembershipEnable bool        `json:"isExpiredMembershipEnable"`
	IsPredefinedUser          bool        `json:"isPredefinedUser"`
	Permissions               Permissions `json:"Permissions"`
}

Members contains all safe member username/group name and their permissions

type OptionalProperties

type OptionalProperties struct {
	Name        string `json:"name"`
	DisplayName string `json:"displayName,omitempty"`
}

OptionalProperties contains the optional properties of a platform

type Permissions

type Permissions struct {
	UseAccounts                            bool `json:"UseAccounts"`
	RetrieveAccounts                       bool `json:"RetrieveAccounts"`
	ListAccounts                           bool `json:"ListAccounts"`
	AddAccounts                            bool `json:"AddAccounts"`
	UpdateAccountContent                   bool `json:"UpdateAccountContent"`
	UpdateAccountProperties                bool `json:"UpdateAccountProperties"`
	InitiateCPMAccountManagementOperations bool `json:"InitiateCPMAccountManagementOperations"`
	SpecifyNextAccountContent              bool `json:"SpecifyNextAccountContent"`
	RenameAccounts                         bool `json:"RenameAccounts"`
	DeleteAccounts                         bool `json:"DeleteAccounts"`
	UnlockAccounts                         bool `json:"UnlockAccounts"`
	ManageSafe                             bool `json:"ManageSafe"`
	ManageSafeMembers                      bool `json:"ManageSafeMembers"`
	BackupSafe                             bool `json:"BackupSafe"`
	ViewAuditLog                           bool `json:"ViewAuditLog"`
	ViewSafeMembers                        bool `json:"ViewSafeMembers"`
	AccessWithoutConfirmation              bool `json:"AccessWithoutConfirmation"`
	CreateFolders                          bool `json:"CreateFolders"`
	DeleteFolders                          bool `json:"DeleteFolders"`
	MoveAccountsAndFolders                 bool `json:"MoveAccountsAndFolders"`
	RequestsAuthorizationLevel1            bool `json:"RequestsAuthorizationLevel1"`
	RequestsAuthorizationLevel2            bool `json:"RequestsAuthorizationLevel2"`
}

Permissions contains the permissions of each safe member

type PersonalDetails

type PersonalDetails struct {
	Street       string `json:"street"`
	City         string `json:"city"`
	State        string `json:"state"`
	Zip          string `json:"zip"`
	Country      string `json:"country"`
	Title        string `json:"title"`
	Organization string `json:"organization"`
	Department   string `json:"department"`
	Profession   string `json:"profession"`
	FirstName    string `json:"firstName"`
	MiddleName   string `json:"middleName"`
	LastName     string `json:"lastName"`
}

PersonalDetails of user

type PersonalDetailsResponse

type PersonalDetailsResponse struct {
	FirstName  string `json:"firstName"`
	MiddleName string `json:"middleName"`
	LastName   string `json:"lastName"`
}

PersonalDetailsResponse represents one users personal details

type Phones

type Phones struct {
	HomeNumber     string `json:"homeNumber"`
	BusinessNumber string `json:"businessNumber"`
	CellularNumber string `json:"cellularNumber"`
	FaxNumber      string `json:"faxNumber"`
	PagerNumber    string `json:"pagerNumber"`
}

Phones of user

type PrivilegedAccessWorkflows

type PrivilegedAccessWorkflows struct {
	RequireDualControlPasswordAccessApproval bool `json:"requireDualControlPasswordAccessApproval"`
	EnforceCheckinCheckoutExclusiveAccess    bool `json:"enforceCheckinCheckoutExclusiveAccess"`
	EnforceOnetimePasswordAccess             bool `json:"enforceOnetimePasswordAccess"`
}

PrivilegedAccessWorkflows contains the privileged access workflows of a platform

type Properties

type Properties struct {
	Required []RequiredProperties `json:"required,omitempty"`
	Optional []OptionalProperties `json:"optional,omitempty"`
}

Properties contains the properties of a platform

type RequiredProperties

type RequiredProperties struct {
	Name        string `json:"name"`
	DisplayName string `json:"displayName,omitempty"`
}

RequiredProperties contains the required properties of a platform

type ServerVerify

type ServerVerify struct {
	ApplicationName       string                  `json:"ApplicationName"`
	AuthenticationMethods []AuthenticationMethods `json:"AuthenticationMethods"`
	ServerID              string                  `json:"ServerId"`
	ServerName            string                  `json:"ServerName"`
}

ServerVerify contains all response data from /verify endpoint

type SessionManagement

type SessionManagement struct {
	RequirePrivilegedSessionMonitoringAndIsolation bool   `json:"requirePrivilegedSessionMonitoringAndIsolation"`
	RecordAndSaveSessionActivity                   bool   `json:"recordAndSaveSessionActivity"`
	PSMServerID                                    string `json:"psmServerId,omitempty"`
}

SessionManagement contains the session management of a platform

type UpdateSafe

type UpdateSafe struct {
	SafeName                  string `json:"SafeName"`
	Description               string `json:"Description"`
	NumberOfDaysRetention     int    `json:"NumberOfDaysRetention"`
	NumberOfVersionsRetention int    `json:"NumberOfVersionsRetention"`
	OLACEnabled               bool   `json:"OLACEnabled"`
}

UpdateSafe contains the response to the Update Safe function's request

type UserResponse

type UserResponse struct {
	ID                 int                     `json:"id"`
	Username           string                  `json:"username"`
	Source             string                  `json:"source"`
	UserType           string                  `json:"userType"`
	ComponentUser      bool                    `json:"componentUser"`
	VaultAuthorization []string                `json:"vaultAuthorization"`
	Location           string                  `json:"location"`
	PersonalDetails    PersonalDetailsResponse `json:"personalDetails"`
}

UserResponse represents one user in ListUsersResponse