Organizations

Manage organizations. It includes operations such as listing all organizations, creating a new organization, reading specific organization details, and updating an organization.

List Data Source Settings

List all data source settings for a specific organization.

SecurityapiKey
Request
path Parameters
id
required
string (OrganizationId)

Organization ID.

Example: cdq_monitor
query Parameters
maskedCredentials
boolean
Default: false

Mask credentials.

Example: maskedCredentials=false
page
integer
Default: 0

Page number.

Example: page=0
pageSize
integer
Default: 50

Number of items per page.

Example: pageSize=50
Responses
200

successful operation

get/organizations/{id}/globalsettings/datapoolaccesssettings
Request samples
Response samples
application/json
{
  • "page": "1",
  • "pageSize": "100",
  • "total": "67",
  • "values": [
    ]
}

Read Data Source Settings

Read data source settings for a specific organization.

SecurityapiKey
Request
path Parameters
dataSourceTechnicalKey
required
string (DataSourceTechnicalKey)

Data Source Technical Key.

Example: BR_RF
id
required
string (OrganizationId)

Organization ID.

Example: cdq_monitor
query Parameters
maskedCredentials
boolean
Default: false

Mask credentials.

Example: maskedCredentials=false
Responses
200

successful operation

get/organizations/{id}/globalsettings/datapoolaccesssettings/{dataSourceTechnicalKey}
Request samples
Response samples
application/json
{
  • "dataSource": {},
  • "activationStatus": "ACTIVE",
  • "activatedAt": "2024-05-21T11:45:05Z",
  • "activatedBy": "tom.sawyer@twain.com",
  • "deactivatedAt": "2024-05-21T11:45:05Z",
  • "deactivatedBy": "tom.sawyer@twain.com",
  • "termsAcceptanceStatus": "ACCEPTED",
  • "termsAcceptedAt": "2024-05-21T11:45:05Z",
  • "termsAcceptedBy": "huckleberry.finn@twain.com",
  • "termsUnacceptedAt": "2024-05-21T11:45:05Z",
  • "termsUnacceptedBy": "huckleberry.finn@twain.com",
  • "allowedCredentialTypes": [
    ],
  • "credentials": [
    ]
}

Update data pool access settings

Update data pool access settings for a specific organization.

SecurityapiKey
Request
path Parameters
dataSourceTechnicalKey
required
string (DataSourceTechnicalKey)

Data Source Technical Key.

Example: BR_RF
id
required
string (OrganizationId)

Organization ID.

Example: cdq_monitor
Request Body schema: application/json
activationStatus
string (DataSourceActivationStatus)
Default: "INACTIVE"

Whether an organization has activated a data source.

Enum: Description
ACTIVE

The data source is activated for the organization.

INACTIVE

The data source is not activated for the organization.

Example: "ACTIVE"
Array of objects (DataSourceCredential)

List of credentials.

termsAcceptanceStatus
string (schemas-TermsAcceptanceStatus)
Default: "NOT_ACCEPTED"

Whether an organization has accepted the terms of use of a data source.

Enum: Description
ACCEPTED

The terms of use of the data source are accepted by the organization.

NOT_ACCEPTED

The terms of use of the data source are not accepted by the organization.

Example: "ACCEPTED"
Responses
200

successful operation

put/organizations/{id}/globalsettings/datapoolaccesssettings/{dataSourceTechnicalKey}
Request samples
application/json
{
  • "activationStatus": "ACTIVE",
  • "termsAcceptanceStatus": "ACCEPTED",
  • "credentials": [
    ]
}
Response samples
application/json
{
  • "dataSourceSettings": [
    ]
}