Your suggested change has been received. Thank you.
Download OpenAPI specification:Download
Relationship Config API documentation
Returns the TokenMapping configuration.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": {
- "actorIdClaimPath": "string",
- "actorTypeClaimPath": "string"
}, - "cursor": "string"
}
Updates the TokenMapping configuration.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
actorIdClaimPath required | string The path to the claim in the access token which represents the |
actorTypeClaimPath required | string The path to the claim in the access token which represents the |
{- "actorIdClaimPath": "string",
- "actorTypeClaimPath": "string"
}
{ }
Returns the TokenMapping configuration.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": {
- "actorIdClaimPath": "string",
- "actorTypeClaimPath": "string"
}, - "cursor": "string"
}
Updates the TokenMapping configuration.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
actorIdClaimPath required | string The path to the claim in the access token which represents the |
actorTypeClaimPath required | string The path to the claim in the access token which represents the |
{- "actorIdClaimPath": "string",
- "actorTypeClaimPath": "string"
}
{ }
Returns the authorization configuration (JWKS and JWT details).
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": {
- "jwksUri": "string",
- "issuer": "string",
- "audience": "string"
}, - "cursor": "string"
}
Updates the authorization configuration (JWKS and JWT details)
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
jwksUri required | string The URI of the JSON Web Key Set. |
issuer required | string The URI of the JWT issuer. |
audience | string The expected audience of the JWT. |
{- "jwksUri": "string",
- "issuer": "string",
- "audience": "string"
}
{- "resources": [
- "string"
], - "links": { },
- "config": {
- "jwksUri": "string",
- "issuer": "string",
- "audience": "string"
}, - "cursor": "string"
}
Returns the authorization configuration (JWKS and JWT details).
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": {
- "jwksUri": "string",
- "issuer": "string",
- "audience": "string"
}, - "cursor": "string"
}
Updates the authorization configuration (JWKS and JWT details)
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
jwksUri required | string The URI of the JSON Web Key Set. |
issuer required | string The URI of the JWT issuer. |
audience | string The expected audience of the JWT. |
{- "jwksUri": "string",
- "issuer": "string",
- "audience": "string"
}
{- "resources": [
- "string"
], - "links": { },
- "config": {
- "jwksUri": "string",
- "issuer": "string",
- "audience": "string"
}, - "cursor": "string"
}
Returns the Webhook configuration for a given provider.
provider required | string |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": { },
- "cursor": "string",
- "providerConfig": {
- "apiKey": "string"
}
}
Set up the WebHook configuration for a given provider.
provider required | string |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{ }
Returns the Webhook configuration for a given provider.
provider required | string |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": { },
- "cursor": "string",
- "providerConfig": {
- "apiKey": "string"
}
}
Set up the WebHook configuration for a given provider.
provider required | string |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{ }
Lists all defined RelationshipTypes.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": { },
- "cursor": "string"
}
Lists all defined RelationshipTypes.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": { },
- "cursor": "string"
}
Returns a specific RelationshipType.
relationshipType required | string The type of Relationship. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": {
- "name": "string",
- "description": "string",
- "restrictions": [
- {
- "from": "string",
- "to": "string"
}
], - "properties": [
- {
- "name": "isActive",
- "type": "boolean"
}
]
}, - "cursor": "string"
}
Creates or updates a RelationshipType. In addition, if the from
type is an Actor, a default Policy of type {fromType}:{relationshipType}:{toType}:read
is created, unless it already exists.
Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.
relationshipType required | string The type of Relationship. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
description required | string A human-readable description for the RelationshipType. |
required | Array of objects (Restriction) A list of allowed ActorType/ResourceType combinations with a defined direction ( |
properties | Array of objects (ElementTypeProperty) Custom properties of the RelationshipType. |
{- "description": "string",
- "restrictions": [
- {
- "from": "string",
- "to": "string"
}
], - "properties": [
- { }
]
}
Removes the specified RelationshipType.
Note: Data with this RelationshipType will NOT be erased.
relationshipType required | string |
to required | Array of arrays An ordered list of "to" restrictions that specify which restriction needs to be deleted. The to value for each position combines with the from value in the same position to create a restriction. e.g. |
from required | Array of arrays An ordered list of "from" restrictions that specify which restriction needs to be deleted. The from value for each position combines with the to value in the same position to create a restriction. e.g. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
Returns a specific RelationshipType.
relationshipType required | string The type of Relationship. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": {
- "name": "string",
- "description": "string",
- "restrictions": [
- {
- "from": "string",
- "to": "string"
}
], - "properties": [
- {
- "name": "isActive",
- "type": "boolean"
}
]
}, - "cursor": "string"
}
Creates or updates a RelationshipType. In addition, if the from
type is an Actor, a default Policy of type {fromType}:{relationshipType}:{toType}:read
is created, unless it already exists.
Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.
relationshipType required | string The type of Relationship. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
description required | string A human-readable description for the RelationshipType. |
required | Array of objects (Restriction) A list of allowed ActorType/ResourceType combinations with a defined direction ( |
properties | Array of objects (ElementTypeProperty) Custom properties of the RelationshipType. |
{- "description": "string",
- "restrictions": [
- {
- "from": "string",
- "to": "string"
}
], - "properties": [
- { }
]
}
Removes the specified RelationshipType.
Note: Data with this RelationshipType will NOT be erased.
relationshipType required | string |
to required | Array of arrays An ordered list of "to" restrictions that specify which restriction needs to be deleted. The to value for each position combines with the from value in the same position to create a restriction. e.g. |
from required | Array of arrays An ordered list of "from" restrictions that specify which restriction needs to be deleted. The from value for each position combines with the to value in the same position to create a restriction. e.g. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
Lists all defined ResourceTypes.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": { },
- "cursor": "string"
}
Lists all defined ResourceTypes.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": { },
- "cursor": "string"
}
Returns a specific ResourceType.
resourceType required | string The type of Resource. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": {
- "name": "string",
- "description": "string",
- "properties": [
- { }
]
}, - "cursor": "string"
}
Creates or updates a ResourceType.
Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.
resourceType required | string The type of Resource. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
description required | string A human-readable description for the ResourceType. |
properties | Array of objects (ResourceTypeProperty) Custom properties of the ResourceType. |
{- "description": "string",
- "properties": [
- { }
]
}
Removes the specified ResourceType.
Note: Data with this ResourceType will NOT be erased.
resourceType required | string |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
Returns a specific ResourceType.
resourceType required | string The type of Resource. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": {
- "name": "string",
- "description": "string",
- "properties": [
- { }
]
}, - "cursor": "string"
}
Creates or updates a ResourceType.
Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.
resourceType required | string The type of Resource. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
description required | string A human-readable description for the ResourceType. |
properties | Array of objects (ResourceTypeProperty) Custom properties of the ResourceType. |
{- "description": "string",
- "properties": [
- { }
]
}
Removes the specified ResourceType.
Note: Data with this ResourceType will NOT be erased.
resourceType required | string |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
Lists all defined ActorTypes.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": { },
- "cursor": "string"
}
Lists all defined ActorTypes.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": { },
- "cursor": "string"
}
Returns a specific ActorType.
actorType required | string The type of Actor. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": { },
- "cursor": "string"
}
Creates or updates an ActorType. In addition, a default Policy of type {actorType}:read
is created, unless it already exists.
Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.
actorType required | string The type of Actor. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
description required | string A human-readable description for the ActorType. |
properties | Array of objects (ElementTypeProperty) Custom properties of the ActorType. |
{- "description": "string",
- "properties": [
- { }
]
}
Removes the specified ActorType.
Note: Data with this ActorType will NOT be erased.
actorType required | string |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
Returns a specific ActorType.
actorType required | string The type of Actor. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resources": [
- "string"
], - "links": { },
- "config": { },
- "cursor": "string"
}
Creates or updates an ActorType. In addition, a default Policy of type {actorType}:read
is created, unless it already exists.
Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.
actorType required | string The type of Actor. |
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
description required | string A human-readable description for the ActorType. |
properties | Array of objects (ElementTypeProperty) Custom properties of the ActorType. |
{- "description": "string",
- "properties": [
- { }
]
}
Removes the specified ActorType.
Note: Data with this ActorType will NOT be erased.
actorType required | string |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
Returns a the complete domain model.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resourceTypes": [
- {
- "name": "string",
- "description": "string",
- "properties": [
- { }
]
}
], - "actorTypes": [
- {
- "name": "string",
- "description": "string",
- "properties": [
- { }
]
}
], - "relationshipTypes": [
- {
- "name": "string",
- "description": "string",
- "restrictions": [
- {
- "from": "string",
- "to": "string"
}
], - "properties": [
- {
- "name": "isActive",
- "type": "boolean"
}
]
}
]
}
Returns a the complete domain model.
tenant required | string Your tenant code. |
acting-tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter |
tenant-id | string Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant |
{- "resourceTypes": [
- {
- "name": "string",
- "description": "string",
- "properties": [
- { }
]
}
], - "actorTypes": [
- {
- "name": "string",
- "description": "string",
- "properties": [
- { }
]
}
], - "relationshipTypes": [
- {
- "name": "string",
- "description": "string",
- "restrictions": [
- {
- "from": "string",
- "to": "string"
}
], - "properties": [
- {
- "name": "isActive",
- "type": "boolean"
}
]
}
]
}