Update Organization Trust Using PATCH

Update Organization Trust Using PATCH

Update organization trust.

Access Policy

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

Unique identifier (GUID) of the organization.

string
trustId
Required

Unique identifier ot the trust

Request Body
OrganizationTrustUpdateRequest of type(s) application/json
Required 
{
    "allowedScopes": {
        "allScopes": false,
        "organizationScopes": {
            "allRoles": false,
            "roles": [
                {
                    "name": "string",
                    "resources": [
                        "string"
                    ]
                }
            ]
        },
        "servicesScopes": [
            {
                "allRoles": false,
                "roles": [
                    {
                        "name": "string",
                        "resources": [
                            "string"
                        ]
                    }
                ],
                "serviceDefinitionId": "string"
            }
        ]
    },
    "description": "string",
    "expiresAt": 0,
    "status": "string"
}
OrganizationTrustAllowedScopesDto
allowedScopes
Optional

Defines the properties of the allowed scopes for organization trust.

string
description
Optional

The description about the trust.

integer As int64 As int64
expiresAt
Optional

The timestamp the trust expires at (measured in number of milliseconds since 1/1/1970 UTC).

string
status
Optional

The status of the organization trust. Update of the status is currently restricted.

Possible values are : ACTIVE, DEACTIVATED, EXPIRED, EXPIRATION_PROCESSING, EXPIRATION_PROCESSING_FAILED, ORG_DEACTIVATED, PENDING,
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns OrganizationTrustDto of type(s) application/json 
{
    "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"
}
OrganizationTrustAllowedScopesDto
allowedScopes
Optional

Defines the properties of the allowed scopes for organization trust.

integer As int64 As int64
createdAt
Optional

Timestamp, measured in number of milliseconds since 1/1/1970 UTC, indicating when the organization trust was created.

string
createdBy
Optional

The username (email) of the user who created the organization trust.

string
description
Optional

The description about the trust.

integer As int64 As int64
expiresAt
Optional

The timestamp the trust expires at (measured in number of milliseconds since 1/1/1970 UTC).

integer As int64 As int64
lastUpdatedAt
Optional

Timestamp, measured in number of milliseconds since 1/1/1970 UTC, indicating when the organization trust was last updated.

string
lastUpdatedBy
Optional

The username (email) of the user who last updated the organization trust.

string
status
Optional

The status of the organization trust.

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

Unique identifier (GUID) of the trust.

OrganizationLeanForTrustDto
trustedOrg
Optional

Defines the lean properties of the organization in the trust.

OrganizationLeanForTrustDto
trusteeOrg
Optional

Defines the lean properties of the organization in the trust.

string
type
Optional

The type of the organization trust.

Possible values are : HIERARCHY, CUSTOM, PARTNER,

400

Cannot update non-active organization trust.

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


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

Organization trust with this identifier is not 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


409

The request could not be processed due to a conflict

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

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


On This Page
Organization Trust Management Operations
POST
Create Organization Trust Using POST
GET
Get Organization Trusts Using GET
DELETE
Remove Organization Trust Using DELETE
PATCH
Update Organization Trust Using PATCH