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

Event Stream Config API (0.0.1)

Download OpenAPI specification:Download

Event Stream Config API documentation

Event Stream Config API

Event Stream API

Create a subscription

Adds a subscription to the event stream.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json

Details to add the subscription.

object (AddEventStreamSubscriptionRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

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

List all subscriptions

Returns all existing subscriptions to the event stream.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

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

Create a subscription

Adds a subscription to the event stream.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json

Details to add the subscription.

object (AddEventStreamSubscriptionRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

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

List all subscriptions

Returns all existing subscriptions to the event stream.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

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

Get a subscription

Returns a specific subscription to the event stream.

Authorizations:
bearer
path Parameters
subscriptionId
required
string

The identifier of the subscription.

tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

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

Remove a subscription

Deletes a specific subscription to the event stream.

Authorizations:
bearer
path Parameters
subscriptionId
required
string

The identifier of the subscription.

tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Update a subscription

Updates a subscription to the event stream.

Note:

  • The endpoint and subscriptionId cannot be updated.
  • With every update, all attributes of the Subscription are updated, either to the provided value or to the default value.
Authorizations:
bearer
path Parameters
subscriptionId
required
string

The identifier of the subscription.

tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json

Details to update the subscription.

object (UpdateEventStreamSubscriptionRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Get a subscription

Returns a specific subscription to the event stream.

Authorizations:
bearer
path Parameters
subscriptionId
required
string

The identifier of the subscription.

tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

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

Remove a subscription

Deletes a specific subscription to the event stream.

Authorizations:
bearer
path Parameters
subscriptionId
required
string

The identifier of the subscription.

tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Update a subscription

Updates a subscription to the event stream.

Note:

  • The endpoint and subscriptionId cannot be updated.
  • With every update, all attributes of the Subscription are updated, either to the provided value or to the default value.
Authorizations:
bearer
path Parameters
subscriptionId
required
string

The identifier of the subscription.

tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json

Details to update the subscription.

object (UpdateEventStreamSubscriptionRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Create a OktaSync subscription

Create a OktaSync subscription

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json

Details for creating an OktaSync subscription.

required
object

Connect configuration for authorization with the Okta API

required
Array of objects (GroupConfigRequest)

The mapping configuration representing the user-group memberships in Okta. Create a mapping configuration for each unique combination of nodeType and relationshipType

Responses

Request samples

Content type
application/json
{
  • "connect": {
    },
  • "groupConfig": [
    ]
}

Remove the oktasync subscription

Deletes a specific subscription to the event stream.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Create a OktaSync subscription

Create a OktaSync subscription

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json

Details for creating an OktaSync subscription.

required
object

Connect configuration for authorization with the Okta API

required
Array of objects (GroupConfigRequest)

The mapping configuration representing the user-group memberships in Okta. Create a mapping configuration for each unique combination of nodeType and relationshipType

Responses

Request samples

Content type
application/json
{
  • "connect": {
    },
  • "groupConfig": [
    ]
}

Remove the oktasync subscription

Deletes a specific subscription to the event stream.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses