Error
A valid request URL is required to generate request examples{
"user_name": "automation@acme.com",
"password": "correct-horse-battery-staple",
"totp_seed": "JBSWY3DPEHPK3PXP"
}{
"error": {
"code": "invalid_request",
"message": "ref is required"
}
}{
"error": {
"code": "invalid_signature",
"message": "Signature verification failed"
}
}{
"error": {
"code": "forbidden",
"message": "Connection has read-only access to this item"
}
}{
"error": {
"code": "item_not_found",
"message": "No item prod/acme-portal/login"
}
}{
"error": {
"code": "item_not_found",
"message": "<string>"
}
}{
"error": {
"code": "item_not_found",
"message": "<string>"
}
}Custom Secret Provider API
Return the secret values of one item
Return the fields the item has. Omit a field (or return null) when
the item does not have it; an empty string is treated the same as
absent. A response with none of the three fields is treated as an
error (“credential resolved to empty”), handled like the errors in
the table above.
POST
/
v1
/
items
/
resolve
Error
A valid request URL is required to generate request examples{
"user_name": "automation@acme.com",
"password": "correct-horse-battery-staple",
"totp_seed": "JBSWY3DPEHPK3PXP"
}{
"error": {
"code": "invalid_request",
"message": "ref is required"
}
}{
"error": {
"code": "invalid_signature",
"message": "Signature verification failed"
}
}{
"error": {
"code": "forbidden",
"message": "Connection has read-only access to this item"
}
}{
"error": {
"code": "item_not_found",
"message": "No item prod/acme-portal/login"
}
}{
"error": {
"code": "item_not_found",
"message": "<string>"
}
}{
"error": {
"code": "item_not_found",
"message": "<string>"
}
}Note:
- Your endpoint, not CloudCruise, hosts this operation. Every request is signed; see request authentication.
totp_seedis the TOTP secret, not a one-time code. See Two-Factor Authentication.- Results are cached for the connection’s cache duration; see Caching and call volume.
Authorizations
v1=<hex HMAC-SHA256>, possibly several comma-separated values during
a secret rotation. See Request authentication above.
Unix time in seconds, part of the signed string. Reject if more than 300 seconds off.
Headers
Unique per request; never reused, including across retries.
The CloudCruise connection id. Not secret.
Body
application/json
Your identifier for one item. Opaque to CloudCruise.
Required string length:
1 - 512Pattern:
^[\x20-\x7E]+$Example:
"prod/acme-portal/login"
Was this page helpful?

