Jump to

• Request
• Response

Get Credential Details

get

/process/api/v1/credentials/maps/{param2}/keys/{param3}

Gets the saved credential details of the REST API.

Request

Path Parameters

• param2(required): string
  Name of the credential map
• param3(required): string
  Name of the credential key

There's no request body for this operation.

Security

• Secured: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json
• value

200 Response

Credential details. For PASSWORD type , the username and targetURL values are returned. For OAUTH type, the clientId, grantType, scope, authTokenUrl and targetURL are returned . For GENERIC type, only targetURL is returned.

Body ()

Root Schema : Model6

Type: object

Show Source

• description: string
• scope: string
• secret: string
  returned only for OAUTH type
• targetURL: string
• type: string
• username: string

{
    "type":"object",
    "properties":{
        "username":{
            "type":"string"
        },
        "secret":{
            "type":"string",
            "description":"returned only for OAUTH type"
        },
        "description":{
            "type":"string"
        },
        "targetURL":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "scope":{
            "type":"string"
        }
    }
}

400 Response

Bad request

Body ()

Root Schema : Model8

Type: object

Show Source

• cause: string
• details: string
• errorCode: string
• message: string
• status: integer (int32)
• timestamp: string

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "errorCode":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : Model8

Type: object

Show Source

• cause: string
• details: string
• errorCode: string
• message: string
• status: integer (int32)
• timestamp: string

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "errorCode":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        }
    }
}

404 Response

Not found

Body ()

Root Schema : Model8

Type: object

Show Source

• cause: string
• details: string
• errorCode: string
• message: string
• status: integer (int32)
• timestamp: string

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "errorCode":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        }
    }
}

500 Response

Internal server error

Body ()

Root Schema : Model8

Type: object

Show Source

• cause: string
• details: string
• errorCode: string
• message: string
• status: integer (int32)
• timestamp: string

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "errorCode":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        }
    }
}

Back to Top