List Shares

List Shares

List all shares

Request
URI
GET
https://{api_host}/tca/tenancy/api/v1/orgs/{tenancyShareOrgId}/shares
COPY
Path Parameters
string
tenancyShareOrgId
Required

The identifier of the tenant/organization

tenancyShareOrgId example
c11ade69-5f11-4bef-9cbe-d52fcecb5bea
Query Parameters
string
nextpage_opaque_marker
Optional

May contain page_no= , page_size= , sort= ,<asc/desc>

nextpage_opaque_marker example
nextpage_opaque_marker=page_no=1,page_size=20,sort=createdAt:desc
string
filter
Optional

The filter for listing

filter example
filter=(eq,name,myIdp)

Responses
200

List of shares

Returns Array of shareExtended of type(s) application/json
[
    {
        "type": "string",
        "objectId": "dbdc8f6b-8a97-4006-bd79-50230e1e64a2",
        "objectType": "string",
        "tenantId": "8e6ae5a4-d2d1-4ed1-833c-923dfa6988d3",
        "id": "fc0a0058-3cfd-44b1-a91d-5110d48a63e2",
        "createdAt": "2023-02-13T13:19:37.448Z",
        "creationUser": "joe@vsphere.local",
        "creationTenantId": "001c44fd-b160-4297-925a-5ae11cc6b1d8",
        "tenantName": "tenant-1"
    }
]

Response Headers

string
Link

undefined

integer
TotalRowCount

The total number of matching shares


400

Bad Request

Returns errorResponse of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

500

Internal Server Error

Returns errorResponse of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors