Add OPM account commands

This method adds a new privileged command rule to the account.

URL

  • Make sure there are no spaces in the URL.

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

  • If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

 

 
https://<IIS_Server_Ip>/PasswordVault/WebServices/PIMServices.svc/Account/{AccountAddress}|{AccountUserName}|{AccountPolicyId}/PrivilegedCommands/

The following mandatory values are required in the URL:

Parameter

AccountAddress

Type

String

Description

The address of the account to which a new privileged command will be added.

Parameter

AccountUserName

Type

String

Description

The name of the account’s user.

Parameter

AccountPolicyId

Type

String

Description

The Policy ID associated with this account.

Resource information

HTTP method

PUT

Content type

application/json

Header parameter

Parameter

Authorization

Type

String

Description

The token that identifies the session.

Valid values

A session token that was returned from the “Logon” method.

Body parameters

 
{

"Command":"<Command>",

"CommandGroup":<true/false>,

"PermissionType":"<Allow/Deny>",

"Restrictions":"<Restrictions>",

"UserName":"<UserName>"

}

 

Parameter

AccountPolicyId

Type

text

Description

The Policy Id of the account, provided in the URL.

Valid values

-

Parameter

AccountAddress

Type

text

Description

The Address of the account, provided in the URL.

Valid values

Not empty

Parameter

AccountUserName

Type

text

Description

The User Name of the account, provided in the URL.

Valid values

Not empty

Parameter

Command

Type

text

Description

The command to run.

Valid values

Not empty

Parameter

CommandGroup

Type

bool

Description

Whether or not this is a command group.

Valid values

True/False

Parameter

PermissionType

Type

text

Description

Allow or Deny command.

Valid values

Allow/Deny

Parameter

Restrictions

Type

text

Description

A restrictions string.

Valid values

<restrictionName>=<Value>;<… or empty

Parameter

UserName

Type

text

Description

The user this rule applies to.

Valid values

User name, or "*" for all users

Result

 
{

"AddAccountPrivilegedCommandResult":

{

"Command":"<command>",

"CommandGroup":"<true/false>",

"Id":"<number>",

"IsGroup":"<true/false>",

"Type":"<Policy/Account>",

"PermissionType":"<Allow/Deny>",

"PolicyId":"<policyID>",

"Restrictions":"<restrictions string, delimeted by ;>",

"UserName":"<userName>"}

}

Return codes

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