Your suggested change has been received. Thank you.

close

Relationship Config API (0.0.1)

Download OpenAPI specification:Download

Relationship Config API documentation

Relationship Config API

Get TokenMapping

Returns the TokenMapping configuration.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Update TokenMapping

Updates the TokenMapping configuration.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Request Body schema: application/json
actorIdClaimPath
required
string

The path to the claim in the access token which represents the userId of the authenticated User.

actorTypeClaimPath
required
string

The path to the claim in the access token which represents the userType of the authenticated User.

Responses

Request samples

Content type
application/json
{
  • "actorIdClaimPath": "string",
  • "actorTypeClaimPath": "string"
}

Response samples

Content type
application/json
{ }

Get TokenMapping

Returns the TokenMapping configuration.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Update TokenMapping

Updates the TokenMapping configuration.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Request Body schema: application/json
actorIdClaimPath
required
string

The path to the claim in the access token which represents the userId of the authenticated User.

actorTypeClaimPath
required
string

The path to the claim in the access token which represents the userType of the authenticated User.

Responses

Request samples

Content type
application/json
{
  • "actorIdClaimPath": "string",
  • "actorTypeClaimPath": "string"
}

Response samples

Content type
application/json
{ }

Get Authorization Config

Returns the authorization configuration (JWKS and JWT details).

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Update authorization config

Updates the authorization configuration (JWKS and JWT details)

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "jwksUri": "string",
  • "issuer": "string",
  • "audience": "string"
}

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Get Authorization Config

Returns the authorization configuration (JWKS and JWT details).

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Update authorization config

Updates the authorization configuration (JWKS and JWT details)

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "jwksUri": "string",
  • "issuer": "string",
  • "audience": "string"
}

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Get Webhook configuration

Returns the Webhook configuration for a given provider.

Authorizations:
bearer
path Parameters
provider
required
string
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": { },
  • "cursor": "string",
  • "providerConfig": {
    }
}

Setup WebHook Configuration

Set up the WebHook configuration for a given provider.

Authorizations:
bearer
path Parameters
provider
required
string
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{ }

Get Webhook configuration

Returns the Webhook configuration for a given provider.

Authorizations:
bearer
path Parameters
provider
required
string
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": { },
  • "cursor": "string",
  • "providerConfig": {
    }
}

Setup WebHook Configuration

Set up the WebHook configuration for a given provider.

Authorizations:
bearer
path Parameters
provider
required
string
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{ }

> RelationshipType Endpoints

List all RelationshipTypes

Lists all defined RelationshipTypes.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": { },
  • "cursor": "string"
}

List all RelationshipTypes

Lists all defined RelationshipTypes.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": { },
  • "cursor": "string"
}

Get a RelationshipType

Returns a specific RelationshipType.

Authorizations:
bearer
path Parameters
relationshipType
required
string

The type of Relationship.

tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Create/update a RelationshipType

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.

Authorizations:
bearer
path Parameters
relationshipType
required
string

The type of Relationship.

tenant
required
string

Your tenant code.

header Parameters
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

Request Body schema: application/json
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 (from/to). The chosen Types must already exist. At least 1 item is required.

properties
Array of objects (ElementTypeProperty)

Custom properties of the RelationshipType.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "restrictions": [
    ],
  • "properties": [
    ]
}

Delete RelationshipType

Removes the specified RelationshipType.

Note: Data with this RelationshipType will NOT be erased.

Authorizations:
bearer
path Parameters
relationshipType
required
string
query Parameters
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=a,b&to=c,d results in two restrictions being deleted: {from: "a", to: "c"} and {from: "b", to: "d"}

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. ?from=a,b&to=c,d results in two restrictions being deleted: {from: "a", to: "c"} and {from: "b", to: "d"}

header Parameters
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

Responses

Get a RelationshipType

Returns a specific RelationshipType.

Authorizations:
bearer
path Parameters
relationshipType
required
string

The type of Relationship.

tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Create/update a RelationshipType

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.

Authorizations:
bearer
path Parameters
relationshipType
required
string

The type of Relationship.

tenant
required
string

Your tenant code.

header Parameters
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

Request Body schema: application/json
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 (from/to). The chosen Types must already exist. At least 1 item is required.

properties
Array of objects (ElementTypeProperty)

Custom properties of the RelationshipType.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "restrictions": [
    ],
  • "properties": [
    ]
}

Delete RelationshipType

Removes the specified RelationshipType.

Note: Data with this RelationshipType will NOT be erased.

Authorizations:
bearer
path Parameters
relationshipType
required
string
query Parameters
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=a,b&to=c,d results in two restrictions being deleted: {from: "a", to: "c"} and {from: "b", to: "d"}

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. ?from=a,b&to=c,d results in two restrictions being deleted: {from: "a", to: "c"} and {from: "b", to: "d"}

header Parameters
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

Responses

> ResourceType Endpoints

List all ResourceTypes

Lists all defined ResourceTypes.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": { },
  • "cursor": "string"
}

List all ResourceTypes

Lists all defined ResourceTypes.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": { },
  • "cursor": "string"
}

Get a ResourceType

Returns a specific ResourceType.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Create/update a ResourceType

Creates or updates a ResourceType.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

tenant
required
string

Your tenant code.

header Parameters
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

Request Body schema: application/json
description
required
string

A human-readable description for the ResourceType.

properties
Array of objects (ResourceTypeProperty)

Custom properties of the ResourceType.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "properties": [
    ]
}

Delete ResourceType

Removes the specified ResourceType.

Note: Data with this ResourceType will NOT be erased.

Authorizations:
bearer
path Parameters
resourceType
required
string
header Parameters
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

Responses

Get a ResourceType

Returns a specific ResourceType.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Create/update a ResourceType

Creates or updates a ResourceType.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

tenant
required
string

Your tenant code.

header Parameters
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

Request Body schema: application/json
description
required
string

A human-readable description for the ResourceType.

properties
Array of objects (ResourceTypeProperty)

Custom properties of the ResourceType.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "properties": [
    ]
}

Delete ResourceType

Removes the specified ResourceType.

Note: Data with this ResourceType will NOT be erased.

Authorizations:
bearer
path Parameters
resourceType
required
string
header Parameters
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

Responses

> ActorType Endpoints

List all ActorTypes

Lists all defined ActorTypes.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": { },
  • "cursor": "string"
}

List all ActorTypes

Lists all defined ActorTypes.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": { },
  • "cursor": "string"
}

Get an ActorType

Returns a specific ActorType.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": { },
  • "cursor": "string"
}

Create/update an ActorType

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.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

tenant
required
string

Your tenant code.

header Parameters
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

Request Body schema: application/json
description
required
string

A human-readable description for the ActorType.

properties
Array of objects (ElementTypeProperty)

Custom properties of the ActorType.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "properties": [
    ]
}

Delete ActorType

Removes the specified ActorType.

Note: Data with this ActorType will NOT be erased.

Authorizations:
bearer
path Parameters
actorType
required
string
header Parameters
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

Responses

Get an ActorType

Returns a specific ActorType.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": { },
  • "cursor": "string"
}

Create/update an ActorType

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.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

tenant
required
string

Your tenant code.

header Parameters
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

Request Body schema: application/json
description
required
string

A human-readable description for the ActorType.

properties
Array of objects (ElementTypeProperty)

Custom properties of the ActorType.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "properties": [
    ]
}

Delete ActorType

Removes the specified ActorType.

Note: Data with this ActorType will NOT be erased.

Authorizations:
bearer
path Parameters
actorType
required
string
header Parameters
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

Responses

> DomainModel Endpoints

Get domain model

Returns a the complete domain model.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resourceTypes": [
    ],
  • "actorTypes": [
    ],
  • "relationshipTypes": [
    ]
}

Get domain model

Returns a the complete domain model.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
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

Responses

Response samples

Content type
application/json
{
  • "resourceTypes": [
    ],
  • "actorTypes": [
    ],
  • "relationshipTypes": [
    ]
}