Get my requests

This method returns a list of the end user's requests.

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/MyRequests?onlywaiting={bool}&expired={bool}

The following mandatory values are required in the URL:

Parameter

OnlyWaiting

Type

Boolean

Description

Only requests waiting for approval will be listed.

Valid values

true/false

Default

false

Parameter

Expired

Type

Boolean

Description

Expired requests will be included in the list.

Valid values

true/false

Default

false

Resource information

HTTP method

GET

Content type

application/json

Header parameter

Parameter

Authorization

Type

String

Description

The token that identifies the session.

Body parameters

None

Result

 
{
"Requests": [
{
"RequestID": "<Request ID, SafeName_RequestID>",
"SafeName": "<Safe name>",
"RequestorUserName": "<Requestor user name>",
"RequestorReason": "<Requestor reason>",
"UserReason": "<User reason>",
"CreationDate": <Request creation date (Unix time)>,
"Operation" : <request operation description>,
"ExpirationDate": <Request expiration date (Unix time)>,
"OperationType": <Which operation was requested>,
"AccessType": "< OneTime\Multiple Access>",
"ConfirmationsLeft": <How many confirmers are still needed>,
"AccessFrom": <When the access time frame starts(Unix time)>,
"AccessTo": <When the access time frame ends (Unix time)>,
"Status": <Request Status>,
"StatusTitle": <Request Status description>,
"InvalidRequestReason": <Why request become invalid>,
"CurrentConfirmationLevel": <The request confirmation level>,
"RequiredConfirmersCountLevel2": <Level 2 confirmers that are still needed>,
"TicketingSystemProperties": {
"Name": "<Ticketing system name>",
"Number": <Ticket number>
"Status": <1/2/3>
},
"AdditionalInfo": {
"Reference No": "<???>",
"Emergency": "<Is it an emergency request>"
},
"AccountDetails": {
"AccountID": "<Internal account ID>",
"Properties": {
"Name": "<Account name in the vault>",
"Folder": "<Folder>",
"Safe": "<Safe>",
"Address": "<Address, can be IP or machine name>",
"UserName": "<User name>",
"LastUsedDate": "<Account last used date >"
}
}
…
]
}

 

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

UserReason

Type

Text

Description

The reason why the user is requesting access to the account.

Parameter

CreationDate

Type

Integer

Description

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

Parameter

Operation

Type

Text

Description

Requestor's description of the operation to perform.

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

Parameter

Reference No

Type

Integer

Description

The unique reference number of this request.

Parameter

Emergency

Type

Boolean

Description

Whether or not this request is critical.

AccountDetails

Parameter

AccountID

Type

Text

Description

An internal account ID, composed of SafeID and ObjectID.

Properties

Parameter

Name

Type

Text

Description

The name of the account in the Vault.

Parameter

Folder

Type

Text

Description

The folder where the account is stored in the Vault.

Parameter

Safe

Type

Text

Description

The Safe where the account is stored in the Vault.

Parameter

Address

Type

Text

Description

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

Parameter

UserName

Type

Text

Description

The name of the user who will use the account.

Parameter

LastUsedDate

Type

Integer

Description

The last time the account was used, in Unix time.

Return codes

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