Get Expirations For Passwords

Get the status of the password expiration fetch

Request

URI

GET

https://sfo-vcf01.rainpole.io/v1/credentials/expirations/{id}

COPY

Path Parameters

string

Required

The expiration fetch workflow ID

Responses

200

Returns CredentialsValidation of type(s) application/json

{
    "description": "string",
    "executionStatus": "One among: COMPLETED, FAILED, IN_PROGRESS",
    "id": "string",
    "validationChecks": [
        {
            "credentialType": "One among: SSO, SSH, API, FTP, AUDIT",
            "description": "string",
            "errors": [
                {
                    "arguments": [
                        "string"
                    ],
                    "causes": [
                        {
                            "message": "string",
                            "type": "string"
                        }
                    ],
                    "context": {
                        "context": "string"
                    },
                    "errorCode": "string",
                    "errorType": "string",
                    "message": "string",
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "remediationMessage": "string"
                }
            ],
            "passwordDetails": {
                "expiryDataRetrievalStatus": "One among: SUCCEEDED, NO_DATA_AVAILABLE",
                "numberOfDaysToExpiry": 0,
                "validityStatus": "One among: VALID, INVALID"
            },
            "resourceId": "string",
            "resourceName": "string",
            "resourceType": "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP",
            "resultStatus": "One among: SUCCEEDED, FAILED",
            "username": "string"
        }
    ]
}

string

description

Optional

Description of the validation

string

executionStatus

Optional

Execution status of the validation

string

Optional

ID of the validation

array of CredentialValidationCheck

validationChecks

Optional

List of one or more validation checks that are performed as part of the validation

400

Bad Request

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

string

message

Optional

The localized error message

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.

string

remediationMessage

Optional

The localized remediation error message

404

Not Found

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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