Update properties on a Vendor Group resource.

patch

https://techcomcloudpra.qabeyondtrustcloud.com/api/config/v1/vendor/{id}

Modifies an existing vendor group with the given {id} using the given properties.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

1 to 2147483647

Unique identifier for the resource.

Body Params

The Vendor Group properties to modify.

name

string

required

length between 1 and 255

The name of the vendor group.

default_policy

int32

required

1 to 2147483647

The group policy id associated with the vendor group. The group policy cannot grant administrative privileges.

account_expiration

int32

1 to 365

Defaults to 30

The number of days until a new user account expires in the vendor group.

deletion_days_after_expiration

int32 | null

1 to 365

Defaults to null

After an account expires, the system will automatically delete the account after this many days. Omit this field or set it to null if you do not want expired accounts to be automatically deleted.

user_added_notification_enabled

boolean

Defaults to true

If enabled, the %ABR_BeyondTrust Privileged Remote Access% users and/or team members are emailed when a user is added to the vendor group. This value cannot be false if user_approval_enabled is true. At least one administrator or team must be set in administrator_ids or team_ids respectively if this value is true.

user_expired_notification_enabled

boolean

Defaults to true

If enabled, the %ABR_BeyondTrust Privileged Remote Access% users and/or team members are emailed when a user has expired or has been automatically deleted in this vendor group. At least one administrator or team must be set in administrator_ids or team_ids respectively if this value is true.

user_approval_enabled

boolean

Defaults to false

If enabled, approval by a %ABR_BeyondTrust Privileged Remote Access% users and/or team members are required to activate users in the vendor group. At least one administrator or team must be set in administrator_ids or team_ids respectively if this value is true.

user_reactivation_enabled

boolean

Defaults to false

If enabled, approval by a %ABR_BeyondTrust Privileged Remote Access% users and/or team members are required to extend or reactivate users in the vendor group. user_approval_enabled must first be enabled.

administrator_ids

array of objects

length between 0 and 10

Defaults to []

List of ids of the %ABR_BeyondTrust Privileged Remote Access% users who are emailed if notifications are enabled or user approvals are required. To receive emails, each user must have a valid email address, and the site must have an SMTP server configured on the Management > Email Configuration page. The sum of administrator_ids and team_ids is not allowed to exceed 10.

administrator_ids

team_ids

array of objects

length between 0 and 10

Defaults to []

List of ids of the %ABR_BeyondTrust Privileged Remote Access% teams whose members are emailed if notifications are enabled or user approvals are required. To receive emails, each team member must have a valid email address, and the site must have an SMTP server configured on the Management > Email Configuration page. The sum of administrator_ids and team_ids is not allowed to exceed 10.

team_ids

network_restrictions

array of strings

length between 0 and 128

Defaults to []

The network address allow list related to network restrictions.

network_restrictions

duration

integer

1 to 168

Defaults to 24

The duration in hours after which the %ABR_BeyondTrust Privileged Remote Access% users and/or team members are emailed if there are users awaiting action.

duration_enabled

boolean

Defaults to false

If enabled, the %ABR_BeyondTrust Privileged Remote Access% users and/or team members are emailed depending on the duration if there are users awaiting action.

Responses

200Indicates the existing vendor group was successfully updated and returns the new vendor group.

404The specified resource was not found.

422One or more request parameters are invalid. The body contains a general error message as well as a validation error dictionary.