Virima API Specification - CredentialService Services

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

Contents

1 archiveCredential POST Interface
2 editCredential POST Interface
3 flushAssociatedCredentials POST Interface

archiveCredential POST Interface

Method: POST

Relative URL: credentials/archive

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
credentialId	RecordID

Response Structure:

Field Name	Type	Description
response	RecordID

Example Request:

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

Example Response:

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

editCredential POST Interface

Method: POST

Relative URL: credentials/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
credential	Credentials

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITCREDENTIAL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":98065754,
   "status":?,
   "name":"?",
   "credentialType":"?",
   "userName":"?",
   "password":"?",
   "sshPrivateKey":"?",
   "passphrase":"?",
   "isWorkgroup":?,
   "domainName":"?",
   "workgroupName":"?",
   "priority":?,
   "ipRange":"?",
   "archive":?,
   "isLocal":?,
   "uniqueId":"?",
   "dcName":"?",
   "dcIp":"?",
   "tenantId":"?",
   "clientId":"?",
   "secretKey":"?",
   "subscriptionId":"?",
   "lastModifiedOn":?,
   "isSqlserverWindowsAuthentication":?,
   "port":"?",
   "instanceName":"?",
   "isLinuxOS":?,
   "active":?,
   "isSubscriptionID":?,
   "isManagementGroupID":?,
   "awsCredentialType":"?",
   "siteCode":"?",
   "azureAuthType":"?",
   "azureCertificate":"?",
   "azurePrivateKey":"?"
}

Example Response:

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

flushAssociatedCredentials POST Interface

Method: POST

Relative URL: credentials/flush-associated-credentials

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	IntegerList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

FLUSHASSOCIATEDCREDENTIALS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "actionType":"?",
}

Example Response:

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