Update onboarding rule

This method updates an existing automatic onboarding rule.

Updating a rule does not change the order in which the rules are applied. Rules will be applied according to creation time, most recently created rule first.

The values for CreationTime and LastOnboardedTime of the rule will not be changed in the database; existing field values will be preserved.

 

For all non-mandatory parameters, if a value is not provided, the default value will be used and will overwrite the current value in the database.

All parameter values are case insensitive, except for UserNameFilter which is case sensitive when SystemTypeFilter equals Unix.

The user who runs this web service must belong to the Vault Admins group.

The user whose credentials are used for the session must have ownership rights on the safe specified by the TargetSafeName parameter.

URL

 

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %

 

 

https://<IIS_Server_Ip>/PasswordVault/api/AutomaticOnboardingRules/{id}

The following mandatory value is required in the URL:

Parameter

id

Type

Number

Description

The unique ID of the rule to update

Resource information

HTTP method

PUT

Content type

application/json

Header parameter

Parameter

Authorization

Type

String

Description

The token that identifies the session, encoded in BASE 64.

Valid values

A session token that was returned from the “Logon” method, encoded in BASE 64.

Body parameters

 
{

"TargetPlatformId": "<platform ID>",

"TargetSafeName": "<Safe name>",

"IsAdminIDFilter": <False>,

"MachineTypeFilter": "<Server>",

"SystemTypeFilter": "<Windows>",

"UserNameFilter": "<filter>",

"UserNameMethod": "<Begins>",

"AddressFilter": "<filter>",

"AddressMethod": "<Equals>",

"AccountCategoryFilter": "<Any>",

"RuleName": "<rule name>",

"RuleDescription": "<description>"

}

 

Parameter

TargetPlatformId (mandatory)

Type

String

Description

The ID of the platform that the onboarded account will be associated with.

Valid values

Platform ID, up to 99 characters

Parameter

TargetSafeName (mandatory)

Type

String

Description

The name of the Safe where the onboarded account will be stored.

Valid values

Safe name, up to 28 characters

Parameter

IsAdminIDFilter

Type

Boolean

Description

Whether or not only accounts with the following admin ID will be onboarded automatically according to this rule.

  • Unix accounts whose UID is 0

  • Windows accounts whose SID ends with 500

If this value is set to false, the admin ID will not be considered, and all accounts matching the rule will be onboarded.

Valid values

True / False

Default

False

Parameter

MachineTypeFilter

Type

String

Description

The machine type by which to filter.

Valid values

Any/Workstation/Server

Default

Any

Parameter

SystemTypeFilter (mandatory)

Type

String

Description

The system type by which to filter.

Valid values

Windows/Unix

Parameter

UserNameFilter

Type

String

Description

The name of the user by which to filter.

Valid values

User name, up to 512 characters. (Case sensitive when SystemTypeFilter equals Unix.)

Parameter

UserNameMethod

Type

String

Description

The method to use when applying the username filter (Equals / Begins with / Ends with). This parameter is ignored if UserNameFilter is not specified.

Valid values

Equals/Begins/Ends

Default

Equals

Parameter

AddressFilter

Type

String

Description

The IP address or DNS domain name of the machine by which to filter.

Valid values

Address, up to 255 characters.

Parameter

AddressMethod

Type

String

Description

The method to use when applying the address filter (Equals / Begins with / Ends with). This parameter is ignored if AddressFilter is not specified.

Valid values

Equals/Begins/Ends

Default

Equals

Parameter

AccountCategoryFilter

Type

String

Description

Filter for privileged or non-privileged accounts.

Valid values

Any/Privileged/Non-privileged

Default

Any

Parameter

RuleName

Type

String

Description

Name of the rule.

If an empty string or no value is provided, then the rule name will be auto-generated, and will overwrite the current value in the database.

Valid values

A unique name of 255 characters

Default

Auto-generated name

Parameter

RuleDescription

Type

String

Description

A description of the rule.

Valid values

Free text, up to 255 characters

Return codes

For a complete list of return codes, see Return Codes.