Get Credentials Task

Get Credentials Task

Retrieve a credential task by ID

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

The ID of the credentials task

Responses
200

Ok

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

Credential task ID

string
name
Required

Credential task name

string
type
Required

Credential task type

string
creationTimestamp
Required

Credential task creation timestamp

string
status
Required

Credential task status

array of CredentialsSubTask
subTasks
Optional

List of credential sub-tasks of the credential task

array of Error
errors
Optional

List of errors in case of a failure

boolean
isAutoRotate
Optional

Is Credential task an auto rotate task


400

Bad Request

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.


On This Page
Credentials Operations
DELETE
Cancel Credentials Task
GET
Get Credential
GET
Get Credentials
GET
Get Credentials Sub Task
GET
Get Credentials Task
GET
Get Credentials Tasks
GET
Get Credential Task By Resource ID
POST
Get Password Expiration
GET
Get Password Expiration By Task ID
PATCH
Retry Credentials Task
PATCH
Update Or Rotate Passwords