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
Mock server

https://developer.cdq.com/_mock/apis/identity-management-api/api-v2/

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

List Data Source Settings

Request

List all data source settings for a specific organization.

Security
apiKey
Path
idstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
Query
pageSizeinteger

Number of items per page.

Default 50
Example: pageSize=50
pageinteger

Page number.

Default 0
Example: page=0
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: Bearer eyJhbGciOiJIUzI1(...)
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/identity-management-api/api-v2/v2/organizations/cdq_monitor/globalsettings/datapoolaccesssettings \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1(...)' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(DataSourceSettings)

List of data pool access settings.

Response
application/json
{
  "page": "1",
  "pageSize": "100",
  "total": "67",
  "values": [
    { … }
  ]
}

Read Data Source Settings

Request

Read data source 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
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: Bearer eyJhbGciOiJIUzI1(...)
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/identity-management-api/api-v2/v2/organizations/cdq_monitor/globalsettings/datapoolaccesssettings/BR_RF \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1(...)' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
dataSourceobject(schemas-DataSource)

Data Source of the Data Pool.

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"
activatedAtstring(ActivatedAt)

The date when a data source was activated by a user of an organization.

Example: "2025-08-29T09:46:58Z"
activatedBystring(ActivatedBy)

The user ID of the user who activated a data source.

Example: "tom.sawyer@twain.com"
deactivatedAtstring(DeactivatedAt)

The date when a data source was deactivated by a user of an organization.

Example: "2025-08-29T09:46:58Z"
deactivatedBystring(DeactivatedBy)

The user ID of the user who deactivated a data source.

Example: "tom.sawyer@twain.com"
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"
termsAcceptedAtstring(TermsAcceptedAt)

The date when a user of an organization accepted the terms of use of a data source.

Example: "2025-08-29T09:46:58Z"
termsAcceptedBystring(TermsAcceptedBy)

The user ID of the user who accepted the terms of use of a data source.

Example: "huckleberry.finn@twain.com"
termsUnacceptedAtstring(TermsUnacceptedAt)

The date when a user of an organization revoked acceptation the terms of use of a data source.

Example: "2025-08-29T09:46:58Z"
termsUnacceptedBystring(TermsUnacceptedBy)

The user ID of the user who revoked acceptation the terms of use of a data source.

Example: "huckleberry.finn@twain.com"
licenceUrlstring(LicenceUrl)

URL that provides information on the licence of the target, see https://meta.cdq.com/Property:Has_licence_URL

Example: "https://www.cdq.ch/legal/dsc-terms-of-use"
termsTypestring(TermsType)

The type of terms of use of a data source. See https://meta.cdq.com/Property:Has_terms_type

Example: "https://meta.cdq.com/Data_source/AT.FON"
allowedCredentialTypesArray of strings(AllowedCredentialType)

Describes which credentials should be set for the data source

Example: ["BVD_CREDENTIALS"]
credentialsArray of objects(DataSourceCredential)

Organization-specific credentials to access a data source. Only masked credentials are returned.

Response
application/json
{
  "dataSource": {
    "url": "https://meta.cdq.com/Data_source/BR.RF",
    "name": "Receita Federal Brazil",
    "technicalKey": "BR_RF"
  },
  "activationStatus": "ACTIVE",
  "activatedAt": "2025-08-29T09:46:58Z",
  "activatedBy": "tom.sawyer@twain.com",
  "deactivatedAt": "2025-08-29T09:46:58Z",
  "deactivatedBy": "tom.sawyer@twain.com",
  "termsAcceptanceStatus": "ACCEPTED",
  "termsAcceptedAt": "2025-08-29T09:46:58Z",
  "termsAcceptedBy": "huckleberry.finn@twain.com",
  "termsUnacceptedAt": "2025-08-29T09:46:58Z",
  "termsUnacceptedBy": "huckleberry.finn@twain.com",
  "licenceUrl": "https://www.cdq.ch/legal/dsc-terms-of-use",
  "termsType": "https://meta.cdq.com/Data_source/AT.FON",
  "allowedCredentialTypes": [
    "BVD_CREDENTIALS"
  ],
  "credentials": [
    { … }
  ]
}

Organizations

Operations