[{"label":"Latest (v1.0)","version":"latest"}]
csp

Update Organization Trust

Description

Update organization trust.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️ ✔️

Request

Request

URL

URL


patch
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/trusts/{trustId}
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

string
trustId Required

Unique identifier ot the trust

Parameter Serialization Style: simple Explode:false

Request Body

Request Body

OrganizationTrustUpdateRequest of mimetype application/json Required
{
	"allowedScopes": {
		"allScopes": false,
		"organizationScopes": {
			"allRoles": false,
			"roles": [
				{
					"name": "string",
					"resources": [
						"string"
					]
				}
			]
		},
		"servicesScopes": [
			{
				"allRoles": false,
				"roles": [
					{
						"name": "string",
						"resources": [
							"string"
						]
					}
				],
				"serviceDefinitionId": "string"
			}
		]
	},
	"expiresAt": 0,
	"status": "ACTIVE"
}
allowedScopes Optional

Defines the properties of the allowed scopes for organization trust.


integer as int64
expiresAt Optional

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


string
status Optional

The status of the organization trust.

Possible values are: ACTIVEDEACTIVATEDEXPIREDEXPIRATION_PROCESSINGEXPIRATION_PROCESSING_FAILEDORG_DEACTIVATED

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns OrganizationTrustDto of type application/json
{
	"allowedScopes": {
		"allScopes": false,
		"organizationScopes": {
			"allRoles": false,
			"roles": [
				{
					"name": "string",
					"resources": [
						"string"
					]
				}
			]
		},
		"servicesScopes": [
			{
				"allRoles": false,
				"roles": [
					{
						"name": "string",
						"resources": [
							"string"
						]
					}
				],
				"serviceDefinitionId": "string"
			}
		]
	},
	"expiresAt": 0,
	"status": "ACTIVE",
	"trustId": "string",
	"trustedOrg": {
		"displayName": "string",
		"id": "string",
		"name": "string"
	},
	"trusteeOrg": {
		"displayName": "string",
		"id": "string",
		"name": "string"
	},
	"type": "HIERARCHY"
}
allowedScopes Optional

Defines the properties of the allowed scopes for organization trust.


integer as int64
expiresAt Optional

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


string
status Optional

The status of the organization trust.

Possible values are: ACTIVEDEACTIVATEDEXPIREDEXPIRATION_PROCESSINGEXPIRATION_PROCESSING_FAILEDORG_DEACTIVATED


string
trustId Optional

Unique identifier (GUID) of the trust.


trustedOrg Optional

Defines the lean properties of the organization in the trust.


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

Errors

Errors

400

Cannot update non-active organization trust.


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Organization trust with this identifier is not found.


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"allowedScopes":{"allScopes":false,"organizationScopes":{"allRoles":false,"roles":[{"name":"string","resources":["string"]}]},"servicesScopes":[{"allRoles":false,"roles":[{"name":"string","resources":["string"]}],"serviceDefinitionId":"string"}]},"expiresAt":0,"status":"ACTIVE"}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/trusts/{trustId}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?