Virima API Specification - CyberArkService Services

The requests documented in this section are directed to CyberArkService resources, which represent .

Contents

1 editDetails POST Interface
2 getDetails GET Interface
3 getCyberArkAttributes GET Interface
4 getCyberArkParametersForApp POST Interface

editDetails POST Interface

Method: POST

Relative URL: cyber-ark/edit-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cybreark	CyberArk

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITDETAILS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "endPoint":"?",
   "port":"?",
   "archive":?,
   "applicationId":"?",
   "safe":"?",
   "platform":"?",
   "virimaMap":"?",
   "cyberarkMap":"?",
   "value":"?",
   "priority":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getDetails GET Interface

Method: GET

Relative URL: cyber-ark/get-details/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getCyberArkAttributes GET Interface

Method: GET

Relative URL: cyber-ark/get-cyberark-attributes

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getCyberArkParametersForApp POST Interface

getCyberArkParametersForApp(POST) is called when the application needs to get all the credentials stored for the particular customer.

Method: POST

Relative URL: cyber-ark/get-cyberark-parameters-for-app

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
clientSessionId	ClientSessionIdentifier

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETCYBERARKPARAMETERSFORAPP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}