Get details of My Requests
This method returns details of all the requests in My Requests list.
URL
Make sure there are no spaces in the URL. The following characters are not supported in URL values: + & % |
|
The following mandatory value is required in the URL:
Parameter |
RequestID |
Type |
Text |
Description |
The request's unique ID, composed of the SafeName and internal RequestID. |
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
{ "RequestorFullName": "<Requestor full name>", "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": "<external reference number>", " EmergencyIndication": "<Is it an emergency request>" }, "AccountDetails": { "AccountID": "<Full account id, SafeID_ObjectID>", "Properties": { "Name": "<Object name in the vault>", "Folder": "<The object folder name in the vault >", "Safe": "<The object safe name in the vault>", "Address": "<The account address, IP or machine name>", "UserName": "<The account name in the target machine>", "LastUsedDate": "<Last used date of this account>" } }, "Confirmers": [ { "Type": <User\Group>, "ID": <Internal confirmer ID>, "Name": "<Confirmer name>", "Action": <Which action this user perform>, "Reason": "<Confirmer reason>", "ActionDate": <Action date (Unix time)>, "AdditionalDetails": { "fullname": "<User full name>", "email": "<User business email>", "phone": "<User phone>" }, … ], "Members": [ { "UserID": <Internal User ID>, "UserName": "<Confirmer user name>", "AdditionalDetails": { "fullname": "<User full name>", "email": "<User business email>", "phone": "<User phone>" } }, … ] } |
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 |
CreationDate |
|||||||||
Type |
Integer |
|||||||||
Description |
The time when the request was created, in Unix time. |
|||||||||
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: |
|||||||||
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: |
|||||||||
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: |
|||||||||
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
|
|||||||||
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. |
|||||||||
Confirmers |
||||||||||
Parameter |
Type |
|||||||||
Type |
Integer |
|||||||||
Description |
The type of confirmer: |
|||||||||
Parameter |
ID |
|||||||||
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: |
|||||||||
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 |
||||||||||
Parameter |
FullName |
|||||||||
Type |
Text |
|||||||||
Description |
The confirmer's full name. |
|||||||||
Parameter |
|
|||||||||
Type |
Text |
|||||||||
Description |
The confirmer's businesss email. |
|||||||||
Parameter |
Phone |
|||||||||
Type |
Text |
|||||||||
Description |
The confirmer's phone number. |
|||||||||
Members |
||||||||||
Parameter |
UserID |
|||||||||
Type |
Integer |
|||||||||
Description |
The confirmer's internal user ID. |
|||||||||
Parameter |
UserName |
|||||||||
Type |
Text |
|||||||||
Description |
The confirmer's user name. |
|||||||||
AdditionalDetails |
||||||||||
Parameter |
FullName |
|||||||||
Type |
Text |
|||||||||
Description |
The confirmer's full name. |
|||||||||
Parameter |
|
|||||||||
Type |
Text |
|||||||||
Description |
The confirmer's business email. |
|||||||||
Parameter |
Phone |
|||||||||
Type |
Text |
|||||||||
Description |
The confirmer's phone number. |
Return codes
For a complete list of return codes, see Return Codes.