The API allows you to list, view, create and edit credential
name | type | description |
---|---|---|
direction | query | |
filter | query | |
nameLike | query | |
orderBy | query | |
page | query | |
size | query |
media type | data type | description |
---|---|---|
application/json | array of CredentialDetails (JSON) |
GET /credential
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "CREDSSP"
} ]
media type | data type |
---|---|
application/json | CredentialCreateRequest (JSON) |
media type | data type | description |
---|---|---|
application/json | CredentialDetails (JSON) |
POST /credential
Content-Type: application/json
Accept: application/json
{
"password" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "PLAINTEXT"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "NTLM"
}
name | type | description |
---|---|---|
guid | path |
DELETE /credential/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
name | type | description |
---|---|---|
guid | path |
media type | data type | description |
---|---|---|
application/json | CredentialDetails (JSON) |
GET /credential/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "SSL"
}
name | type | description |
---|---|---|
guid | path |
media type | data type |
---|---|
application/json | CredentialRequest (JSON) |
media type | data type | description |
---|---|---|
application/json | CredentialDetails (JSON) |
PUT /credential/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "PLAINTEXT"
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "PLAINTEXT"
}
name | type | description |
---|---|---|
guid | path |
media type | data type | description |
---|---|---|
application/json | StringDTO (JSON) |
GET /credential/{guid}/password
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"value" : "..."
}
name | type | description |
---|---|---|
guid | path |
media type | data type |
---|---|
application/json | StringDTO (JSON) |
PUT /credential/{guid}/password
Content-Type: application/json
{
"value" : "..."
}
HTTP/1.1 204 No Content
name | type | description |
---|---|---|
guid | path |
media type | data type | description |
---|---|---|
application/json | StringDTO (JSON) |
GET /credential/{guid}/ssh-key
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"value" : "..."
}