Get Credentials Task

Retrieve a credential task by ID

Request

URI

GET

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

COPY

Path Parameters

string

Required

The ID of the credentials task

Responses

200

Returns CredentialsTask of type(s) application/json

{
    "creationTimestamp": "string",
    "errors": [
        {
            "arguments": [
                "string"
            ],
            "causes": [
                {
                    "message": "string",
                    "type": "string"
                }
            ],
            "errorCode": "string",
            "errorType": "string",
            "message": "string",
            "nestedErrors": [
                "Error Object"
            ],
            "referenceToken": "string",
            "remediationMessage": "string"
        }
    ],
    "id": "string",
    "isAutoRotate": false,
    "name": "string",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
    "subTasks": [
        {
            "creationTimestamp": "string",
            "credentialType": "string",
            "dependentSubTasks": [
                "CredentialsSubTask Object"
            ],
            "description": "string",
            "entityType": "string",
            "errors": [
                {
                    "arguments": [
                        "string"
                    ],
                    "causes": [
                        {
                            "message": "string",
                            "type": "string"
                        }
                    ],
                    "errorCode": "string",
                    "errorType": "string",
                    "message": "string",
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "remediationMessage": "string"
                }
            ],
            "id": "string",
            "name": "string",
            "newPassword": "string",
            "oldPassword": "string",
            "resourceName": "string",
            "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
            "username": "string"
        }
    ],
    "type": "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY"
}

string

creationTimestamp

Optional

Credential task creation timestamp

array of Error

errors

Optional

List of errors in case of a failure

string

Optional

Credential task ID

boolean

isAutoRotate

Optional

Is Credential task an auto rotate task

string

name

Optional

Credential task name

string

status

Optional

Credential task status

array of CredentialsSubTask

subTasks

Optional

List of credential sub-tasks of the credential task

string

type

Optional

Credential task type

400

Bad Request

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "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

500

Internal Server Error

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "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).