Get Organization Trusts Using GET

Get Organization Trusts Using GET

Get organization trusts.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Admin ✔️ ✔️
Organization Owner ✔️ ✔️
Request
URI
GET
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/trusts
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Query Parameters
string
trustId
Optional

Unique identifier ot the uni-directional trust.

string
trusteeOrgId
Optional

Unique identifier (GUID) of the trustee organization that originates trust. Typically the member org.

string
trustedOrgId
Optional

Unique identifier (GUID) of the trusted organization that is the beneficiary of the trust. Typically the management org.

string
type
Optional

The type of the organization trust.

Possible values are : HIERARCHY, CUSTOM, PARTNER,
integer
pageStart
Optional
Constraints: minimum: 1 default: 1

Specifies the index that the set of results will begin with

integer
pageLimit
Optional
Constraints: minimum: 1 maximum: 200 default: 200

Specifies the maximum results per page for every call.

string of array
trustStatus
Optional

The status of the organization trust.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedResponseOrganizationTrustDto of type(s) application/json 
{
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "results": [
        {
            "status": "string",
            "expiresAt": 0,
            "trustId": "string",
            "trusteeOrg": {
                "id": "string",
                "displayName": "string"
            },
            "createdBy": "string",
            "trustedOrg": {
                "id": "string",
                "displayName": "string"
            },
            "createdAt": 0,
            "lastUpdatedAt": 0,
            "description": "string",
            "allowedScopes": {
                "organizationScopes": {
                    "roles": [
                        {
                            "name": "string",
                            "resources": [
                                "string"
                            ]
                        }
                    ],
                    "allRoles": false
                },
                "servicesScopes": [
                    {
                        "serviceDefinitionId": "string",
                        "roles": [
                            {
                                "name": "string",
                                "resources": [
                                    "string"
                                ]
                            }
                        ],
                        "allRoles": false
                    }
                ],
                "allScopes": false
            },
            "type": "string",
            "lastUpdatedBy": "string"
        }
    ],
    "totalResults": 2000,
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15"
}
string
prevLink
Optional

Relative path to previous page if exists. Not returned for POST requests.

array of object
results
Optional

Partial list of returned results.

integer As int32 As int32
totalResults
Optional

Total number of results if available.

string
nextLink
Optional

Relative path to next page if exists. Not returned for POST requests.


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/trusts
On This Page
Organization Trust Management Operations
PATCH
Update Organization Trust Using PATCH
DELETE
Remove Organization Trust Using DELETE
POST
Create Trust Member Organization Using POST
GET
Get Trust Member Organizations Using GET
POST
Create Organization Trust Using POST
GET
Get Organization Trusts Using GET
POST
Create Trust Member Organization V2 Using POST
POST
Invite Member Orgs Using POST