Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CT-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Crypto Command Center
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Windows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
redocly logoAPI docs by Redocly

Private Groups V2 (0.1.0)

Download OpenAPI specification:Download

The Private Groups V2 documentation

Relationship Management API

Get JSON Web Key Set

Returns an array of JSON Web Keys as defined by the JSON Web Key (JWK) specification. This can be used to verify the tokens this service has signed.

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 and not passing the acting tenant id in header

Responses

Get JSON Web Key Set

Returns an array of JSON Web Keys as defined by the JSON Web Key (JWK) specification. This can be used to verify the tokens this service has signed.

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 and not passing the acting tenant id in header

Responses

Get JSON Web Key Set

Returns an array of JSON Web Keys as defined by the JSON Web Key (JWK) specification. This can be used to verify the tokens this service has signed.

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 and not passing the acting tenant id in header

Responses

> My Actor Endpoints

Get my Actor

Returns the Actor authenticated by the user access token.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Create/update my Actor

Creates or updates the Actor authenticated by the user access token.

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

Note 2: If the Actor does not exist yet, the {actorType}:create Policy will be evaluated. Otherwise, the {actorType}:update Policy will be evaluated.

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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Actor. This object must follow the JSON schema defined for ActorType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Get my Actor

Returns the Actor authenticated by the user access token.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Create/update my Actor

Creates or updates the Actor authenticated by the user access token.

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

Note 2: If the Actor does not exist yet, the {actorType}:create Policy will be evaluated. Otherwise, the {actorType}:update Policy will be evaluated.

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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Actor. This object must follow the JSON schema defined for ActorType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Get my Actor

Returns the Actor authenticated by the user access token.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Create/update my Actor

Creates or updates the Actor authenticated by the user access token.

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

Note 2: If the Actor does not exist yet, the {actorType}:create Policy will be evaluated. Otherwise, the {actorType}:update Policy will be evaluated.

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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Actor. This object must follow the JSON schema defined for ActorType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

List my Relationships

List all Relationships of the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on.

direction
string
Enum: "from" "to"

Optional direction (from or to) of the Relationship with respect to the Actor authenticated by the user access token.

signed
boolean

Optional signing of Relationships. If true, the response will contain signed Relationships. The default value is false; the response contains human-readable objects.

all
boolean

Optional inclusion of reserved RelationshipTypes. If true, the response will include the RelationshipTypes predefined by Scaled Access. The default value is false.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create my Relationship

Creates a Relationship from the Actor authenticated by the user access token to the target specified in the body.

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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship.

to
required
object

The target Actor/Resource in the Relationship.

object

The custom properties as defined in the relationship type.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

List my Relationships

List all Relationships of the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on.

direction
string
Enum: "from" "to"

Optional direction (from or to) of the Relationship with respect to the Actor authenticated by the user access token.

signed
boolean

Optional signing of Relationships. If true, the response will contain signed Relationships. The default value is false; the response contains human-readable objects.

all
boolean

Optional inclusion of reserved RelationshipTypes. If true, the response will include the RelationshipTypes predefined by Scaled Access. The default value is false.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create my Relationship

Creates a Relationship from the Actor authenticated by the user access token to the target specified in the body.

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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship.

to
required
object

The target Actor/Resource in the Relationship.

object

The custom properties as defined in the relationship type.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

List my Relationships

List all Relationships of the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on.

direction
string
Enum: "from" "to"

Optional direction (from or to) of the Relationship with respect to the Actor authenticated by the user access token.

signed
boolean

Optional signing of Relationships. If true, the response will contain signed Relationships. The default value is false; the response contains human-readable objects.

all
boolean

Optional inclusion of reserved RelationshipTypes. If true, the response will include the RelationshipTypes predefined by Scaled Access. The default value is false.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create my Relationship

Creates a Relationship from the Actor authenticated by the user access token to the target specified in the body.

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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship.

to
required
object

The target Actor/Resource in the Relationship.

object

The custom properties as defined in the relationship type.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Get my Relationship

Returns the Relationship specified by {relationshipId} from the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Update my Relationship

Updates the Relationship specified by {relationshipId} from the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
required
object

The custom properties as defined in the relationship type.

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Delete my Relationship

Removes the Relationship specified by {relationshipId} from the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Get my Relationship

Returns the Relationship specified by {relationshipId} from the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Update my Relationship

Updates the Relationship specified by {relationshipId} from the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
required
object

The custom properties as defined in the relationship type.

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Delete my Relationship

Removes the Relationship specified by {relationshipId} from the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Get my Relationship

Returns the Relationship specified by {relationshipId} from the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Update my Relationship

Updates the Relationship specified by {relationshipId} from the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
required
object

The custom properties as defined in the relationship type.

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Delete my Relationship

Removes the Relationship specified by {relationshipId} from the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

> Actor Endpoints

List all Actors of type

Returns all Actors of the specified {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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Actor

Creates an Actor of type {actorType}. The system will assign an actorId.

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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Actor. This object must follow the JSON schema defined for the chosen ActorType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

List all Actors of type

Returns all Actors of the specified {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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Actor

Creates an Actor of type {actorType}. The system will assign an actorId.

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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Actor. This object must follow the JSON schema defined for the chosen ActorType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

List all Actors of type

Returns all Actors of the specified {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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Actor

Creates an Actor of type {actorType}. The system will assign an actorId.

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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Actor. This object must follow the JSON schema defined for the chosen ActorType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Get an Actor

Returns the Actor specified by {actorType} and {actorId}.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Create/update an Actor

Creates or updates the Actor specified by {actorType} and {actorId}.

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

Note 2: If the Actor does not exist yet, the {actorType}:create Policy will be evaluated. Otherwise, the {actorType}:update Policy will be evaluated.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Actor. This object must follow the JSON schema defined for the chosen ActorType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Delete an Actor

Removes the Actor specified by {actorType} and {actorId}.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Get an Actor

Returns the Actor specified by {actorType} and {actorId}.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Create/update an Actor

Creates or updates the Actor specified by {actorType} and {actorId}.

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

Note 2: If the Actor does not exist yet, the {actorType}:create Policy will be evaluated. Otherwise, the {actorType}:update Policy will be evaluated.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Actor. This object must follow the JSON schema defined for the chosen ActorType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Delete an Actor

Removes the Actor specified by {actorType} and {actorId}.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Get an Actor

Returns the Actor specified by {actorType} and {actorId}.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Create/update an Actor

Creates or updates the Actor specified by {actorType} and {actorId}.

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

Note 2: If the Actor does not exist yet, the {actorType}:create Policy will be evaluated. Otherwise, the {actorType}:update Policy will be evaluated.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Actor. This object must follow the JSON schema defined for the chosen ActorType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Delete an Actor

Removes the Actor specified by {actorType} and {actorId}.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

List all Relationships

Returns all Relationships of the Actor specified by {actorType} and {actorId}.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the Actor.

tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on.

direction
string
Enum: "from" "to"

Optional direction (from or to) of the Relationship with respect to the Actor specified by {actorType} and {actorId}.

signed
boolean

Optional signing of Relationships. If true, the response will contain signed Relationships. The default value is false; the response contains human-readable objects.

all
boolean

Optional inclusion of reserved RelationshipTypes. If true, the response will include the RelationshipTypes predefined by Scaled Access. The default value is false.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Relationship

Creates a Relationship from the Actor specified by {actorType} and {actorId} to the target specified in the body.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship.

to
required
object

The target Actor/Resource in the Relationship.

object

The custom properties as defined in the relationship type.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

List all Relationships

Returns all Relationships of the Actor specified by {actorType} and {actorId}.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the Actor.

tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on.

direction
string
Enum: "from" "to"

Optional direction (from or to) of the Relationship with respect to the Actor specified by {actorType} and {actorId}.

signed
boolean

Optional signing of Relationships. If true, the response will contain signed Relationships. The default value is false; the response contains human-readable objects.

all
boolean

Optional inclusion of reserved RelationshipTypes. If true, the response will include the RelationshipTypes predefined by Scaled Access. The default value is false.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Relationship

Creates a Relationship from the Actor specified by {actorType} and {actorId} to the target specified in the body.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship.

to
required
object

The target Actor/Resource in the Relationship.

object

The custom properties as defined in the relationship type.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

List all Relationships

Returns all Relationships of the Actor specified by {actorType} and {actorId}.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the Actor.

tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on.

direction
string
Enum: "from" "to"

Optional direction (from or to) of the Relationship with respect to the Actor specified by {actorType} and {actorId}.

signed
boolean

Optional signing of Relationships. If true, the response will contain signed Relationships. The default value is false; the response contains human-readable objects.

all
boolean

Optional inclusion of reserved RelationshipTypes. If true, the response will include the RelationshipTypes predefined by Scaled Access. The default value is false.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Relationship

Creates a Relationship from the Actor specified by {actorType} and {actorId} to the target specified in the body.

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship.

to
required
object

The target Actor/Resource in the Relationship.

object

The custom properties as defined in the relationship type.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Delete a Relationship

Removes the Relationship specified by {relationshipId}.

Authorizations:
bearer
path Parameters
actorId
required
string

The identifier for the Actor.

actorType
required
string

The type of Actor.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Get a Relationship

Gets the Relationship specified by {relationshipId}

Authorizations:
bearer
path Parameters
actorId
required
string

The identifier for the Actor.

actorType
required
string

The type of Actor.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Update a Relationship

Update a Relationship of the Actor specified by {actorType}, {actorId} and {relationshipId}

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the Actor.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
required
object

The custom properties as defined in the relationship type.

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Delete a Relationship

Removes the Relationship specified by {relationshipId}.

Authorizations:
bearer
path Parameters
actorId
required
string

The identifier for the Actor.

actorType
required
string

The type of Actor.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Get a Relationship

Gets the Relationship specified by {relationshipId}

Authorizations:
bearer
path Parameters
actorId
required
string

The identifier for the Actor.

actorType
required
string

The type of Actor.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Update a Relationship

Update a Relationship of the Actor specified by {actorType}, {actorId} and {relationshipId}

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the Actor.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
required
object

The custom properties as defined in the relationship type.

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Delete a Relationship

Removes the Relationship specified by {relationshipId}.

Authorizations:
bearer
path Parameters
actorId
required
string

The identifier for the Actor.

actorType
required
string

The type of Actor.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Get a Relationship

Gets the Relationship specified by {relationshipId}

Authorizations:
bearer
path Parameters
actorId
required
string

The identifier for the Actor.

actorType
required
string

The type of Actor.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Update a Relationship

Update a Relationship of the Actor specified by {actorType}, {actorId} and {relationshipId}

Authorizations:
bearer
path Parameters
actorType
required
string

The type of Actor.

actorId
required
string

The identifier for the Actor.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
required
object

The custom properties as defined in the relationship type.

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

> Invitation Endpoints

List my Invitations

Lists all Invitations linked to the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on: isCreatedBy, targets, isAcceptedBy and isRevokedBy.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List my Invitations

Lists all Invitations linked to the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on: isCreatedBy, targets, isAcceptedBy and isRevokedBy.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List my Invitations

Lists all Invitations linked to the Actor authenticated by the user access token.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on: isCreatedBy, targets, isAcceptedBy and isRevokedBy.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all Invitations

Lists all Invitations linked to the Actor or Resource specified by the query parameters {id} and {type}.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
id
required
string

The actorId or resourceId of the Actor/Resource for which to find Invitations.

type
required
string

The actorType or resourceType of the Actor/Resource for which to find Invitations.

relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on: isCreatedBy, targets, isAcceptedBy and isRevokedBy.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Invitation

Creates an Invitation for the invitee to form a Relationship with the target Actor/Resource. The target must be specified with either the from or to body parameter.

Authorizations:
bearer
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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship suggested for the invitee and the target.

from
object

The target Actor/Resource in the Relationship. Choose from or to to indicate the direction of the Relationship.

to
object

The target Actor/Resource in the Relationship. Choose from or to to indicate the direction of the Relationship.

invitor
object

The Actor who requests the invitation. If not provided, the subject from the access token will be used as Actor (if a subject is present).

object

The actor who is invited to form a Relationship.

expiryDate
number

An expiry date as unix timestamp in seconds. If not provided, the expiry date will be set 24 hours in the future.

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "invitor": {
    },
  • "invitee": {
    },
  • "expiryDate": 1613485553
}

Response samples

Content type
application/json
{
  • "invitationId": "string",
  • "requestToken": "string"
}

List all Invitations

Lists all Invitations linked to the Actor or Resource specified by the query parameters {id} and {type}.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
id
required
string

The actorId or resourceId of the Actor/Resource for which to find Invitations.

type
required
string

The actorType or resourceType of the Actor/Resource for which to find Invitations.

relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on: isCreatedBy, targets, isAcceptedBy and isRevokedBy.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Invitation

Creates an Invitation for the invitee to form a Relationship with the target Actor/Resource. The target must be specified with either the from or to body parameter.

Authorizations:
bearer
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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship suggested for the invitee and the target.

from
object

The target Actor/Resource in the Relationship. Choose from or to to indicate the direction of the Relationship.

to
object

The target Actor/Resource in the Relationship. Choose from or to to indicate the direction of the Relationship.

invitor
object

The Actor who requests the invitation. If not provided, the subject from the access token will be used as Actor (if a subject is present).

object

The actor who is invited to form a Relationship.

expiryDate
number

An expiry date as unix timestamp in seconds. If not provided, the expiry date will be set 24 hours in the future.

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "invitor": {
    },
  • "invitee": {
    },
  • "expiryDate": 1613485553
}

Response samples

Content type
application/json
{
  • "invitationId": "string",
  • "requestToken": "string"
}

List all Invitations

Lists all Invitations linked to the Actor or Resource specified by the query parameters {id} and {type}.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
id
required
string

The actorId or resourceId of the Actor/Resource for which to find Invitations.

type
required
string

The actorType or resourceType of the Actor/Resource for which to find Invitations.

relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on: isCreatedBy, targets, isAcceptedBy and isRevokedBy.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Invitation

Creates an Invitation for the invitee to form a Relationship with the target Actor/Resource. The target must be specified with either the from or to body parameter.

Authorizations:
bearer
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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship suggested for the invitee and the target.

from
object

The target Actor/Resource in the Relationship. Choose from or to to indicate the direction of the Relationship.

to
object

The target Actor/Resource in the Relationship. Choose from or to to indicate the direction of the Relationship.

invitor
object

The Actor who requests the invitation. If not provided, the subject from the access token will be used as Actor (if a subject is present).

object

The actor who is invited to form a Relationship.

expiryDate
number

An expiry date as unix timestamp in seconds. If not provided, the expiry date will be set 24 hours in the future.

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "invitor": {
    },
  • "invitee": {
    },
  • "expiryDate": 1613485553
}

Response samples

Content type
application/json
{
  • "invitationId": "string",
  • "requestToken": "string"
}

Get an invitation

Returns the Invitation specified by {invitationId}.

Authorizations:
bearer
path Parameters
invitationId
required
string

The identifier for the Invitation.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "invitation",
  • "relationshipType": "string",
  • "relationshipDirectionForSubject": "from",
  • "expiryDate": 1613554331,
  • "inviteeContactType": "email",
  • "inviteeContactValue": "invitee@example.com",
  • "isCreatedBy": {
    },
  • "targets": {
    },
  • "isAcceptedBy": {
    }
}

Refresh an Invitation

Refreshes an Invitation by creating a new token for the Invitation. This can be used if the old token has expired or is no longer available and you want to resend the invitation.

Authorizations:
bearer
path Parameters
invitationId
required
string

The identifier for the Invitation.

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 and not passing the acting tenant id in header

Request Body schema: application/json
expiryDate
number

An expiry date as unix timestamp in seconds. If not provided, the expiry date will be set 24 hours in the future.

Responses

Request samples

Content type
application/json
{
  • "expiryDate": 0
}

Response samples

Content type
application/json
{
  • "invitationId": "string",
  • "requestToken": "string"
}

Get an invitation

Returns the Invitation specified by {invitationId}.

Authorizations:
bearer
path Parameters
invitationId
required
string

The identifier for the Invitation.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "invitation",
  • "relationshipType": "string",
  • "relationshipDirectionForSubject": "from",
  • "expiryDate": 1613554331,
  • "inviteeContactType": "email",
  • "inviteeContactValue": "invitee@example.com",
  • "isCreatedBy": {
    },
  • "targets": {
    },
  • "isAcceptedBy": {
    }
}

Refresh an Invitation

Refreshes an Invitation by creating a new token for the Invitation. This can be used if the old token has expired or is no longer available and you want to resend the invitation.

Authorizations:
bearer
path Parameters
invitationId
required
string

The identifier for the Invitation.

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 and not passing the acting tenant id in header

Request Body schema: application/json
expiryDate
number

An expiry date as unix timestamp in seconds. If not provided, the expiry date will be set 24 hours in the future.

Responses

Request samples

Content type
application/json
{
  • "expiryDate": 0
}

Response samples

Content type
application/json
{
  • "invitationId": "string",
  • "requestToken": "string"
}

Get an invitation

Returns the Invitation specified by {invitationId}.

Authorizations:
bearer
path Parameters
invitationId
required
string

The identifier for the Invitation.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "invitation",
  • "relationshipType": "string",
  • "relationshipDirectionForSubject": "from",
  • "expiryDate": 1613554331,
  • "inviteeContactType": "email",
  • "inviteeContactValue": "invitee@example.com",
  • "isCreatedBy": {
    },
  • "targets": {
    },
  • "isAcceptedBy": {
    }
}

Refresh an Invitation

Refreshes an Invitation by creating a new token for the Invitation. This can be used if the old token has expired or is no longer available and you want to resend the invitation.

Authorizations:
bearer
path Parameters
invitationId
required
string

The identifier for the Invitation.

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 and not passing the acting tenant id in header

Request Body schema: application/json
expiryDate
number

An expiry date as unix timestamp in seconds. If not provided, the expiry date will be set 24 hours in the future.

Responses

Request samples

Content type
application/json
{
  • "expiryDate": 0
}

Response samples

Content type
application/json
{
  • "invitationId": "string",
  • "requestToken": "string"
}

Accept an Invitation

Accepts an Invitation and creates the specified Relationship between the invitee and the target. The Invitation must be specified in the body by either the requestToken (valid for 24 hours after its creation) or invitationId obtained when creating the Invitation. This endpoint can be used by the invitee or by a third party (e.g. a back-office or automatic system) to accept an invitation on request of the invitee.

Note: Make sure that the acceptor.id and acceptor.type correlate with the claims in the invitee's user access token (see Integration of access token claims). If no Actor object exists for the provided acceptor.id and acceptor.type, a new Actor with the provided id and type is automatically created.

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 and not passing the acting tenant id in header

Request Body schema: application/json
object

The Actor accepting the invitation. If not provided, the subject from the access token will be used as Actor.

invitationId
string

The identifier of the Invitation. Provide either the requestToken or invitationId.

requestToken
string

The request token obtained when creating the Invitation. Provide either the requestToken or invitationId.

object

An object with any extra properties that the relationship type requires or allows. Only strings are allowed.

Responses

Request samples

Content type
application/json
{
  • "acceptor": {
    },
  • "requestToken": "string",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "invitation",
  • "relationshipType": "string",
  • "relationshipDirectionForSubject": "from",
  • "expiryDate": 1613554331,
  • "inviteeContactType": "email",
  • "inviteeContactValue": "invitee@example.com",
  • "isCreatedBy": {
    },
  • "targets": {
    },
  • "isAcceptedBy": {
    }
}

Accept an Invitation

Accepts an Invitation and creates the specified Relationship between the invitee and the target. The Invitation must be specified in the body by either the requestToken (valid for 24 hours after its creation) or invitationId obtained when creating the Invitation. This endpoint can be used by the invitee or by a third party (e.g. a back-office or automatic system) to accept an invitation on request of the invitee.

Note: Make sure that the acceptor.id and acceptor.type correlate with the claims in the invitee's user access token (see Integration of access token claims). If no Actor object exists for the provided acceptor.id and acceptor.type, a new Actor with the provided id and type is automatically created.

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 and not passing the acting tenant id in header

Request Body schema: application/json
object

The Actor accepting the invitation. If not provided, the subject from the access token will be used as Actor.

invitationId
string

The identifier of the Invitation. Provide either the requestToken or invitationId.

requestToken
string

The request token obtained when creating the Invitation. Provide either the requestToken or invitationId.

object

An object with any extra properties that the relationship type requires or allows. Only strings are allowed.

Responses

Request samples

Content type
application/json
{
  • "acceptor": {
    },
  • "requestToken": "string",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "invitation",
  • "relationshipType": "string",
  • "relationshipDirectionForSubject": "from",
  • "expiryDate": 1613554331,
  • "inviteeContactType": "email",
  • "inviteeContactValue": "invitee@example.com",
  • "isCreatedBy": {
    },
  • "targets": {
    },
  • "isAcceptedBy": {
    }
}

Accept an Invitation

Accepts an Invitation and creates the specified Relationship between the invitee and the target. The Invitation must be specified in the body by either the requestToken (valid for 24 hours after its creation) or invitationId obtained when creating the Invitation. This endpoint can be used by the invitee or by a third party (e.g. a back-office or automatic system) to accept an invitation on request of the invitee.

Note: Make sure that the acceptor.id and acceptor.type correlate with the claims in the invitee's user access token (see Integration of access token claims). If no Actor object exists for the provided acceptor.id and acceptor.type, a new Actor with the provided id and type is automatically created.

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 and not passing the acting tenant id in header

Request Body schema: application/json
object

The Actor accepting the invitation. If not provided, the subject from the access token will be used as Actor.

invitationId
string

The identifier of the Invitation. Provide either the requestToken or invitationId.

requestToken
string

The request token obtained when creating the Invitation. Provide either the requestToken or invitationId.

object

An object with any extra properties that the relationship type requires or allows. Only strings are allowed.

Responses

Request samples

Content type
application/json
{
  • "acceptor": {
    },
  • "requestToken": "string",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "invitation",
  • "relationshipType": "string",
  • "relationshipDirectionForSubject": "from",
  • "expiryDate": 1613554331,
  • "inviteeContactType": "email",
  • "inviteeContactValue": "invitee@example.com",
  • "isCreatedBy": {
    },
  • "targets": {
    },
  • "isAcceptedBy": {
    }
}

Withdraw an Invitation

Withdraws an Invitation.

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 and not passing the acting tenant id in header

Request Body schema: application/json
object

The Actor withdrawing the invitation. If not provided, the subject from the access token will be used as Actor.

invitationId
required
string

The identifier of the Invitation.

Responses

Request samples

Content type
application/json
{
  • "revocator": {
    },
  • "invitationId": "string"
}

Withdraw an Invitation

Withdraws an Invitation.

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 and not passing the acting tenant id in header

Request Body schema: application/json
object

The Actor withdrawing the invitation. If not provided, the subject from the access token will be used as Actor.

invitationId
required
string

The identifier of the Invitation.

Responses

Request samples

Content type
application/json
{
  • "revocator": {
    },
  • "invitationId": "string"
}

Withdraw an Invitation

Withdraws an Invitation.

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 and not passing the acting tenant id in header

Request Body schema: application/json
object

The Actor withdrawing the invitation. If not provided, the subject from the access token will be used as Actor.

invitationId
required
string

The identifier of the Invitation.

Responses

Request samples

Content type
application/json
{
  • "revocator": {
    },
  • "invitationId": "string"
}

> Approval Request Endpoints

List my approval requests

Lists all Approval Requests linked to the Actor authenticated by the user access token.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List my approval requests

Lists all Approval Requests linked to the Actor authenticated by the user access token.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List my approval requests

Lists all Approval Requests linked to the Actor authenticated by the user access token.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all Approval Requests

Lists all Approval Requests linked to the Actor or Resource specified by the query parameters {id} and {type}.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
id
required
string

The actorId or resourceId of the Actor/Resource for which to find Approval Requests.

type
required
string

The actorType or resourceType of the Actor/Resource for which to find Approval Requests.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Approval Request

Creates an Approval Request to form a Relationship between the the given actors/resources

Authorizations:
bearer
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 and not passing the acting tenant id in header

Request Body schema: application/json
approvalRequestType
required
string
Value: "relationship"

The type of approval request.

relationshipType
required
string

The type of relationship to be created once the approval request is approved.

required
object

The target Actor/Resource in the Relationship.

required
object

The target Actor/Resource in the Relationship.

object

The Actor who requests the approval. If not provided, the subject from the access token will be used as Actor (if a subject is present).

Responses

Request samples

Content type
application/json
{
  • "approvalRequestType": "relationship",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "initiator": {
    }
}

Response samples

Content type
application/json
{
  • "approvalRequestId": "string"
}

List all Approval Requests

Lists all Approval Requests linked to the Actor or Resource specified by the query parameters {id} and {type}.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
id
required
string

The actorId or resourceId of the Actor/Resource for which to find Approval Requests.

type
required
string

The actorType or resourceType of the Actor/Resource for which to find Approval Requests.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Approval Request

Creates an Approval Request to form a Relationship between the the given actors/resources

Authorizations:
bearer
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 and not passing the acting tenant id in header

Request Body schema: application/json
approvalRequestType
required
string
Value: "relationship"

The type of approval request.

relationshipType
required
string

The type of relationship to be created once the approval request is approved.

required
object

The target Actor/Resource in the Relationship.

required
object

The target Actor/Resource in the Relationship.

object

The Actor who requests the approval. If not provided, the subject from the access token will be used as Actor (if a subject is present).

Responses

Request samples

Content type
application/json
{
  • "approvalRequestType": "relationship",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "initiator": {
    }
}

Response samples

Content type
application/json
{
  • "approvalRequestId": "string"
}

List all Approval Requests

Lists all Approval Requests linked to the Actor or Resource specified by the query parameters {id} and {type}.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
id
required
string

The actorId or resourceId of the Actor/Resource for which to find Approval Requests.

type
required
string

The actorType or resourceType of the Actor/Resource for which to find Approval Requests.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an Approval Request

Creates an Approval Request to form a Relationship between the the given actors/resources

Authorizations:
bearer
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 and not passing the acting tenant id in header

Request Body schema: application/json
approvalRequestType
required
string
Value: "relationship"

The type of approval request.

relationshipType
required
string

The type of relationship to be created once the approval request is approved.

required
object

The target Actor/Resource in the Relationship.

required
object

The target Actor/Resource in the Relationship.

object

The Actor who requests the approval. If not provided, the subject from the access token will be used as Actor (if a subject is present).

Responses

Request samples

Content type
application/json
{
  • "approvalRequestType": "relationship",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "initiator": {
    }
}

Response samples

Content type
application/json
{
  • "approvalRequestId": "string"
}

Get an Approval Request

Returns the Approval Request specified by {approvalRequestId}.

Authorizations:
bearer
path Parameters
approvalRequestId
required
string

The identifier for the ApprovalRequest.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "123",
  • "type": "approvalrequest",
  • "relationshipType": "is_member_of",
  • "approvalRequestType": "relationship",
  • "from": {
    },
  • "to": {
    },
  • "initiates": {
    }
}

Get an Approval Request

Returns the Approval Request specified by {approvalRequestId}.

Authorizations:
bearer
path Parameters
approvalRequestId
required
string

The identifier for the ApprovalRequest.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "123",
  • "type": "approvalrequest",
  • "relationshipType": "is_member_of",
  • "approvalRequestType": "relationship",
  • "from": {
    },
  • "to": {
    },
  • "initiates": {
    }
}

Get an Approval Request

Returns the Approval Request specified by {approvalRequestId}.

Authorizations:
bearer
path Parameters
approvalRequestId
required
string

The identifier for the ApprovalRequest.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "123",
  • "type": "approvalrequest",
  • "relationshipType": "is_member_of",
  • "approvalRequestType": "relationship",
  • "from": {
    },
  • "to": {
    },
  • "initiates": {
    }
}

Approve an Approval Request

Accepts an Approval Request and creates the specified Relationship between the (from) target and the (to) target.

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 and not passing the acting tenant id in header

Request Body schema: application/json
approvalRequestId
required
string

The id of the approval request you are approving

Responses

Request samples

Content type
application/json
{
  • "approvalRequestId": "string"
}

Response samples

Content type
application/json
{
  • "id": "123",
  • "type": "approvalrequest",
  • "relationshipType": "is_member_of",
  • "approvalRequestType": "relationship",
  • "from": {
    },
  • "to": {
    },
  • "initiates": {
    }
}

Approve an Approval Request

Accepts an Approval Request and creates the specified Relationship between the (from) target and the (to) target.

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 and not passing the acting tenant id in header

Request Body schema: application/json
approvalRequestId
required
string

The id of the approval request you are approving

Responses

Request samples

Content type
application/json
{
  • "approvalRequestId": "string"
}

Response samples

Content type
application/json
{
  • "id": "123",
  • "type": "approvalrequest",
  • "relationshipType": "is_member_of",
  • "approvalRequestType": "relationship",
  • "from": {
    },
  • "to": {
    },
  • "initiates": {
    }
}

Approve an Approval Request

Accepts an Approval Request and creates the specified Relationship between the (from) target and the (to) target.

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 and not passing the acting tenant id in header

Request Body schema: application/json
approvalRequestId
required
string

The id of the approval request you are approving

Responses

Request samples

Content type
application/json
{
  • "approvalRequestId": "string"
}

Response samples

Content type
application/json
{
  • "id": "123",
  • "type": "approvalrequest",
  • "relationshipType": "is_member_of",
  • "approvalRequestType": "relationship",
  • "from": {
    },
  • "to": {
    },
  • "initiates": {
    }
}

Deny an Approval Request

Denies an Approval Request.

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 and not passing the acting tenant id in header

Request Body schema: application/json
approvalRequestId
required
string

The id of the approval request you are denying

Responses

Request samples

Content type
application/json
{
  • "approvalRequestId": "string"
}

Response samples

Content type
application/json
{
  • "id": "123",
  • "type": "approvalrequest",
  • "relationshipType": "is_member_of",
  • "approvalRequestType": "relationship",
  • "from": {
    },
  • "to": {
    },
  • "initiates": {
    }
}

Deny an Approval Request

Denies an Approval Request.

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 and not passing the acting tenant id in header

Request Body schema: application/json
approvalRequestId
required
string

The id of the approval request you are denying

Responses

Request samples

Content type
application/json
{
  • "approvalRequestId": "string"
}

Response samples

Content type
application/json
{
  • "id": "123",
  • "type": "approvalrequest",
  • "relationshipType": "is_member_of",
  • "approvalRequestType": "relationship",
  • "from": {
    },
  • "to": {
    },
  • "initiates": {
    }
}

Deny an Approval Request

Denies an Approval Request.

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 and not passing the acting tenant id in header

Request Body schema: application/json
approvalRequestId
required
string

The id of the approval request you are denying

Responses

Request samples

Content type
application/json
{
  • "approvalRequestId": "string"
}

Response samples

Content type
application/json
{
  • "id": "123",
  • "type": "approvalrequest",
  • "relationshipType": "is_member_of",
  • "approvalRequestType": "relationship",
  • "from": {
    },
  • "to": {
    },
  • "initiates": {
    }
}

> Resource Endpoints

List all Resources of type

Returns all Resources of the specified {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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Resource

Creates a Resource of type {resourceType}. The system will assign a resourceId.

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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Resource. This object must follow the JSON schema defined for the chosen ResourceType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

List all Resources of type

Returns all Resources of the specified {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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Resource

Creates a Resource of type {resourceType}. The system will assign a resourceId.

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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Resource. This object must follow the JSON schema defined for the chosen ResourceType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

List all Resources of type

Returns all Resources of the specified {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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Resource

Creates a Resource of type {resourceType}. The system will assign a resourceId.

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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Resource. This object must follow the JSON schema defined for the chosen ResourceType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Get a Resource

Returns the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Create/update a Resource

Creates or updates the Resource specified by {resourceType} and {resourceId}.

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

Note 2: If the Resource does not exist yet, the {resourceType}:create Policy that will be evaluated. Otherwise the {resourceType}:update Policy will be evaluated

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Resource. This object must follow the JSON schema defined for the chosen ResourceType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Delete a Resource

Removes the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Get a Resource

Returns the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Create/update a Resource

Creates or updates the Resource specified by {resourceType} and {resourceId}.

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

Note 2: If the Resource does not exist yet, the {resourceType}:create Policy that will be evaluated. Otherwise the {resourceType}:update Policy will be evaluated

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Resource. This object must follow the JSON schema defined for the chosen ResourceType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Delete a Resource

Removes the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Get a Resource

Returns the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Create/update a Resource

Creates or updates the Resource specified by {resourceType} and {resourceId}.

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

Note 2: If the Resource does not exist yet, the {resourceType}:create Policy that will be evaluated. Otherwise the {resourceType}:update Policy will be evaluated

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json

An object specifying custom attributes for the Resource. This object must follow the JSON schema defined for the chosen ResourceType.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "customAttribute1": "value1",
  • "customAttribute2": "value2"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "customAttribute1": "string",
  • "customAttribute2": "boolean"
}

Delete a Resource

Removes the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

List all Relationships

Returns all Relationships of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the Resource.

tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on.

direction
string
Enum: "from" "to"

Optional direction (from or to) of the Relationship with respect to the Resource specified by {resourceType} and {resourceId}.

signed
boolean

Optional signing of Relationships. If true, the response will contain signed Relationships. The default value is false; the response contains human-readable objects.

all
boolean

Optional inclusion of reserved RelationshipTypes. If true, the response will include the RelationshipTypes predefined by Scaled Access. The default value is false.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Relationship

Creates a Relationship for the Resource specified by {resourceType} and {resourceId}. The target must be specified with either the from or to body parameter.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship.

to
required
object

The target Actor/Resource in the Relationship.

object

The custom properties as defined in the relationship type.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

List all Relationships

Returns all Relationships of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the Resource.

tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on.

direction
string
Enum: "from" "to"

Optional direction (from or to) of the Relationship with respect to the Resource specified by {resourceType} and {resourceId}.

signed
boolean

Optional signing of Relationships. If true, the response will contain signed Relationships. The default value is false; the response contains human-readable objects.

all
boolean

Optional inclusion of reserved RelationshipTypes. If true, the response will include the RelationshipTypes predefined by Scaled Access. The default value is false.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Relationship

Creates a Relationship for the Resource specified by {resourceType} and {resourceId}. The target must be specified with either the from or to body parameter.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship.

to
required
object

The target Actor/Resource in the Relationship.

object

The custom properties as defined in the relationship type.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

List all Relationships

Returns all Relationships of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the Resource.

tenant
required
string

Your tenant code.

query Parameters
relationship-types
string

Optional comma-separated list of RelationshipTypes to filter on.

direction
string
Enum: "from" "to"

Optional direction (from or to) of the Relationship with respect to the Resource specified by {resourceType} and {resourceId}.

signed
boolean

Optional signing of Relationships. If true, the response will contain signed Relationships. The default value is false; the response contains human-readable objects.

all
boolean

Optional inclusion of reserved RelationshipTypes. If true, the response will include the RelationshipTypes predefined by Scaled Access. The default value is false.

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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Relationship

Creates a Relationship for the Resource specified by {resourceType} and {resourceId}. The target must be specified with either the from or to body parameter.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
relationshipType
required
string

The type of relationship.

to
required
object

The target Actor/Resource in the Relationship.

object

The custom properties as defined in the relationship type.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "relationshipType": "string",
  • "to": {
    },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Delete a Relationship

Removes the Relationship specified by {relationshipId}, of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceId
required
string

The identifier for the Resource.

resourceType
required
string

The type of Resource.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Get a Relationship

Returns the Relationship specified by {relationshipId}, of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceId
required
string

The identifier for the Resource.

resourceType
required
string

The type of Resource.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Update a Relationship

Update the Relationship specified by {relationshipId}, of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the Resource.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
required
object

The custom properties as defined in the relationship type.

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Delete a Relationship

Removes the Relationship specified by {relationshipId}, of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceId
required
string

The identifier for the Resource.

resourceType
required
string

The type of Resource.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Get a Relationship

Returns the Relationship specified by {relationshipId}, of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceId
required
string

The identifier for the Resource.

resourceType
required
string

The type of Resource.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Update a Relationship

Update the Relationship specified by {relationshipId}, of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the Resource.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
required
object

The custom properties as defined in the relationship type.

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Delete a Relationship

Removes the Relationship specified by {relationshipId}, of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceId
required
string

The identifier for the Resource.

resourceType
required
string

The type of Resource.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}

Get a Relationship

Returns the Relationship specified by {relationshipId}, of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceId
required
string

The identifier for the Resource.

resourceType
required
string

The type of Resource.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Responses

Update a Relationship

Update the Relationship specified by {relationshipId}, of the Resource specified by {resourceType} and {resourceId}.

Authorizations:
bearer
path Parameters
resourceType
required
string

The type of Resource.

resourceId
required
string

The identifier for the Resource.

relationshipId
required
string

The identifier for the 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 and not passing the acting tenant id in header

Request Body schema: application/json
required
object

The custom properties as defined in the relationship type.

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "relationshipType": "string",
  • "from": {
    },
  • "to": {
    },
  • "properties": { }
}