Skip to content

Identity Management API (2)

Services to manage access and global configuration for CDQ Cloud Platform.

Download OpenAPI description
api-v2.json
api-v2.yaml
Languages
Servers
Production

https://api.cdq.com/identity-management/rest/

Global Settings

Manage global settings. It includes operations such as listing all data source settings for a specific organization.

Operations

Organizations

Operations

Update Data Pool Access Settings

Request

Update data pool access settings for a specific organization.

Security
apiKey
Path
idstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
dataSourceTechnicalKeystring(DataSourceTechnicalKey)required

Data Source Technical Key.

Example: BR_RF
Bodyapplication/json
activationStatusstring(DataSourceActivationStatus)

Whether an organization has activated a data source.

Default "INACTIVE"
Enum ValueDescription
ACTIVE

The data source is activated for the organization.

INACTIVE

The data source is not activated for the organization.

Example: "ACTIVE"
termsAcceptanceStatusstring(schemas-TermsAcceptanceStatus)

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

Default "NOT_ACCEPTED"
Enum ValueDescription
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"
credentialsArray of objects(DataSourceCredential)

List of credentials.

curl -i -X PUT \
  https://api.cdq.com/identity-management/rest/organizations/cdq_monitor/globalsettings/datapoolaccesssettings/BR_RF \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "activationStatus": "ACTIVE",
    "termsAcceptanceStatus": "ACCEPTED",
    "credentials": [
      {
        "type": {
          "technicalKey": "AT.FON.TID",
          "label": "API Key"
        },
        "fields": [
          {
            "type": {
              "technicalKey": "USERNAME",
              "label": "API Key",
              "type": "API Key"
            },
            "value": "********"
          }
        ]
      }
    ]
  }'

Responses

successful operation

Bodyapplication/json
dataSourceSettingsArray of objects(DataSourceSettings)

List of data source settings.

Response
application/json
{
  "dataSourceSettings": [
    { … }
  ]
}