REST API Docs | Satori Cyber

API Path

API Description

API Parameters

Request Body Parameters

Response Description

Accounts

An account represents a Satori customer organization. Each account has a unique identifier. Accounts contain objects such as Data Stores and Data Access Controllers, Datasets, Security Policies and Masking Profiles.

Retrieve an Account

get/api/accounts/{id}

This HTTP GET method is used to retrieve the details of a specific account by its unique identifier (id).

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"ssoEnabled": false,

"ssoMetadataXml": "string",

"ssoValidLoginHours": 0,

"demoAccount": false,

"dataStorageLocation": "US",

"marketplaceDetails":

{

"provider": "AWS"

},

"dataPortalSettings":

{

"defaultTemporaryCredentialsExpirationTime":

{

"value": 0,

"timeframe": "Nanos",

"description": "string"

},

"preDefinedDataAccessPurposes":

[

{

"purpose":
"string",

"requiredReason":
false

}

],

"defaultPurpose": "string",

"enablePersonalAccessToken": false

},

"subscription":

{

"type": "PROSPECT"

},

"featureVersion": "string",

"notificationsSettings":

[

{

"notificationKeys":


[

"string"

],

"recipients":


[

"string"

],

"channel":
"EMAIL",

"active":
false,

"updatedAt":
"1970-01-01T00:00:00.000Z"

}

],

"usersNotificationSettings":

[

{

"type":
"ACCESS_GRANTED",

"channels":


[

{

"type":
"EMAIL"

}

],

"active":
false,

"overriddenDefault":
false,

"slackIntegrationActive":
false

}

],

"customEmailUserAttribute": "string",

"awsExternalId": "string",

"commvaultTenantId": "string"

}

Invalid ID supplied

Account not found

Retrieve Pre-Defined Data Access Purposes

get/api/accounts/{id}/settings/data-portal/pre-defined-data-access-purposes

This HTTP GET method is used to retrieve the list of predefined data access purposes of the specified account.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400

Status OK

EXAMPLE SCHEMA

application/json

Copy

[

{

"purposes":


[

{

"purpose":
"string",

"requiredReason":
false

}

],

"defaultPurpose":
"string"

}

]

Bad configuration request

Retrieve Account Theme

get/api/accounts/{id}/theme

This HTTP GET method is used to fetch the theme settings associated with a particular customer (Organization) account.

The theme settings include visual customization options such as colors, fonts, logos, backgrounds and design elements that define the look and feel of the account's interface or user experience.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"enabled": false,

"logo":

{

"filename": "string",

"mimeType": "string",

"size": 0,

"originalFilename": "string"

},

"backgroundColor": "string",

"primaryColor": "string",

"textPrimaryColor": "string"

}

Invalid ID supplied

Account not found

Update Account Theme

put/api/accounts/{id}/theme

This HTTP PUT method is used to update the theme settings of a specific customer account. This request includes the new theme settings, such as updated colors, fonts, logos, backgrounds and design elements.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY multipart/form-data

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"enabled": false,

"logo":

{

"filename": "string",

"mimeType": "string",

"size": 0,

"originalFilename": "string"

},

"backgroundColor": "string",

"primaryColor": "string",

"textPrimaryColor": "string"

}

Invalid ID supplied

Account not found

List All User Identities

get/api/accounts/{id}/identities

This HTTP GET method is used to fetch the list of identities linked to a specified account. "Identities" refers to users and service accounts.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"id": "string",

"name": "string",

"type": "string"

}

Invalid ID supplied

Account not found

List Users with Custom Temporary Credentials Expiration

get/api/accounts/{id}/identities-with-custom-expiration-time

This HTTP GET method is used to fetch the list of users or groups that has been configured with custom temporary credentials expiration.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"identitiesAndExpirationTime":

[

{

"identity":


{

"identityType":
"USER",

"identity":
"string",

"id":
"string",

"displayName":
"string"

},

"temporaryCredentialsExpirationTime":


{

"value":
0,

"timeframe":
"Nanos",

"description":
"string"

}

}

]

}

Invalid ID supplied

Account not found

Update Data Portal Settings

put/api/accounts/{id}/settings/data-portal

This PUT method is used to update the settings related to the data portal for a specific account. The data portal settings include temporary credentials for data access, predefined data access purpose and personal access tokens associated with the account set in the management console.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "defaultTemporaryCredentialsExpirationTime": {
    "value": 0,
    "timeframe": "Nanos",
    "description": "string"
  },
  "preDefinedDataAccessPurposes": [\
    {\
      "purpose": "string",\
      "requiredReason": false\
    }\
  ],
  "defaultPurpose": "string",
  "enablePersonalAccessToken": false
}

object

Multiline description

{

defaultTemporaryCredentialsExpirationTime: {

value:integer

timeframe:enum

Allowed: Nanos┃Micros┃Millis┃Seconds┃Minutes┃Hours┃HalfDays┃Days┃Weeks┃Months┃Years┃Decades┃Centuries┃Millennia┃Eras┃Forever

description:string

}

preDefinedDataAccessPurposes: [{

purpose:string


requiredReason:boolean


}]

defaultPurpose:string

enablePersonalAccessToken:boolean

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"ssoEnabled": false,

"ssoMetadataXml": "string",

"ssoValidLoginHours": 0,

"demoAccount": false,

"dataStorageLocation": "US",

"marketplaceDetails":

{

"provider": "AWS"

},

"dataPortalSettings":

{

"defaultTemporaryCredentialsExpirationTime":

{

"value": 0,

"timeframe": "Nanos",

"description": "string"

},

"preDefinedDataAccessPurposes":

[

{

"purpose":
"string",

"requiredReason":
false

}

],

"defaultPurpose": "string",

"enablePersonalAccessToken": false

},

"subscription":

{

"type": "PROSPECT"

},

"featureVersion": "string",

"notificationsSettings":

"usersNotificationSettings":

"customEmailUserAttribute": "string",

"awsExternalId": "string",

"commvaultTenantId": "string"

}

Bad configuration request

Update Account Notification Settings

post/api/accounts/{id}/notifications

This HTTP POST method is used to create new notifications associated with the specified account. Notifications (DAC Alerts) are used notifying the user about the current DAC version and certificate expirations.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

[\
  {\
    "notificationKeys": [\
      "string"\
    ],\
    "recipients": [\
      "string"\
    ],\
    "channel": "EMAIL",\
    "active": false\
  }\
]

array

Multiline description

[{

notificationKeys:[string]


recipients:[string]


channel:enum


Allowed: EMAIL┃SLACK

active:boolean


}]

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"empty": false,

"first":

{

"notificationKeys":

[

"string"

],

"recipients":

[

"string"

],

"channel": "EMAIL",

"active": false,

"updatedAt": "1970-01-01T00:00:00.000Z"

},

"last":

{

"notificationKeys":

[

"string"

],

"recipients":

[

"string"

],

"channel": "EMAIL",

"active": false,

"updatedAt": "1970-01-01T00:00:00.000Z"

}

}

Invalid ID supplied

Account not found

Update Account General Settings

put/api/accounts/{id}/settings

This HTTP PUT method is used to update the general settings of the specified account. These settings include the account name and SSO configurations related to the account.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "name": "A",
  "ssoEnabled": false,
  "ssoMetadataXml": "string",
  "ssoValidLoginHours": 0
}

object

Multiline description

{

name*: string

Constraints: Min 1 chars

ssoEnabled:boolean

ssoMetadataXml:string

ssoValidLoginHours:integer

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"ssoEnabled": false,

"ssoMetadataXml": "string",

"ssoValidLoginHours": 0,

"demoAccount": false,

"dataStorageLocation": "US",

"marketplaceDetails":

{

"provider": "AWS"

},

"dataPortalSettings":

{

"defaultTemporaryCredentialsExpirationTime":

{

"value": 0,

"timeframe": "Nanos",

"description": "string"

},

"preDefinedDataAccessPurposes":

[

{

"purpose":
"string",

"requiredReason":
false

}

],

"defaultPurpose": "string",

"enablePersonalAccessToken": false

},

"subscription":

{

"type": "PROSPECT"

},

"featureVersion": "string",

"notificationsSettings":

"usersNotificationSettings":

"customEmailUserAttribute": "string",

"awsExternalId": "string",

"commvaultTenantId": "string"

}

Bad configuration request

Service Accounts

Service accounts are identities of the account that should only be used for API access and process automation. Once you create a service account, Satori generates service account credentials which are used to obtain authentication tokens. Service accounts are assigned with a role that determines their permissions.

Retrieve a Service Account

get/api/service-accounts/{id}

This HTTP GET method is used to fetch the details of the specified service account. A service account details include the name, creation date, last updated date, the creator's name, the account ID and a description.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"accountId": "string",

"description": "string",

"bot": false,

"blocked": false,

"bruteForceBlocked": false

}

Bad configuration request

Invalid Authorization

Delete a service account

delete/api/service-accounts/{id}

The HTTP DELETE method is used to delete a service account from the system.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

204 400 401 404

Status OK.

Bad configuration request

Invalid Authorization

Resource not found

List all Service Accounts

get/api/service-accounts

This HTTP GET method is used to fetch a list of all the service accounts in the system. The service account details include the name, creation date, last updated date, the creator's name, the account ID and a description for the service accounts.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"records":

[

{

"entityVersion":
0,

"createdAt":
"1970-01-01T00:00:00.000Z",

"updatedAt":
"1970-01-01T00:00:00.000Z",

"nameCreatedBy":
"string",

"nameUpdatedBy":
"string",

"parentId":
"string",

"id":
"string",

"accountId":
"string",

"description":
"string",

"bot":
false,

"blocked":
false,

"bruteForceBlocked":
false

}

],

"count": 0

}

Bad configuration request

Invalid Authorization

Create a Service Account

post/api/service-accounts

This HTTP POST method is used to create a new service account.The service account includes an account ID, a description and the service account key.

NOTE: Service accounts are created with an automatically generated key that is not kept in the system.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "accountId": "A",
  "description": "A"
}

object

Multiline description

{

accountId*: string

Constraints: Min 1 chars

description*: string

Constraints: Min 1 chars

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

201 400 401 404

Status OK, service account created.

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"accountId": "string",

"description": "string",

"bot": false,

"blocked": false,

"bruteForceBlocked": false,

"apiKey": "string"

}

Bad configuration request

Invalid Authorization

Resource not found

Retrieve a Service Account Role

get/api/service-accounts/{id}/roles

This HTTP GET method is used to fetch the roles that have been assigned to a specific service account. Roles typically define the permissions and access rights the service account has within the system.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 401 404

Status OK, roles found

EXAMPLE SCHEMA

application/json

Copy

[

{

"id":
"string",

"name":
"string",

"description":
"string"

}

]

Invalid Authorization

Resource not found

Reset a Service Account Key

post/api/service-accounts/{id}/reset-api-key

This HTTP POST method is used to reset the service account key for the specified service account. Resetting a service account key is done for security reasons, such as when the key may have been compromised or when it's necessary to rotate keys periodically.

NOTE: The key is automatically generated and is not kept in the system.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK, service account key was reset.

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"accountId": "string",

"description": "string",

"bot": false,

"blocked": false,

"bruteForceBlocked": false,

"apiKey": "string"

}

Bad configuration request

Invalid Authorization

Resource not found

Assign a Service Account Role

put/api/service-accounts/{id}/roles/{roleId}

This HTTP PUT method is used to assign a new role to a service account or update an existing role assignment. Roles determine what permissions and access levels the service account will have.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 401 404

Status OK, service account role was changed

Invalid Authorization

Provided role id lookup failed

DAC Access Tokens

DAC access tokens are credentials used when integrating Satori with BI tools. DAC access tokens should be kept secret, like passwords.

Retrieve a Dac Access Token

get/api/dac-access-token/{id}

This HTTP GET method is used to fetch details about a specific DAC access token.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK, dac access token is found.

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"expirationTime": "1970-01-01T00:00:00.000Z",

"permissions":

[

"CLIENT_ACCESS"

],

"enable": false,

"token": "string"

}

Bad configuration request

Invalid Authorization

Resource not found

Update a DACs Access Token

put/api/dac-access-token/{id}

This HTTP PUT method is used to update the details of a DAC access token. Updates include changes to the token's permissions, expiration date or status.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY *application/json

EXAMPLESCHEMA

{
  "name": "A",
  "expirationTime": "1970-01-01T00:00:00.000Z",
  "permissions": [\
    "CLIENT_ACCESS"\
  ],
  "enable": false
}

object

Multiline description

{

name*: string

Constraints: Min 1 chars

expirationTime:date-time

permissions:[enum]

Allowed: CLIENT_ACCESS┃SPECIAL_URL

enable:boolean

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK, DACs access token is updated

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"expirationTime": "1970-01-01T00:00:00.000Z",

"permissions":

[

"CLIENT_ACCESS"

],

"enable": false,

"token": "string"

}

Bad request

Invalid Authorization

Resource not found

Create a Dac Access Token

post/api/dac-access-token/{id}

This HTTP POST method is used to create, renew or regenerate a DAC access token.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY *application/json

EXAMPLESCHEMA

{
  "name": "A",
  "expirationTime": "1970-01-01T00:00:00.000Z",
  "permissions": [\
    "CLIENT_ACCESS"\
  ],
  "enable": false
}

object

Multiline description

{

name*: string

Constraints: Min 1 chars

expirationTime:date-time

permissions:[enum]

Allowed: CLIENT_ACCESS┃SPECIAL_URL

enable:boolean

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

201 400 401

Status OK, dac access token is created

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"expirationTime": "1970-01-01T00:00:00.000Z",

"permissions":

[

"CLIENT_ACCESS"

],

"enable": false,

"token": "string"

}

Bad configuration request

Invalid Authorization

Delete a DACs access token

delete/api/dac-access-token/{id}

This HTTP DELETE method is used to remove a DAC access token, effectively invalidating it and preventing any further use.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

204 400 401 404

Status OK.

Bad configuration request

Invalid Authorization

Resource not found

List all the DACs Access Tokens

get/api/dac-access-token

This HTTP GET method is used to fetch details about all the DAC access tokens in the system. This includes information such as token IDs, the creation date, update date, updated by, issuance dates, the DAC name, permissions and expiration date and time.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"records":

[

{

"entityVersion":
0,

"createdAt":
"1970-01-01T00:00:00.000Z",

"updatedAt":
"1970-01-01T00:00:00.000Z",

"nameCreatedBy":
"string",

"nameUpdatedBy":
"string",

"parentId":
"string",

"id":
"string",

"name":
"string",

"expirationTime":
"1970-01-01T00:00:00.000Z",

"permissions":


[

"CLIENT_ACCESS"

],

"enable":
false

}

],

"count": 0

}

Bad configuration request

Invalid Authorization

Data Access Requests

Data access requests are used to enable users to gain access to data that is organized in datasets which include databases, schemas, tables or other data assets. Once approved, the data consumer can then query the various data stores to retrieve or manipulate data.

Approve a Data Access Request

post/api/data-access-request/{id}/approve

This HTTP POST method is used to approve a data access request, granting the data consumer access to the requested dataset. This is part of a data access request flow, where a user (data consumer) must receive an approval before being granted access to a specific dataset.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "approverNote": "string"
}

object

Multiline description

{

approverNote:string

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

204 400 401 404

Status OK.

Bad configuration request

Invalid Authorization

Resource not found

Retrieve a Data Access Request

get/api/data-access-request/{id}

This HTTP GET method is used to fetch user information about a specific data access request including, the user name, message, usage purpose and data access level for the requested dataset.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK, dataset found.

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"type": "INSTANT_ACCESS",

"suspended": false,

"identity":

{

"identityType": "USER",

"identity": "string",

"id": "string",

"displayName": "string"

},

"accessLevel": "READ_ONLY",

"timeLimit":

{

"shouldExpire": false,

"unitType": "MINUTES",

"units": 0

},

"unusedTimeLimit":

{

"unusedDaysUntilRevocation": 0,

"shouldRevoke": false

},

"securityPolicyIds":

[

"string"

],

"user": "string",

"message": "string",

"purpose": "string",

"dataAccessLevel": "READ_ONLY",

"requireApproverNote": false,

"userPermissions":

{

"canEdit": false,

"canApprove": false

}

}

Bad configuration request

Invalid Authorization

Resource not found

Delete a Data Access Request

delete/api/data-access-request/{id}

This HTTP DELETE method is used to remove or cancel a data access request.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "rejectionNote": "string"
}

object

Multiline description

{

rejectionNote:string

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

204 400 401 404

Status OK.

Bad configuration request

Invalid Authorization

Resource not found

List all Dataset's Data Access Requests

get/api/data-access-request

This HTTP GET method is used to fetch details about all data access requests, including their status, requester information and requested datasets.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"records":

[

{

"entityVersion":
0,

"createdAt":
"1970-01-01T00:00:00.000Z",

"updatedAt":
"1970-01-01T00:00:00.000Z",

"nameCreatedBy":
"string",

"nameUpdatedBy":
"string",

"parentId":
"string",

"id":
"string",

"type":
"INSTANT_ACCESS",

"suspended":
false,

"identity":


{

"identityType":
"USER",

"identity":
"string",

"id":
"string",

"displayName":
"string"

},

"accessLevel":
"READ_ONLY",

"timeLimit":


{

"shouldExpire":
false,

"unitType":
"MINUTES",

"units":
0

},

"unusedTimeLimit":


{

"unusedDaysUntilRevocation":
0,

"shouldRevoke":
false

},

"securityPolicyIds":


[

"string"

],

"user":
"string",

"message":
"string",

"purpose":
"string",

"dataAccessLevel":
"READ_ONLY",

"requireApproverNote":
false,

"userPermissions":


{

"canEdit":
false,

"canApprove":
false

}

}

],

"count": 0

}

Bad configuration request

Invalid Authorization

List Account's Data Access Requests

get/api/data-access-request/by-account-id

This HTTP GET method is used to fetch all data access requests associated with the specified account.

The data access request details include, the name, display name, creation date, the data access level, unused time limit, message, usage purpose, security policies, masking profiles and whether the data access requires an approvers note.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"records":

[

{

"entityVersion":
0,

"createdAt":
"1970-01-01T00:00:00.000Z",

"updatedAt":
"1970-01-01T00:00:00.000Z",

"nameCreatedBy":
"string",

"nameUpdatedBy":
"string",

"parentId":
"string",

"identity":


{

"identityType":
"USER",

"identity":
"string",

"id":
"string",

"displayName":
"string"

},

"accessLevel":
"READ_ONLY",

"timeLimit":


{

"shouldExpire":
false,

"unitType":
"MINUTES",

"units":
0

},

"unusedTimeLimit":


{

"unusedDaysUntilRevocation":
0,

"shouldRevoke":
false

},

"message":
"string",

"purpose":
"string",

"dataset":


{

"id":
"string",

"name":
"string"

},

"securityPolicies":


[

{

"id":
"string",

"name":
"string"

}

],

"maskingProfiles":


[

{

"id":
"string",

"name":
"string"

}

],

"requireApproverNote":
false,

"userPermissions":


{

"canEdit":
false,

"canApprove":
false

},

"id":
"string"

}

],

"count": 0

}

Bad configuration request

Invalid Authorization

Lists all User's Approvable Requests

get/api/data-access-request/approvable-requests

This HTTP GET method is used to fetch all data access requests that the current user (manager or data steward) has the authority to approve.

This is particularly useful for users with specific roles, such as administrators, data stewards or managers, who need to review and manage pending requests.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"records":

"count": 0

}

Bad configuration request

Invalid Authorization

Resource not found

Create a Data Access Request

post/api/data-access-request/submit-request

This HTTP POST method allows a user to submit a request for access to a specific dataset.

The data access request details include, the username, the data access level, usage purpose and the data access rule.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "message": "string",
  "purpose": "string",
  "dataAccessLevel": "READ_ONLY",
  "dataAccessRuleId": "string"
}

object

Multiline description

{

message:string

purpose:string

dataAccessLevel:enum

Allowed: READ_ONLY┃READ_WRITE┃OWNER

dataAccessRuleId:string

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

202 400 401 404

Status OK, request created.

Bad configuration request

Invalid Authorization

Resource not found

Audit Log

The Audit Log allows you to obtain complete, uniform and searchable data access audits for all data stores with full user, access and data context.

The audit log data is retained in the account indefinitely and there is no retention or roll-off window for the data. On the audit page, you can query up to 90 days of audit data at a time.

Retrieve an Aggregated List of Tools

get/api/data-flow/analytics/{accountId}/tools

This HTTP GET method is used to fetch a list of analytics tools that are linked to a specific account. These tools include software or platforms used for data analysis, BI tools, or other analytics-related tasks.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK, metrics returned

EXAMPLE SCHEMA

application/json

Copy

[

{

"toolName":
"string",

"numberOfQueries":
0

}

]

Bad request

Invalid Authorization

Retrieve a Data Flow Aggregated Counters

get/api/data-flow/analytics/{accountId}/counters

This HTTP GET method is used to fetch a set of counters or metrics that provide insights into the data flow activities and performance for the specified account.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK, metrics returned

EXAMPLE SCHEMA

application/json

Copy

{

"datastoresInUse": 0,

"distinctUserAccess": 0,

"bytesProcessed": 0,

"numberOfQueries": 0,

"lastQueriedAt": "1970-01-01T00:00:00.000Z"

}

Bad request

Invalid Authorization

Resource not found

Retrieve an Aggregated List of Actions

get/api/data-flow/analytics/{accountId}/actions

This HTTP GET method is used to fetch a list of actions or events that have occurred within the data flow analytics processes for the specified account.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"masked": 0,

"blocked": 0,

"alerted": 0,

"others": 0

}

Bad request

DEPRECATED

Export all Data Flows

get/api/data-flow/{accountId}/export

[Deprecated - use /api/export/data-flow] This HTTP GET method is used to export audit logs in CSV format.

The exported data is in CSV format and includes various types of information such as a list of governed and ungoverned queries, masking and filtering actions, classification categories, response and processing times, generic properties and login name.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK

Bad configuration request

Invalid Authorization

Retrieve an Account's Counters

get/api/data-flow/{accountId}/metrics

This HTTP GET method is used to fetch various metrics that track the performance and status of data flow activities for the specified account.

These metrics include things like data processing rates, error rates, throughput and a list of governed and ungoverned queries, masking and filtering actions, classification categories, response and processing times, generic properties and login name.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"dataStoresCount": 0,

"activeDataStoresCount": 0,

"governedQueriesCount": 0,

"queriesCount": 0,

"usersCount": 0

}

Bad configuration request

Invalid Authorization

List all Data Flows

get/api/data-flow/{accountId}/query

This HTTP GET method is used to execute a query or retrieve the results of a query that has been executed against the audit log for the specified account.

The data includes a list of data flows, pagination, filters and sorting as well as a list of governed and ungoverned queries, masking and filtering actions, classification categories, security policies, data access permissions, response and processing time, query name and login name.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"records":

[

{ },

],

"count": 0,

"nextPageToken": "string",

"dsIdsToNamesMap":

{

"property1": "string",

"property2": "string"

}

}

Bad configuration request

Invalid Authorization

Data Export

Data Export allows Satori customers to export the audit records to their own storage system. Supported storage systems: Snowflake.

The audit log data includes data access metadata such as queries, time of query, usernames, data store, tags, locations, action types, country, volume, records, tool used, policy name, city, time zone, client IP address, audit ID, query ID, Auth. method, response time and processing time.

Retrieve Snowflake Data Export Settings

get/api/enterprise-audit/{accountId}/snowflake

This HTTP GET method is used to fetch the settings for exporting audit logs to a Snowflake account.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"enabled": false,

"region": "string",

"sharedAccount": "string"

}

Bad configuration request

Invalid Authorization

Resource not found

Identity Providers

Satori integrates with identity providers to manage users and groups via the SCIM protocol.

The identity provider (IdP) is a service that stores and verifies user identity. IdPs are typically cloud-hosted services, and they often work with single sign-on (SSO) providers to authenticate users.

Activate an Azure SAML Identity Provider certificate

post/api/identity-providers/{providerId}/saml/azure/activate-certificate

This HTTP POST method is used to activate a specific Satori certificate of an Azure AD SAML identity provider. The specified certificate will be set as active and all other certificates will be deactivated.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "satoriPublicCert": "A"
}

object

Multiline description

{

satoriPublicCert*: string

Constraints: Min 1 chars

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"providerName": "string",

"linkedDataStores":

[

"string"

],

"providerPublicCert": "string",

"providerLoginUrl": "string",

"providerIdentifier": "string",

"consumerEntityId": "string",

"consumerServiceUrl": "string",

"satoriPublicCert": "string",

"satoriPublicCerts":

[

{

"publicCert":
"string",

"expiryDate":
"1970-01-01T00:00:00.000Z",

"active":
false

}

]

}

Bad request - Certificate not found or invalid

Invalid Authorization

Identity Provider or certificate not found

Retrieve an Identity Provider

get/api/identity-providers/{id}

This HTTP GET method is used to fetch detailed information about a specific identity provider, such as its version, status, type, creation date and time, provider name and the linked data stores.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"providerName": "string",

"linkedDataStores":

[

"string"

]

}

Bad request

Invalid Authorization

Identity Provider not found

Create an Azure SAML Identity Provider

post/api/identity-providers/{accountId}/saml/azure

This HTTP POST method is used to set up Azure Active Directory as a SAML identity provider for a specific account.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "provider": "OKTA_API",
  "providerPublicCert": "string",
  "providerIdentifier": "string",
  "providerLoginUrl": "string",
  "consumerEntityId": "string",
  "consumerServiceUrl": "string"
}

object

Multiline description

{

provider*: enum

Allowed: OKTA_API┃AZURE_SAML┃AZURE_API┃ONELOGIN_API┃SCIM

providerPublicCert:string

providerIdentifier:string

providerLoginUrl:string

consumerEntityId:string

consumerServiceUrl:string

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"providerName": "string",

"linkedDataStores":

[

"string"

],

"providerPublicCert": "string",

"providerLoginUrl": "string",

"providerIdentifier": "string",

"consumerEntityId": "string",

"consumerServiceUrl": "string",

"satoriPublicCert": "string",

"satoriPublicCerts":

[

{

"publicCert":
"string",

"expiryDate":
"1970-01-01T00:00:00.000Z",

"active":
false

}

]

}

Bad request

Invalid Authorization

Delete an Azure SAML Identity Provider certificate

post/api/identity-providers/{providerId}/saml/azure/delete-certificate

This HTTP POST method is used to delete a specific Satori certificate from an Azure AD SAML identity provider. The active certificate cannot be deleted. At least one certificate must remain in the identity provider.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "satoriPublicCert": "A"
}

object

Multiline description

{

satoriPublicCert*: string

Constraints: Min 1 chars

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"providerName": "string",

"linkedDataStores":

[

"string"

],

"providerPublicCert": "string",

"providerLoginUrl": "string",

"providerIdentifier": "string",

"consumerEntityId": "string",

"consumerServiceUrl": "string",

"satoriPublicCert": "string",

"satoriPublicCerts":

[

{

"publicCert":
"string",

"expiryDate":
"1970-01-01T00:00:00.000Z",

"active":
false

}

]

}

Bad request - Cannot delete active certificate or last certificate

Invalid Authorization

Identity Provider or certificate not found

Delete an Identity Provider

delete/api/identity-providers/{accountId}/{id}

This HTTP DELETE method is used to delete a specific identity provider configuration from an account.

This is done when the identity provider is no longer required, or if you want to replace it with a different provider.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404 409

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"providerName": "string",

"linkedDataStores":

[

"string"

]

}

Bad request

Invalid Authorization

Identity Provider not found

identity provider is assigned to one or more data store

EXAMPLE SCHEMA

application/json

Example 1 Example 2 Example 3

Copy

{

"records":

[

{

"entityVersion":
0,

"createdAt":
"1970-01-01T00:00:00.000Z",

"updatedAt":
"1970-01-01T00:00:00.000Z",

"nameCreatedBy":
"string",

"nameUpdatedBy":
"string",

"parentId":
"string",

"id":
"string",

"name":
"string",

"hostname":
"string",

"satoriHostname":
"string",

"dataAccessControllerId":
"string",

"parent":
"string",

"type":
"string",

"projectIds":


[

"string"

],

"originPort":
0,

"hasIdp":
false,

"demo":
false,

"dataStoreSettings":


{

"deploymentType":
"MONGODB",

"originConnectivitySecured":
false,

"awsServiceRoleArn":
"string",

"awsHostedZoneId":
"string"

},

"regions":


[

{

"cloudProvider":
"GCP",

"regions":


[

{

"name":
"string",

"countryName":
"string",

"countryCode":
"string"

}

]

}

],

"discoveryDetails":


{

"objectId":
"string",

"externalId":
"string",

"cloudAccountId":
"string",

"cloudAccountProvider":
"AWS",

"engineType":
"string",

"cloudAccountName":
"string",

"cluster":
false

},

"environment":
"string"

}

],

"count": 0

}

Copy

{

"records":

"count": 0

}

Copy

{

"records":

"count": 0

}

Extend an Azure SAML Identity Provider certificate

post/api/identity-providers/{providerId}/saml/azure/extend

This HTTP POST method is used to extend the satori certificate of an Azure AD SAML identity provider.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"providerName": "string",

"linkedDataStores":

[

"string"

],

"providerPublicCert": "string",

"providerLoginUrl": "string",

"providerIdentifier": "string",

"consumerEntityId": "string",

"consumerServiceUrl": "string",

"satoriPublicCert": "string",

"satoriPublicCerts":

[

{

"publicCert":
"string",

"expiryDate":
"1970-01-01T00:00:00.000Z",

"active":
false

}

]

}

Bad request

Invalid Authorization

Identity Provider not found

Generate new certificate to Azure SAML Identity Provider

post/api/identity-providers/{providerId}/saml/azure/generate-certificate

This HTTP POST method creates and adds a new Satori certificate to an existing Azure AD SAML identity provider. 3 certificates are allowed per identity provider.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"providerName": "string",

"linkedDataStores":

[

"string"

],

"providerPublicCert": "string",

"providerLoginUrl": "string",

"providerIdentifier": "string",

"consumerEntityId": "string",

"consumerServiceUrl": "string",

"satoriPublicCert": "string",

"satoriPublicCerts":

[

{

"publicCert":
"string",

"expiryDate":
"1970-01-01T00:00:00.000Z",

"active":
false

}

]

}

Bad request - Maximum certificates reached or invalid provider

Invalid Authorization

Identity Provider not found

List all Identity Providers

get/api/identity-providers

This HTTP GET method is used to fetch a list of all identity providers, giving an overview of the different authentication services available.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"records":

[

{

"entityVersion":
0,

"createdAt":
"1970-01-01T00:00:00.000Z",

"updatedAt":
"1970-01-01T00:00:00.000Z",

"nameCreatedBy":
"string",

"nameUpdatedBy":
"string",

"parentId":
"string",

"id":
"string",

"providerName":
"string",

"linkedDataStores":


[

"string"

]

}

],

"count": 0

}

Bad request

Invalid Authorization

Update an Azure SAML Identity Provider

put/api/identity-providers/{providerId}/saml/azure

This HTTP PUT method is used to modify the settings of an Azure AD SAML identity provider and certificates.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

object

Multiline description

{

provider*: enum

Allowed: OKTA_API┃AZURE_SAML┃AZURE_API┃ONELOGIN_API┃SCIM

providerPublicCert:string

providerIdentifier:string

providerLoginUrl:string

consumerEntityId:string

consumerServiceUrl:string

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"providerName": "string",

"linkedDataStores":

[

"string"

],

"providerPublicCert": "string",

"providerLoginUrl": "string",

"providerIdentifier": "string",

"consumerEntityId": "string",

"consumerServiceUrl": "string",

"satoriPublicCert": "string",

"satoriPublicCerts":

[

{

"publicCert":
"string",

"expiryDate":
"1970-01-01T00:00:00.000Z",

"active":
false

}

]

}

Bad request

Invalid Authorization

Identity Provider not found

Data Inventory [DEPRECATED]

This collection of Data Inventory API methods has been deprecated. Refer to the new Data Inventory APIs based on assets.

DEPRECATED

Delete a Location Record

delete/api/locations/{id}

This HTTP DELETE method is used to permanently delete a location from the system. It is used when a location is no longer relevant or if a location was added by mistake.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

204 400 401 404

Status OK.

Bad configuration request

Invalid Authorization

Resource not found

DEPRECATED

List a History for Location Record

get/api/locations/{locationId}/history/v2

This HTTP GET method is used to provide a historical record of events, changes or updates related to the specified location.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"records":

[

{

"id":
"string",

"identity":


{

"type":
"string",

"name":
"string",

"id":
"string",

"displayName":
"string"

},

"actionType":
"string",

"actionSubType":
"string",

"timestamp":
"1970-01-01T00:00:00.000Z",

"userNote":
"string",

"systemNote":
"string",

"statusChanged":
"CLASSIFIED",

"classifiersAdded":


[

"string"

],

"classifiersRemoved":


[

"string"

]

}

],

"count": 0,

"nextPageToken": "string"

}

Bad configuration request

Invalid Authorization

DEPRECATED

Reset all Classification Tags

put/api/locations/{locationId}/reset

This HTTP PUT method is used to reset the classification state of the specified location. This includes clearing configurations and resetting attributes to their default values.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 401 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"dataStoreId": "string",

"status": "string",

"tags":

[

{

"name":
"string",

"displayName":
"string",

"updatedAt":
"1970-01-01T00:00:00.000Z",

"updatedByUser":
false,

"status":
"ACTIVE"

}

]

}

Invalid Authorization

Bad request

DEPRECATED

Update Classification

put/api/locations/{locationId}

This HTTP PUT method is used to enable users to update the information associated with a specific location. Such as, changing the location's name, type, address and user notes.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "addTags": [\
    "string"\
  ],
  "removeTags": [\
    "string"\
  ],
  "notes": "string",
  "forceDelete": false
}

object

Multiline description

{

addTags:[string]

removeTags:[string]

notes:string

forceDelete:boolean

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 401 404

Status OK

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"dataStoreId": "string",

"status": "string",

"tags":

}

Invalid Authorization

Bad request

Masking Profiles

Satori’s masking profiles allow organizations to mask query responses for their users to avoid exposing sensitive information.

Satori’s masking profiles can be applied to data detected and tagged by Satori’s data classification and tagging mechanism.

Retrieve a Masking Profile

get/api/v1/masking/{id}

This HTTP GET method is used to retrieve detailed information about a specific masking profile configuration.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK, masking profile found.

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"description": "string",

"maskConfigs":

[

{

"type":
"TRUNCATE",

"replacement":
"string",

"truncate":
0,

"functionId":
"string",

"sqlFunction":
"string",

"tag":
"string",

"continueWith":


{

"type":
"TRUNCATE",

"replacement":
"string",

"truncate":
0,

"functionId":
"string",

"sqlFunction":
"string"

}

}

]

}

Bad configuration request

Invalid Authorization

Resource not found

Update a Masking Profile

put/api/v1/masking/{id}

This HTTP PUT method is used to modify the masking profile rules for a particular dataset resource. These rules determine how data is masked, obfuscated or anonymized.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY *application/json

EXAMPLESCHEMA

{
  "name": "A",
  "description": "string",
  "maskConfigs": [\
    {\
      "type": "TRUNCATE",\
      "replacement": "string",\
      "truncate": 0,\
      "functionId": "string",\
      "sqlFunction": "string",\
      "tag": "string",\
      "continueWith": {\
        "type": "TRUNCATE",\
        "replacement": "string",\
        "truncate": 0,\
        "functionId": "string",\
        "sqlFunction": "string"\
      }\
    }\
  ]
}

object

Multiline description

{

name*: string

Constraints: Min 1 chars

description:string

maskConfigs*: [{

Min Items: 1

type:enum


Allowed: TRUNCATE┃TRUNCATE_END┃REPLACE_CHAR┃REPLACE_STRING┃HASH┃EMAIL_PREFIX┃EMAIL_SUFFIX┃EMAIL_FULL┃EMAIL_HASH┃CREDIT_CARD_PREFIX┃CREDIT_CARD_FULL┃CREDIT_CARD_HASH┃IP_SUFFIX┃IP_FULL┃IP_HASH┃DATE_YEAR_ONLY┃DATE_1970_AGAIN┃NO_ACTION┃REDACT┃NUMBER_ZERO┃NUMBER_ROUND┃TRANSFORM┃SQL_FUNCTION

replacement:string


truncate:integer


functionId:string


sqlFunction:string


tag:string


continueWith:
{

type:enum


Allowed: TRUNCATE┃TRUNCATE_END┃REPLACE_CHAR┃REPLACE_STRING┃HASH┃EMAIL_PREFIX┃EMAIL_SUFFIX┃EMAIL_FULL┃EMAIL_HASH┃CREDIT_CARD_PREFIX┃CREDIT_CARD_FULL┃CREDIT_CARD_HASH┃IP_SUFFIX┃IP_FULL┃IP_HASH┃DATE_YEAR_ONLY┃DATE_1970_AGAIN┃NO_ACTION┃REDACT┃NUMBER_ZERO┃NUMBER_ROUND┃TRANSFORM┃SQL_FUNCTION

replacement:string


truncate:integer


functionId:string


sqlFunction:string


}

}]

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK, masking profile updated

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"description": "string",

"maskConfigs":

}

Bad request

Invalid Authorization

Resource not found

Delete a Masking Profile

delete/api/v1/masking/{id}

This HTTP DELETE method is used when a particular masking profile configuration is no longer required, such as when data masking requirements change or a specific configuration was created in error.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

204 400 401 404

Status OK.

Bad configuration request

Invalid Authorization

Resource not found

List all Masking Profiles

get/api/v1/masking

This HTTP GET method is useful for administrators or data stewards who need to review, audit, or manage the data masking settings across all of the datasets.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"records":

[

{

"entityVersion":
0,

"createdAt":
"1970-01-01T00:00:00.000Z",

"updatedAt":
"1970-01-01T00:00:00.000Z",

"nameCreatedBy":
"string",

"nameUpdatedBy":
"string",

"parentId":
"string",

"id":
"string",

"name":
"string",

"description":
"string",

"maskConfigs":


[

{

"type":
"TRUNCATE",

"replacement":
"string",

"truncate":
0,

"functionId":
"string",

"sqlFunction":
"string",

"tag":
"string",

"continueWith":


{

"type":
"TRUNCATE",

"replacement":
"string",

"truncate":
0,

"functionId":
"string",

"sqlFunction":
"string"

}

}

]

}

],

"count": 0

}

Bad configuration request

Invalid Authorization

Create a Masking Profile

post/api/v1/masking

This HTTP POST method is used when you need to add a new masking profile rule to protect certain data fields, such as Social Security Numbers, credit card details, or email addresses from being exposed in their entirety.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

REQUEST BODY *application/json

EXAMPLESCHEMA

object

Multiline description

{

name*: string

Constraints: Min 1 chars

description:string

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

201 400 401

Status OK, masking profile created

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"description": "string",

"maskConfigs":

}

Bad configuration request

Invalid Authorization

List all Masking Profile Templates

get/api/v1/masking/templates

This HTTP GET method is used for retrieving predefined masking profile templates.

Pre-defined masking profiles simplify the process of creating masking configurations by providing commonly used patterns and settings.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

TRY

RESPONSE

200 400 401

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"records":

"count": 0

}

Bad configuration request

Invalid Authorization

Security Policies

The Satori Security Policy is a re-usable object that can be configured to contain multiple sets of dynamic masking configurations and data filtering configurations.

Satori's security policy engine is designed to protect an organization's data by authorizing specific individuals or groups of individuals to view data. The main objective of a security policy is to protect an organization's business interests.

Retrieve a Security Policy

get/api/v1/security-policies/{id}

This HTTP GET method is used to retrieve detailed information about a specific security policy.

This includes details such as the policy name, description, dynamic masking rules and data filtering actions.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK, security policy found.

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"stats":

{

"assignedToDatasets":

{

"property1": "string",

"property2": "string"

}

},

"profiles":

{

"rowLevelSecurity":

{

"active": false,

"rules":

[

{

"id":
"string",

"description":
"string",

"active":
false,

"filter":


{

"locationPath":
"For input, these are available options: 'a.b.c' or [{name: 'a'}, {name: 'b'}, {name: 'c'}] or [{name: 'a', type: 'DATABASE'}, {name: 'b', type: 'SCHEMA'}, {name: 'c', type: 'VIEW'}] However, the output will always be a fully populated list of location parts",

"dataStoreId":
"string",

"logicYaml":
"string",

"advanced":
false

}

}

],

"maps":

[

{

"name":
"string",

"filters":


[

{

"criteria":


{

"condition":
"IS",

"identity":


{

"identityType":
"USER",

"identity":
"string",

"id":
"string"

}

},

"values":


{

"type":
"STRING",

"values":


[

"string"

]

}

}

],

"defaults":


{

"type":
"STRING",

"values":


[

"string"

]

}

}

]

},

"masking":

{

"active": false,

"rules":

[

{

"id":
"string",

"description":
"string",

"active":
false,

"criteria":


{

"condition":
"IS",

"identity":


{

"identityType":
"USER",

"identity":
"string",

"id":
"string"

}

},

"maskingAction":


{

"type":
"APPLY_MASKING_PROFILE"

}

}

]

}

},

"currentUserPermissions":

{

"currentUserIsOwner": false,

"canEditPolicies": false

}

}

Bad configuration request

Invalid Authorization

Resource not found

Update a security policy

put/api/v1/security-policies/{id}

This HTTP PUT method is used to allow administrators, data stewards or authorized users (managers) to update the details of a specific security policy.

This involves editing or creating the dynamic masking rules and data filters or updating its description to reflect new security requirements.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY *application/json

EXAMPLESCHEMA

{
  "name": "A",
  "profiles": {
    "rowLevelSecurity": {
      "active": false,
      "rules": [\
        {\
          "id": "string",\
          "description": "string",\
          "active": false,\
          "filter": {\
            "locationPath": "For input, these are available options: 'a.b.c' or [{name: 'a'}, {name: 'b'}, {name: 'c'}] or [{name: 'a', type: 'DATABASE'}, {name: 'b', type: 'SCHEMA'}, {name: 'c', type: 'VIEW'}] However, the output will always be a fully populated list of location parts",\
            "dataStoreId": "string",\
            "logicYaml": "string",\
            "advanced": false\
          }\
        }\
      ],
      "maps": [\
        {\
          "name": "string",\
          "filters": [\
            {\
              "criteria": {\
                "condition": "IS",\
                "identity": {\
                  "identityType": "USER",\
                  "identity": "string",\
                  "id": "string"\
                }\
              },\
              "values": {\
                "type": "STRING",\
                "values": [\
                  "string"\
                ]\
              }\
            }\
          ],\
          "defaults": {\
            "type": "STRING",\
            "values": [\
              "string"\
            ]\
          }\
        }\
      ]
    },
    "masking": {
      "active": false,
      "rules": [\
        {\
          "id": "string",\
          "description": "string",\
          "active": false,\
          "criteria": {\
            "condition": "IS",\
            "identity": {\
              "identityType": "USER",\
              "identity": "string",\
              "id": "string"\
            }\
          },\
          "maskingAction": {\
            "type": "APPLY_MASKING_PROFILE"\
          }\
        }\
      ]
    }
  }
}

object

Multiline description

{

name*: string

Constraints: Min 1 chars

profiles: {

rowLevelSecurity: {

active:boolean

rules: [{

id:string


description:string


active:boolean


filter:
{

locationPath:
[{

Location path, can be either a dot seperated string "a.b.c" or a list of location parts with name and type [{name: ...}, {name: ...}, {name: ....}].

⮕ [ Location path, can be either a dot seperated string "a.b.c" or a list of location parts with name and type [{name: ...}, {name: ...}, {name: ....}]. ]

name:string


type:enum


➔ [Optional] Asset type, when not specified, defaults takes place, resolved by data store type and locationPath length.

Allowed: TABLE┃COLUMN┃SEMANTIC_MODEL┃REPORT┃DASHBOARD┃DATABASE┃SCHEMA┃JSON_PATH┃WAREHOUSE┃ENDPOINT┃TYPE┃FIELD┃EXTERNAL_LOCATION┃CATALOG┃BUCKET┃OBJECT┃COLLECTION┃VIEW┃ACCOUNT_ROLE┃SHARED_DB

}]

dataStoreId:string


locationPrefix:
{

Deprecated, use locationPath field.

type:enum


Allowed: RELATIONAL_TABLE_LOCATION┃MYSQL_TABLE_LOCATION┃ATHENA_TABLE_LOCATION┃MONGO_TABLE_LOCATION┃S3_TABLE_LOCATION┃DATABRICKS_TABLE_LOCATION┃GRAPHQL_TABLE_LOCATION

}

logicYaml:string


advanced:boolean


}

}]

maps: [{

name:string


filters:
[{

criteria:
{

condition:enum


Allowed: IS┃IS_NOT

identity:
{

identityType:enum


Allowed: USER┃DB_USER┃GROUP┃IDP_GROUP┃DATABRICKS_GROUP┃DATABRICKS_SERVICE_PRINCIPAL┃SNOWFLAKE_ROLE┃SNOWFLAKE_ACCOUNT_NAME┃SNOWFLAKE_DATABASE_ROLE┃CEL┃EVERYONE

identity:string


id:string


}

}

values:
{

type:enum


Allowed: STRING┃NUMERIC┃CEL┃SQL┃ANY_VALUE┃ALL_OTHER_VALUES

values:[string]


}

}]

defaults:
{

type:enum


Allowed: STRING┃NUMERIC┃CEL┃SQL┃NO_VALUE┃ALL_OTHER_VALUES

values:[string]


}

}]

}

masking: {

active:boolean

rules: [{

id:string


description:string


active:boolean


criteria:
{

condition:enum


Allowed: IS┃IS_NOT

identity:
{

identityType:enum


Allowed: USER┃DB_USER┃GROUP┃IDP_GROUP┃DATABRICKS_GROUP┃DATABRICKS_SERVICE_PRINCIPAL┃SNOWFLAKE_ROLE┃SNOWFLAKE_ACCOUNT_NAME┃SNOWFLAKE_DATABASE_ROLE┃CEL┃EVERYONE

identity:string


id:string


}

}

maskingAction:
{

type:enum


Allowed: APPLY_MASKING_PROFILE

ONE OF

1{recursive: ApplyMaskingProfileInput}


}

}]

}

}

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK, security policy updated

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"stats":

{

"assignedToDatasets":

{

"property1": "string",

"property2": "string"

}

},

"profiles":

{

"rowLevelSecurity":

{

"active": false,

"rules":

"maps":

},

"masking":

{

"active": false,

"rules":

}

},

"currentUserPermissions":

{

"currentUserIsOwner": false,

"canEditPolicies": false

}

}

Bad request

Invalid Authorization

Resource not found

Delete a Security Policy

delete/api/v1/security-policies/{id}

This HTTP DELETE method is used to allow administrators, data stewards or authorized users (managers) to delete an existing security policy.

The security policy is deleted when it is no longer required, has been replaced by a new security policy, or if the system is undergoing changes that render the policy obsolete.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

204 400 401 404

Status OK.

Bad configuration request

Invalid Authorization

Resource not found

List all Security Policies

get/api/v1/security-policies

This HTTP GET method is used to provide a list of all security policies within the system.

The list includes summaries of each security policy, such as the security policy name, description, users and queries.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"records":

[

{

"entityVersion":
0,

"createdAt":
"1970-01-01T00:00:00.000Z",

"updatedAt":
"1970-01-01T00:00:00.000Z",

"nameCreatedBy":
"string",

"nameUpdatedBy":
"string",

"parentId":
"string",

"id":
"string",

"name":
"string",

"currentUserIsOwner":
false

}

],

"count": 0

}

Bad configuration request

Invalid Authorization

Resource not found

Create a Security Policy

post/api/v1/security-policies

This HTTP POST method is used to enable the creation of a new security policy, which is then enforced within the system. This is useful when new security requirements arise.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

REQUEST BODY *application/json

EXAMPLESCHEMA

object

Multiline description

{

name*: string

Constraints: Min 1 chars

profiles: {

rowLevelSecurity: {

active:boolean

}

masking: {

active:boolean

}

}

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

201 400 401

Status OK, security policy created

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"name": "string",

"stats":

{

"assignedToDatasets":

{

"property1": "string",

"property2": "string"

}

},

"profiles":

{

"rowLevelSecurity":

{

"active": false,

"rules":

"maps":

},

"masking":

{

"active": false,

"rules":

}

},

"currentUserPermissions":

{

"currentUserIsOwner": false,

"canEditPolicies": false

}

}

Bad configuration request

Invalid Authorization

List a Security Policy Statistics

get/api/v1/security-policies/statistics

This HTTP GET method is used to provide an aggregated list of the security policies that have been implemented.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"empty": false,

"first":

{

"securityPolicyId": "string",

"users": 0,

"queries": 0

},

"last":

{

"securityPolicyId": "string",

"users": 0,

"queries": 0

}

}

Bad configuration request

Invalid Authorization

Resource not found

Users and Roles

Each Satori account can be accessed by multiple users. Each user is assigned with a role to reflect their responsibilities.

There are 2 types of users in Satori:

1. Account User - The account user is created by the account admins in the management console. Account users are required to use two-factor authentication which must be configured at the first time log in.
2. Identity Provider User - The identity provider user is created when a new user logins via SSO.

Retrieve an User

get/api/users/{id}

This HTTP GET method is used to provide the details of a specific user, including personal information, account settings, roles and permissions.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401 404

Status OK, user found.

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"accountId": "string",

"parent": "string",

"displayName": "string",

"email": "string",

"lastName": "string",

"firstName": "string",

"authMethod": 0,

"activated": false,

"status": "PENDING_ACTIVATION",

"accessSettings":

{

"temporaryCredentialsExpirationTime":

{

"value": 0,

"timeframe": "Nanos",

"description": "string"

}

},

"roles":

[

"string"

],

"attributes":

{

"property1": { },

"property2": { },

},

"aliases":

[

"string"

],

"customAttributes":

{

"property1": { },

"property2": { },

},

"customAliases":

[

"string"

],

"personalAccessTokenConfigured": false,

"managed": false

}

Bad configuration request

Invalid Authorization

Resource not found

Delete a User

delete/api/users/{id}

This HTTP DELETE method's primary purpose is to permanently remove a user from the system.

This includes user deactivation, account closure, or in response to security concerns (for example, removing accounts of former employees).

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

204 400 401 404

Status OK.

Bad configuration request

Invalid Authorization

Resource not found

DEPRECATED

List all Users

get/api/users

This HTTP GET method is used to retrieve a list of users from the system.

The user information for each user includes, account ID, display name, first name, last name, creation and update dates, roles, attributes aliases, temporary credentials expiration times and personal access tokens.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 400 401

Status OK.

EXAMPLE SCHEMA

application/json

Copy

{

"records":

[

{

"entityVersion":
0,

"createdAt":
"1970-01-01T00:00:00.000Z",

"updatedAt":
"1970-01-01T00:00:00.000Z",

"nameCreatedBy":
"string",

"nameUpdatedBy":
"string",

"parentId":
"string",

"id":
"string",

"accountId":
"string",

"parent":
"string",

"displayName":
"string",

"email":
"string",

"lastName":
"string",

"firstName":
"string",

"authMethod":
0,

"activated":
false,

"status":
"PENDING_ACTIVATION",

"accessSettings":


{

"temporaryCredentialsExpirationTime":


{

"value":
0,

"timeframe":
"Nanos",

"description":
"string"

}

},

"roles":


[

"string"

],

"attributes":


{

"property1":
{ },

"property2":
{ },

},

"aliases":


[

"string"

],

"personalAccessTokenConfigured":
false,

"managed":
false

}

],

"count": 0

}

Bad configuration request

Invalid Authorization

Create a User

post/api/users

This HTTP POST method is used to add a new user to the system with all the necessary details, such as their account ID, first name, last name, email and password.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

REQUEST BODY application/json

EXAMPLESCHEMA

{
  "accountId": "A",
  "email": "user@example.com",
  "firstName": "string",
  "lastName": "string"
}

object

Multiline description

{

accountId*: string

Constraints: Min 1 chars

email:email

firstName:string

lastName:string

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

201 400 401 403

Status OK, user created.

EXAMPLE SCHEMA

application/json

Copy

{

"entityVersion": 0,

"createdAt": "1970-01-01T00:00:00.000Z",

"updatedAt": "1970-01-01T00:00:00.000Z",

"nameCreatedBy": "string",

"nameUpdatedBy": "string",

"parentId": "string",

"id": "string",

"accountId": "string",

"parent": "string",

"displayName": "string",

"email": "string",

"lastName": "string",

"firstName": "string",

"authMethod": 0,

"activated": false,

"status": "PENDING_ACTIVATION",

"accessSettings":

{

"temporaryCredentialsExpirationTime":

{

"value": 0,

"timeframe": "Nanos",

"description": "string"

}

},

"roles":

[

"string"

],

"attributes":

{

"property1": { },

"property2": { },

},

"aliases":

[

"string"

],

"customAttributes":

{

"property1": { },

"property2": { },

},

"customAliases":

[

"string"

],

"personalAccessTokenConfigured": false,

"managed": false

}

Bad configuration request

Invalid Authorization

Resource Limit Exceeded

Retrieve Satori Temporary Credentials

get/api/users/{id}/database-credentials

This HTTP GET method is used to provide access to the database credentials assigned to a specific user.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

QUERY-STRING PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 401 404

Status OK, credentials found

EXAMPLE SCHEMA

application/json

Copy

{

"username": "string",

"password": "string",

"expiredAt": "1970-01-01T00:00:00.000Z"

}

Invalid Authorization

Resource not found

Regenerate Satori Temporary Credentials

put/api/users/{id}/database-credentials

This HTTP PUT method is used to modify the database credentials assigned to a specific user.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 401 404

Status OK, credentials regenerated

EXAMPLE SCHEMA

application/json

Copy

{

"username": "string",

"password": "string",

"expiredAt": "1970-01-01T00:00:00.000Z"

}

Invalid Authorization

Resource not found

Retrieve User's Role

get/api/users/{id}/roles

This HTTP GET method is used to provide a list of roles assigned to a specific user.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 401 404

Status OK, roles found

EXAMPLE SCHEMA

application/json

Copy

[

{

"id":
"string",

"name":
"string",

"description":
"string"

}

]

Invalid Authorization

Resource not found

Update User's Role

put/api/users/{id}/roles

This HTTP PUT method is used for updating the roles assigned to a specific user, changing their permissions and access levels as required.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

REQUEST BODY *application/json

EXAMPLESCHEMA

{
  "rolesIds": [\
    "string"\
  ]
}

object

Multiline description

{

rolesIds:[string]

}

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

200 401 404

Status OK, user role was changed

Invalid Authorization

Provided role id lookup failed

Reset user MFA

delete/api/users/{id}/reset-mfa

This HTTP DELETE method is used to reset or clear the MFA settings associated with a user’s account.

This is necessary if a user is having trouble with their MFA setup, if they need to switch MFA methods or if the system requires a reset for security reasons.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS

API Server

https://app.satoricyber.com

Authentication

Required (None Applied)

FILL EXAMPLE

CLEAR TRY

RESPONSE

204 401 404

Status OK, MFA was reset

Invalid Authorization

Resource not found

Send an Activation Mail

put/api/users/{id}/send-activation-mail

This HTTP PUT method is used to send an activation or verification email to the user.

This email contains a link that the user must click to activate their account or confirm their email address.

HTTP Bearer

Requires Bearer Token in Authorization header

REQUEST

PATH PARAMETERS