Create a request

This method creates an access request for a specific account. This account may be either a password account or an SSH Key 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/API/MyRequests

Resource information

HTTP method	POST
Content type	application/json

Header parameter

Parameter	Description
Authorization	The token that identifies the session, encoded in BASE 64. See Authentication. Type: String Mandatory: Yes Default value: None

Body parameters

{
:"accountId": "<Account id>",
"reason":"<Reason>",
"TicketingSystemName": "<Ticketing system>",
"TicketId": "<Ticketid>",
"ConnectionComponent":"<Connection compmonent id>",
"MultipleAccessRequired":<true\false>,
"FromDate":<0-max integer>,
"ToDate":<0-max integer>,
"AdditionalInfo":
{
"<Additional Info name>":"<Addition Info value>",
"<Additional Info name>":"<Addition Info value>"
},
"UseConnect":<true\false>,
"ConnectionParams":
{
"<Connection parameter name>":
{
"value":"<Connection parameter value>",
"ShouldSave<true\false>"
},
<Connection parameter name>:
{
"value":"<Connection parameter value>",
"ShouldSave<true\false>"
}
}
}

Parameter	AccountId (mandatory)
Type	String
Description	The ID of the account to access.
Parameter	Reason
Type	String
Description	The reason why the account needs to be accessed.
Parameter	TicketingSystemName
Type	String
Description	The name of the Ticketing System specified in the request.
Parameter	TicketID
Type	String
Description	The ticket ID given by the ticketing system.
Parameter	MultipleAccess
Type	Boolean
Description	Whether or not the request is for multiple access.
Parameter	FromDate
Type	Integer
Description	If the request is for a timeframe, the time from when the user wants to access the account, in Unix time.
Parameter	ToDate
Type	Integer
Description	If the request is for a timeframe, the time until when the user wants to access the account, in Unix time.
Parameter	AdditionalInfo
Type	List (key:value)
Description	Additional information included in the request. A list of values that are predefined in configuration.
Parameter	UseConnect
Type	Boolean
Description	Whether or not the request is for connection through the PSM.
Parameter	ConnectionComponent
Type	String
Description	If the connection is through PSM, the name of the connection component to connect with, as defined in the configuration.
Parameter	ConnectionParams
Type	List
Description	A list of parameters required to perform the connection, as defined in each connection component configuration. These parameters are listed in the table below.

Connection Parameters

Parameter	value
Type	String
Description	The content of the parameter
Valid values	Text
Default	-
Parameter	ShouldSave
Type	Boolean
Description	Whether or not this value will be saved with the account for future attempts to connect to the remote machine.
Valid values	true/false
Default	false

Result

{
"RequestID":"<ID>",
"SafeName":"<Safe>",
"RequestorUserName":"<username>",
"RequestorReason":"(Ticket ID=<ticketid>)(Ticketing System=<ticketing system>) (Emergency=<true/false>)(RefNo=<number>)(PSMRemoteMachine=<machine>) <reason>",
"UserReason":"<reason>",
"CreationDate":<time/date>,
"Operation": "<operation>",
"ExpirationDate":<time/date>,
"OperationType":<operation>,
"AccessType":"<type>",
"ConfirmationsLeft":<number>,
"AccessFrom":<time/date>,
"AccessTo":<time/date>,
"Status":<status>,
"StatusTitle":"<title>",
"InvalidRequestReason":<number>,
"CurrentConfirmationLevel":<number>,
"RequiredConfirmersCountLevel2":<number>,
"TicketingSystemProperties":{
"Name":"name",
"Number":"<number>",
"Status":"<number>"
},|
"AdditionalInfo":{},
"AccountDetails":{
"AccountID":"<id>",
"Properties":{
"Address":"<address>",
"Safe":"<safe>",
"Folder":"<folder>",
"Name":"<accountname>",
"PolicyID":"<policy>",
"PlatformName":"<platform>",
"DeviceType":"<device>",
"LastVerifiedDate":"<date/time>",
"LastModifiedDate":"<date/time>",
"LastModifiedBy":"<user>",
"LastUsedDate":"<date/time>",
"LastUsedBy":"<username>",
"Username":"<username>",
"LockedBy":"<username>",
"CPMDisabled":"<reason>",
"CPMStatus":"<status>",
"ManagedByCPM":"<True/False>",
"DeletedBy":"<username>",
"DeletionDate":"<date/time>",
"ImmediateCPMTask":"<string>",
"LastCPMTask":"<string>",
"CreationDate":"<date/time>",
"IsSSHKey":"<true/false>",
"CreationMethod":"<string>",
"CPMErrorDetails":"<error>",
"RetriesCount":"<number>",
"LastFailDate":"<date/time>",
"LastTask":"<task>"
}
},
"Confirmers":[
{
"Type":<type>,
"ID":<id>,
"Name":"<name>",
"Action":<number>,
"Reason":"<reason>",
"ActionDate":<date/time>,
"AdditionalDetails":{},
"Members":null
}
]
}

Parameter

RequestID

Type

Text

Description

The request's unique ID, composed of the SafeName and internal RequestID.

Parameter

SafeName

Type

Text

Description

The name of the Safe where the account being requested is stored .

Parameter

RequestorUserName

Type

Text

Description

The requestor's user name.

Parameter

RequestorReason

Type

Text

Description

The requestor's reason for accessing the account, and any additional information.

Parameter

Ticket ID

Type

Text

Description

The unique ID of the ticket.

Parameter

Ticketing System

Type

Text

Description

The ticketing system that issued the ticket.

Parameter

Emergency

Type

Boolean

Description

Whether or not this request is critical.

Parameter

RefNo

Type

Integer

Description

The unique reference number of this request.

Parameter

PSMRemoteMachine

Type

Text

Description

The address of the remote machine to access using the account in this request.

Parameter

UserReason

Type

Text

Description

The reason given by the user for accessing the account in this request.

Parameter

CreationDate

Type

Integer

Description

The time when the request was created, in Unix time.

Parameter

Operation

Type

Text

Description

The operation that will be performed with the account in this request.

Parameter

ExpirationDate

Type

Integer

Description

The time when the request will expire, in Unix time.

Parameter

OperationType

Type

Integer

Description

The operation that was requested:
1 – Open
2 – Get file
4 – GetPassword
7 – All

Parameter

AccessType

Type

Text

Description

Whether the request is for single or multiple access.

Parameter

ConfirmationsLeft

Type

Integer

Description

The number of confirmers who still need to respond to the request.

Parameter

AccessFrom

Type

Integer

Description

The time from when the account is needed, in Unix time.

Parameter

AccessTo

Type

Integer

Description

The time until when the account is needed, in Unix time.

Parameter

Status

Type

Integer

Description

The request status:
1 - Waiting
2 - Confirmed
7 - Invalid

Parameter

StatusTitle

Type

Text

Description

A description of the request status.

Parameter

InvalidRequestReason

Type

Integer

Description

If the request is invalid, this indicates what caused it to become invalid:
0 - None
1 - Expired
2 - Already been used
4 - Missing supervisors
8 - Confirmation setting have changed
16 - Object has been deleted
32 - Incompatible client version
64 - Access time expired
128 - Rejected

Parameter

CurrentConfirmationLevel

Type

Integer

Description

The current confirmation level - either level 1 or level 2.

Parameter

RequiredConfirmersCountLevel2

Type

Integer

Description

The number of confirmers left to respond at level 2.

TicketingSystemProperties

Parameter

Name

Type

Text

Description

The name of the ticketing system.

Parameter

Number

Type

Integer

Description

Ticket number

Parameter

Status

Type

Integer

Description

Ticket status

■

Validated

■

Not validated

■

Validation is not needed

AdditionalInfo

AccountDetails

Parameter

AccountID

Type

Text

Description

An internal account ID, composed of SafeID and ObjectID.

Properties

Parameter

Address

Type

Text

Description

The address of the machine where the account is used (IP or machine name).

Parameter

Safe

Type

Text

Description

The Safe where the account is stored in the Vault.

Parameter

Folder

Type

Text

Description

The folder where the account is stored in the Vault.

Parameter

Name

Type

Text

Description

The unique name of the account in this request.

Parameter

PolicyID

Type

Text

Description

The policy ID associated to this account.

Parameter

PlatformName

Type

Text

Description

The platform associated to this account.

Parameter

DeviceType

Type

Text

Description

The device type associated to this account.

Parameter

LastVerifiedDate

Type

Date/time

Description

The time when this account was last verified.

Parameter

LastModifiedDate

Type

Date/time

Description

The time when this account was last modified.

Parameter

LastModifiedBy

Type

Text

Description

The name of the user who last modified the account specified in this request.

Parameter

LastUsedDate

Type

Date/time

Description

The last time when the account specified in this request was used.

Parameter

LastUsedBy

Type

Text

Description

The name of the last user who accessed the account specified in this request.

Parameter

Username

Type

Text

Description

The name of the last user who accessed the account specified in this request.

Parameter

LockedBy

Type

Text

Description

If the account specified in this request is locked, the name of the user locking it.

Parameter

CPMDisabled

Type

Text

Description

If the account specified in this request is disabled for automatic management, the reason why.

Parameter

CPMStatus

Type

Text

Description

The status of CPM management for the account specified in this request.

Parameter

ManagedByCPM

Type

Boolean

Description

Whether or not the account specified in this request is managed by the CPM.

Parameter

DeletedBy

Type

Text

Description

The name of the user who deleted the account specified in this request.

Parameter

DeletionDate

Type

Date/time

Description

The time when the account specified in this request was deleted.

Parameter

ImmediateCPMTask

Type

Text

Description

If the account is flagged for an immediate CPM task, the task that will be performed.

Parameter

LastCPMTask

Type

Text

Description

The last CPM task that was performed on the account specified in the request.

Parameter

CreationDate

Type

Integer

Description

The time when the request was created, in Unix time.

Parameter

IsSSHKey

Type

Boolean

Description

Whether or not this account contains an SSH key.

Parameter

CreationMethod

Type

Text

Description

How this account was created in the Vault.

Parameter

CPMErrorDetails

Type

Text

Description

Details of any CPM errors that were issued for this account.

Parameter

RetriesCount

Type

Integer

Description

The number of times that this account tried to log on to a remote machine.

Parameter

LastFailDate

Type

Date/time

Description

The last time this account failed to log on to a remote machine.

Parameter

LastTask

Type

Text

Description

The last task that this account was used for.

Confirmers

Parameter

Type

Integer

Description

The type of confirmer:
1 - User
2 - Group

Parameter

Type

Integer

Description

Internal ID of the confirming user/group.

Parameter

Name

Type

Text

Description

The name of the confirming user/group.

Parameter

Action

Type

Integer

Description

The action performed by the confirmer:
0 – Reject
1 – Confirm
2 – None

Parameter

Reason

Type

Text

Description

The reason specified by the confirmer for their action.

Parameter

ActionDate

Type

Integer

Description

The time when the confirmer performed their action, in Unix time.

AdditionalDetails

Members

Return codes

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