Get Organization Trusts Using GET

Get organization trusts.

Access Policy

Role	User Accounts	Service Accounts (Client Credentials Applications)
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 trust

string

trusteeOrgId

Optional

Unique identifier (GUID) of the trustee organization.

string

trustedOrgId

Optional

Unique identifier (GUID) of the trusted organization.

string

type

Optional

The type of the organization trust.

Possible values are : HIERARCHY, CUSTOM, PARTNER,

integer

pageStart

Optional

Specifies the index that the set of results will begin with

integer

pageLimit

Optional

Specifies the maximum results per page for every call.

string

trustStatus

Optional

The status of the organization trust.

Possible values are : ACTIVE, DEACTIVATED, EXPIRED, EXPIRATION_PROCESSING, EXPIRATION_PROCESSING_FAILED, ORG_DEACTIVATED, PENDING,

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns PagedResponseOrganizationTrustDto of type(s) application/json

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

string

nextLink

Optional

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

string

prevLink

Optional

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

array of OrganizationTrustDto

results

Optional

Partial list of returned results.

integer As int32 As int32

totalResults

Optional

Total number of results if available.

401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

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

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message