Get Credential

Get Credential

Retrieve a credential by its ID

Request
URI
GET
https://{api_host}/v1/credentials/{id}
COPY
Path Parameters
string
id
Required

The ID of the credential


Responses
200

Ok

Returns Credential of type(s) application/json
{
    "id": "string",
    "credentialType": "One among: SSO, SSH, API, FTP, AUDIT",
    "accountType": "One among: USER, SYSTEM, SERVICE",
    "username": "string",
    "password": "string",
    "creationTimestamp": "string",
    "modificationTimestamp": "string",
    "expiry": {
        "expiryDate": "string",
        "lastCheckedDate": "string",
        "connectivityStatus": "One among: ACTIVE, ERROR, UNKNOWN",
        "status": "One among: ACTIVE, EXPIRING, EXPIRED, UNKNOWN"
    },
    "resource": {
        "resourceId": "string",
        "resourceName": "string",
        "resourceIp": "string",
        "resourceType": "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP",
        "domainNames": [
            "string"
        ],
        "domainName": "string"
    },
    "autoRotatePolicy": {
        "frequencyInDays": 0,
        "nextSchedule": "string"
    }
}
string
id
Required

Credential ID

string
credentialType
Required

Credential type

string
accountType
Required

Account type

string
username
Required

Username

string
password
Optional

Password

string
creationTimestamp
Required

The timestamp at which credential was created

string
modificationTimestamp
Required

The timestamp at which credential was last modified

object
expiry
Optional

Represents expiration details of the credential

object
resource
Required

Represents the credential resource in the system

object
autoRotatePolicy
Optional

Represents a auto-rotate policy for a credential


400

Bad Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


401

Unauthorized

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


403

Forbidden

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


404

Not Found

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/credentials/{id}