requests

Documentation

Index

• type AddAccount
• type AddApplication
• type AddApplicationAuthentication
• type AddSafe
• type AddSafeMember
• type AddUser
• type Application
• type ApplicationAuthenticationMethod
• type ChangeAccountCredential
• type GetAccountPassword
• type Logon
• type UpdateSafe

Types

type AddAccount

type AddAccount struct {
	Name                      string                  `json:"name,omitempty"`
	Address                   string                  `json:"address"`
	UserName                  string                  `json:"userName"`
	PlatformID                string                  `json:"platformId"`
	SafeName                  string                  `json:"safeName"`
	SecretType                string                  `json:"secretType"`
	Secret                    string                  `json:"secret"`
	PlatformAccountProperties map[string]string       `json:"platformAccountProperties,omitempty"`
	SecretManagement          shared.SecretManagement `json:"secretManagement,omitempty"`
}

AddAccount request used to create an account

type AddApplication

type AddApplication struct {
	Application Application `json:"application"`
}

AddApplication request for adding application

type AddApplicationAuthentication

type AddApplicationAuthentication struct {
	Authentication ApplicationAuthenticationMethod `json:"authentication"`
}

AddApplicationAuthentication request to add authentication method to application

type AddSafe

type AddSafe struct {
	SafeName              string `json:"SafeName"`
	Description           string `json:"Description"`
	OLACEnabled           bool   `json:"OLACEnabled,omitempty"`
	ManagingCPM           string `json:"ManagingCPM"`
	NumberOfDaysRetention int    `json:"NumberOfDaysRetention"`
	AutoPurgeEnabled      bool   `json:"AutoPurgeEnabled,omitempty"`
	SafeLocation          string `json:"Location,omitempty"`
}

AddSafe contains the body of the Add Safe function's request

type AddSafeMember

type AddSafeMember struct {
	MemberName               string            `json:"MemberName"`
	SearchIn                 string            `json:"SearchIn"`
	MembershipExpirationDate string            `json:"MembershipExpirationDate,omitempty"`
	Permissions              map[string]string `json:"Permissions,omitempty"`
	MemberType               string            `json:"MemberType"`
}

AddSafeMember used in AddSafeMemberRequest

type AddUser

type AddUser struct {
	Username               string            `json:"username"`
	UserType               string            `json:"userType"`
	InitialPassword        string            `json:"initialPassword"`
	AuthenticationMethod   []string          `json:"authenticationMethod"`
	Location               string            `json:"location"`
	UnAuthorizedInterfaces []string          `json:"unAuthorizedInterfaces"`
	ExpiryDate             int               `json:"expiryDate,omitempty"`
	VaultAuthorization     []string          `json:"vaultAuthorization"`
	EnableUser             bool              `json:"enableUser,omitempty"`
	ChangePassOnNextLogon  bool              `json:"changePassOnNextLogon,omitempty"`
	PasswordNeverExpires   bool              `json:"passwordNeverExpires"`
	DistinguishedName      string            `json:"distinguishedName"`
	Description            string            `json:"description"`
	BusinessAddress        map[string]string `json:"businessAddress,omitempty"`
	Internet               map[string]string `json:"internet,omitempty"`
	Phones                 map[string]string `json:"phones,omitempty"`
	PersonalDetails        map[string]string `json:"personalDetails,omitempty"`
}

AddUser request that represents PAS User

type Application

type Application struct {
	AppID               string `json:"AppID"`
	Description         string `json:"Description,omitempty"`
	Location            string `json:"Location,omitempty"`
	AccessPermittedFrom int    `json:"AccessPermittedFrom"`
	AccessPermittedTo   int    `json:"AccessPermittedTo"`
	ExpirationDate      string `json:"ExpirationDate,omitempty"`
	Disabled            string `json:"Disabled,omitempty"`
	BusinessOwnerFName  string `json:"BusinessOwnerFName,omitempty"`
	BusinessOwnerLName  string `json:"BusinessOwnerLName,omitempty"`
	BusinessOwnerEmail  string `json:"BusinessOwnerEmail,omitempty"`
	BusinessOwnerPhone  string `json:"BusinessOwnerPhone,omitempty"`
}

Application is used when adding an application

type ApplicationAuthenticationMethod

type ApplicationAuthenticationMethod struct {
	AuthType             string `json:"AuthType"`
	AuthValue            string `json:"AuthValue"`
	IsFolder             bool   `json:"IsFolder,omitempty"`
	AllowInternalScripts bool   `json:"AllowInternalScripts,omitempty"`
}

ApplicationAuthenticationMethod represents an application authentication method

type ChangeAccountCredential

type ChangeAccountCredential struct {
	ChangeEntireGroup bool   `json:"ChangeEntireGroup,omitempty"`
	NewCredentials    string `json:"NewCredentials,omitempty"`
}

ChangeAccountCredential only used when account is part of a group

type GetAccountPassword

type GetAccountPassword struct {
	Reason              string `json:"reason,omitempty"`
	TicketingSystemName string `json:"TicketingSystemName,omitempty"`
	TicketID            string `json:"TicketId,omitempty"`
	Version             int    `json:"Version,omitempty"`
	ActionType          string `json:"ActionType,omitempty"`
	IsUse               bool   `json:"isUse,omitempty"`
	Machine             string `json:"Machine,omitempty"`
}

GetAccountPassword get an accounts password from PAS. All fields are optional expect if ticketing system is integrated

type Logon

type Logon struct {
	Username          string `json:"username"`
	Password          string `json:"password"`
	ConcurrentSession bool   `json:"concurrentSession,omitempty"`
}

Logon contains the body of the Logon function's request

type UpdateSafe

type UpdateSafe struct {
	SafeName    string `json:"SafeName,omitempty"`
	Description string `json:"Description,omitempty"`
	OLACEnabled bool   `json:"OLACEnabled,omitempty"`
	ManagingCPM string `json:"ManagingCPM,omitempty"`
}

UpdateSafe contains the body of the Update Safe function's request