A valid request URL is required to generate request examples{
"ref": "prod/acme-portal/login",
"title": "Acme Portal (prod)",
"group_id": "automation",
"group_name": "Automation"
}{
"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>"
}
}Return an item's display metadata
Metadata only, never secret values. Used to show which item a
credential is bound to, and to check a ref when a user binds it.
A valid request URL is required to generate request examples{
"ref": "prod/acme-portal/login",
"title": "Acme Portal (prod)",
"group_id": "automation",
"group_name": "Automation"
}{
"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.
- Return metadata only, never secret values. This operation is not cached, so keep it cheap.
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
Your identifier for one item. Opaque to CloudCruise.
1 - 512^[\x20-\x7E]+$"prod/acme-portal/login"
Response
The item's metadata.
Your identifier for one item. Opaque to CloudCruise.
1 - 512^[\x20-\x7E]+$"prod/acme-portal/login"
Display name of the item.
1 - 200Optional folder, vault or collection the item belongs to.
512Display name of the group, shown next to the item in the picker.
200Was this page helpful?

