Skip to content

Identity Management API (2)

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

Overview
Martin Ofner

martin.ofner@cdq.com

Languages
Servers
Mock server

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

Production SOAP

https://user-management-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/soap/v2/

Production

https://user-management-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/

API Keys

Manage API keys for workspaces. It includes operations such as listing all API keys for a specific workspace, creating a new API key, reading a specific API key, updating an API key, and deleting an API key.

Operations

Global Settings

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

Operations

Organizations

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

Operations

List Organizations

Request

List all organizations. Only CDQ_ADMINISTRATOR has access to this endpoint.

Security
oAuth2
Query
querystring(OrganizationName)

Search for organizations by name.

Example: query=Adidas AG
systemTagsArray of strings(Tag)

search by system tags

Example: systemTags=linkedin
limitinteger(OrganizationLimit)

Maximum number of configurations to return. Used for pagination.

Default 10
Example: limit=10
startAfterstring(StartAfter)

ID of the last configuration returned in the previous request. Used for pagination.

Example: startAfter=5712566172571652
tagsArray of strings(Tag)

Tags for grouping organizations. For example organization created via linkedin hav tag linkedin.

Example: tags=linkedin
statusstring(OrganizationStatusEnum)

Status of organization. Possible values ACTIVE | INACTIVE | DELETED

Enum"ACTIVE""INACTIVE""DELETED"
Example: status=ACTIVE
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: Bearer eyJhbGciOiJIUzI1(...)
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/v2/organizations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(OrganizationSearchResult)

List of organization administrators.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "total": "67",
  "values": [
    { … }
  ]
}

Create Organization

Request

Create a new organization.

Security
oAuth2
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: Bearer eyJhbGciOiJIUzI1(...)
Bodyapplication/json
namestring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
assignableRolesArray of strings

Assignable roles for a user.

Example: ["DATA_MIRROR_APP_USER"]
tagsArray of strings(Tag)

Tags for grouping organizations. For example organization created via linkedin hav tag linkedin.

Example: ["linkedin"]
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/v2/organizations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Adidas AG",
    "assignableRoles": [
      "DATA_MIRROR_APP_USER"
    ],
    "tags": [
      "linkedin"
    ]
  }'

Responses

successful operation

Bodyapplication/json
idstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
namestring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
assignableRolesArray of strings

Assignable roles for a user.

Example: ["DATA_MIRROR_APP_USER"]
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
statusstring(OrganizationStatusEnum)

Status of the organization.

Enum"ACTIVE""INACTIVE""DELETED"
Example: "ACTIVE"
tagsArray of strings(Tag)

Tags for grouping organizations. Tags are set by user and can be modified.

Example: ["linkedin"]
systemTagsArray of strings(Tag)

System tags for grouping organizations set by the system. System tags are not editable by users. They can be only changed by the system. Thanks to that it allows filtering organizations by properties which does not belong to Organization e.g. organizationAdmins

Example: ["linkedin"]
Response
application/json
{
  "id": "cdq_monitor",
  "name": "Adidas AG",
  "assignableRoles": [
    "DATA_MIRROR_APP_USER"
  ],
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444",
  "status": "ACTIVE",
  "tags": [
    "linkedin"
  ],
  "systemTags": [
    "linkedin"
  ]
}

Update Organization

Request

Update an existing organization.

Security
oAuth2
Path
idstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: Bearer eyJhbGciOiJIUzI1(...)
Bodyapplication/json
namestring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
assignableRolesArray of strings

Assignable roles for a user.

Example: ["DATA_MIRROR_APP_USER"]
tagsArray of strings(Tag)

Tags for grouping organizations. For example organization created via linkedin hav tag linkedin.

Example: ["linkedin"]
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/v2/organizations/cdq_monitor \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Adidas AG",
    "assignableRoles": [
      "DATA_MIRROR_APP_USER"
    ],
    "tags": [
      "linkedin"
    ]
  }'

Responses

successful operation

Bodyapplication/json
idstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
namestring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
assignableRolesArray of strings

Assignable roles for a user.

Example: ["DATA_MIRROR_APP_USER"]
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
statusstring(OrganizationStatusEnum)

Status of the organization.

Enum"ACTIVE""INACTIVE""DELETED"
Example: "ACTIVE"
tagsArray of strings(Tag)

Tags for grouping organizations. Tags are set by user and can be modified.

Example: ["linkedin"]
systemTagsArray of strings(Tag)

System tags for grouping organizations set by the system. System tags are not editable by users. They can be only changed by the system. Thanks to that it allows filtering organizations by properties which does not belong to Organization e.g. organizationAdmins

Example: ["linkedin"]
Response
application/json
{
  "id": "cdq_monitor",
  "name": "Adidas AG",
  "assignableRoles": [
    "DATA_MIRROR_APP_USER"
  ],
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444",
  "status": "ACTIVE",
  "tags": [
    "linkedin"
  ],
  "systemTags": [
    "linkedin"
  ]
}

Read Organization

Request

Read an existing organization.

Security
oAuth2
Path
idstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: Bearer eyJhbGciOiJIUzI1(...)
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/v2/organizations/cdq_monitor \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
idstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
namestring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
assignableRolesArray of strings

Assignable roles for a user.

Example: ["DATA_MIRROR_APP_USER"]
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
statusstring(OrganizationStatusEnum)

Status of the organization.

Enum"ACTIVE""INACTIVE""DELETED"
Example: "ACTIVE"
tagsArray of strings(Tag)

Tags for grouping organizations. Tags are set by user and can be modified.

Example: ["linkedin"]
systemTagsArray of strings(Tag)

System tags for grouping organizations set by the system. System tags are not editable by users. They can be only changed by the system. Thanks to that it allows filtering organizations by properties which does not belong to Organization e.g. organizationAdmins

Example: ["linkedin"]
Response
application/json
{
  "id": "cdq_monitor",
  "name": "Adidas AG",
  "assignableRoles": [
    "DATA_MIRROR_APP_USER"
  ],
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444",
  "status": "ACTIVE",
  "tags": [
    "linkedin"
  ],
  "systemTags": [
    "linkedin"
  ]
}

Create Organizational Settings

Request

Create organizational settings for a specific organization.

Security
oAuth2
Body
credentialsArray of objects(CredentialParam)

List of credentials.

dataMirrorsArray of objects(DataMirrorSettings)

List of data mirrors.

dnbStoragesArray of objects(DnbStorageSettings)

List of DNB storages.

sgwStoragesArray of objects(SgwStorageSettings)

List of SGW storages.

dataCurationRulesArray of objects(DataCurationRule)

List of data curation rules.

confirmBankAccountobject(ConfirmBankAccountSettings)

Confirm bank account settings.

searchIndexIdstring(SearchIndexId)

UUID of a Search Index.

Example: "basf-5cdcc759d9-9pz6r"
dataComplianceSettingsobject(DataComplianceSettingsParam)

Data compliance settings.

requestorsobject(RequestorsSettings)

Requestors settings.

upsertBusinessPartnerSettingsobject(UpsertBusinessPartnerSettings)

Upsert Business Partner settings.

organizationstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/organizations/settings \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "credentials": [
      {
        "username": "user",
        "password": "password",
        "baseUrl": "https://api.cdq.com/data-exchange/rest",
        "type": "AT.FON.TID"
      }
    ],
    "dataMirrors": [
      {
        "storageId": "72d6900fce6b326088f5d9d91049e3e6",
        "storage": {
          "id": "72d6900fce6b326088f5d9d91049e3e6"
        },
        "featuresOn": [
          "CATENA_X_REPLICA"
        ]
      }
    ],
    "dnbStorages": [
      {
        "type": {
          "technicalKey": "DNB_TechnicalKey"
        },
        "storageId": "72d6900fce6b326088f5d9d91049e3e6"
      }
    ],
    "sgwStorages": [
      {
        "storageId": "72d6900fce6b326088f5d9d91049e3e6"
      }
    ],
    "dataCurationRules": [
      {
        "context": {
          "country": {
            "shortName": "CH"
          }
        },
        "addressCurationLevelThreshold": "0.5",
        "outputLanguage": "en",
        "outputLanguageTechnicalKey": "en",
        "outputCharsets": [
          {
            "concept": "ISO-8859-1",
            "charset": "INTERNATIONAL"
          }
        ],
        "profile": "BUSINESS_PARTNER_ONLY",
        "featuresOn": [
          "N/A"
        ],
        "featuresOff": [
          "N/A"
        ],
        "addressDataSources": {
          "primaryAddressDataSource": {
            "technicalKey": "HERE",
            "threshold": "0.4"
          },
          "secondaryAddressDataSources": [
            {
              "technicalKey": "HERE",
              "threshold": "0.4"
            }
          ]
        },
        "numberSeparator": {
          "value": ","
        },
        "inputAddressConceptsIgnored": [
          "POST_CODE"
        ]
      }
    ],
    "confirmBankAccount": {
      "trustScoreIntervals": [
        {
          "fromNumberOfTransactions": "100",
          "toNumberOfTransactions": "100",
          "trustScore": "100"
        }
      ],
      "enableAccountOwnerVerification": "true"
    },
    "searchIndexId": "basf-5cdcc759d9-9pz6r",
    "dataComplianceSettings": {
      "disclosedDataSource": [
        {
          "technicalKey": "WATCHLIST"
        }
      ]
    },
    "requestors": {
      "vatDeRequestor": {
        "value": "ATU12345678"
      },
      "vatAtRequestor": {
        "value": "ATU12345678"
      },
      "vatEuRequestor": {
        "value": "ATU12345678"
      }
    },
    "upsertBusinessPartnerSettings": {
      "featuresOn": [
        "FEATURE"
      ]
    },
    "organization": "cdq_monitor"
  }'

Responses

successful operation

Body
credentialsArray of objects(Credential)

List of credentials.

dataMirrorsArray of objects(DataMirrorSettings)

List of data mirrors.

dnbStoragesArray of objects(DnbStorageSettings)

List of DNB storages.

sgwStoragesArray of objects(SgwStorageSettings)

List of SGW storages.

dataCurationRulesArray of objects(DataCurationRule)

List of data curation rules.

confirmBankAccountobject(ConfirmBankAccountSettings)

Confirm bank account settings.

searchIndexIdstring(SearchIndexId)

UUID of a Search Index.

Example: "basf-5cdcc759d9-9pz6r"
dataComplianceSettingsobject(DataComplianceSettings)

Data compliance settings.

requestorsobject(RequestorsSettings)

Requestors settings.

upsertBusinessPartnerSettingsobject(UpsertBusinessPartnerSettings)

Upsert Business Partner settings.

idstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
organizationstring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
Response
{
  "credentials": [
    { … }
  ],
  "dataMirrors": [
    { … }
  ],
  "dnbStorages": [
    { … }
  ],
  "sgwStorages": [
    { … }
  ],
  "dataCurationRules": [
    { … }
  ],
  "confirmBankAccount": {
    "trustScoreIntervals": [ … ],
    "enableAccountOwnerVerification": "true"
  },
  "searchIndexId": "basf-5cdcc759d9-9pz6r",
  "dataComplianceSettings": {
    "disclosedDataSource": [ … ]
  },
  "requestors": {
    "vatDeRequestor": { … },
    "vatAtRequestor": { … },
    "vatEuRequestor": { … }
  },
  "upsertBusinessPartnerSettings": {
    "featuresOn": [ … ]
  },
  "id": "cdq_monitor",
  "organization": "Adidas AG"
}

Register Organization

Request

Register a new organization. This endpoint is public and used for self registration. This endpoint is available only on request. Contact support@cdq.com to get access to that endpoint.

Security
oAuth2
Bodyapplication/json
namestring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
organizationUserobject(OrganizationRegistrationUser)

Organization registration user.

dataMirrorobject(OrganizationRegistrationDataMirror)

Data Mirror for organization registration.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/organizations/register \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Adidas AG",
    "organizationUser": {
      "email": "info@cdq.ch",
      "password": "password"
    },
    "dataMirror": {
      "labels": [
        "label"
      ]
    }
  }'

Responses

successful operation

Bodyapplication/json
organizationobject(OrganizationRegistrationOrganization)

Organization registration organization.

apiKeyobject(OrganizationRegistrationApiKey)

Organization registration api key.

workspaceobject(OrganizationRegistrationWorkspace)

Organization registration workspace.

Response
application/json
{
  "organization": {
    "id": "cdq_monitor",
    "name": "Adidas AG"
  },
  "apiKey": {
    "base64": "YXBpS2V5OmFwaUtleQ=="
  },
  "workspace": {
    "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "name": "This is a workspace.",
    "dataMirror": { … }
  }
}

Deactivate Organization

Request

Deactivate an existing organization.

Security
oAuth2
Path
idstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
Bodyapplication/jsonrequired
retentionDaysinteger

Retention period for organization data and users in days.

Default 90
Example: 30
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/organizations/cdq_monitor/deactivate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "retentionDays": 30
  }'

Responses

The resource was deactivated successfully.

Restore Organization

Request

Restore inactive organization. Only CDQ_ADMINISTRATOR has access to this endpoint.

Security
oAuth2
Path
idstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/organizations/cdq_monitor/restore \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The resource was activated successfully.

Update Organizational Settings

Request

Update an existing organizational settings.

Security
oAuth2
Path
idstringrequired

Organizational settings ID.

Example: c074b9f3-abf0-4f8e-9a20-75deb6cfa2a4
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Body
credentialsArray of objects(CredentialParam)

List of credentials.

dataMirrorsArray of objects(DataMirrorSettings)

List of data mirrors.

dnbStoragesArray of objects(DnbStorageSettings)

List of DNB storages.

sgwStoragesArray of objects(SgwStorageSettings)

List of SGW storages.

dataCurationRulesArray of objects(DataCurationRule)

List of data curation rules.

confirmBankAccountobject(ConfirmBankAccountSettings)

Confirm bank account settings.

searchIndexIdstring(SearchIndexId)

UUID of a Search Index.

Example: "basf-5cdcc759d9-9pz6r"
dataComplianceSettingsobject(DataComplianceSettingsParam)

Data compliance settings.

requestorsobject(RequestorsSettings)

Requestors settings.

upsertBusinessPartnerSettingsobject(UpsertBusinessPartnerSettings)

Upsert Business Partner settings.

curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/organizations/settings/c074b9f3-abf0-4f8e-9a20-75deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "credentials": [
      {
        "username": "user",
        "password": "password",
        "baseUrl": "https://api.cdq.com/data-exchange/rest",
        "type": "AT.FON.TID"
      }
    ],
    "dataMirrors": [
      {
        "storageId": "72d6900fce6b326088f5d9d91049e3e6",
        "storage": {
          "id": "72d6900fce6b326088f5d9d91049e3e6"
        },
        "featuresOn": [
          "CATENA_X_REPLICA"
        ]
      }
    ],
    "dnbStorages": [
      {
        "type": {
          "technicalKey": "DNB_TechnicalKey"
        },
        "storageId": "72d6900fce6b326088f5d9d91049e3e6"
      }
    ],
    "sgwStorages": [
      {
        "storageId": "72d6900fce6b326088f5d9d91049e3e6"
      }
    ],
    "dataCurationRules": [
      {
        "context": {
          "country": {
            "shortName": "CH"
          }
        },
        "addressCurationLevelThreshold": "0.5",
        "outputLanguage": "en",
        "outputLanguageTechnicalKey": "en",
        "outputCharsets": [
          {
            "concept": "ISO-8859-1",
            "charset": "INTERNATIONAL"
          }
        ],
        "profile": "BUSINESS_PARTNER_ONLY",
        "featuresOn": [
          "N/A"
        ],
        "featuresOff": [
          "N/A"
        ],
        "addressDataSources": {
          "primaryAddressDataSource": {
            "technicalKey": "HERE",
            "threshold": "0.4"
          },
          "secondaryAddressDataSources": [
            {
              "technicalKey": "HERE",
              "threshold": "0.4"
            }
          ]
        },
        "numberSeparator": {
          "value": ","
        },
        "inputAddressConceptsIgnored": [
          "POST_CODE"
        ]
      }
    ],
    "confirmBankAccount": {
      "trustScoreIntervals": [
        {
          "fromNumberOfTransactions": "100",
          "toNumberOfTransactions": "100",
          "trustScore": "100"
        }
      ],
      "enableAccountOwnerVerification": "true"
    },
    "searchIndexId": "basf-5cdcc759d9-9pz6r",
    "dataComplianceSettings": {
      "disclosedDataSource": [
        {
          "technicalKey": "WATCHLIST"
        }
      ]
    },
    "requestors": {
      "vatDeRequestor": {
        "value": "ATU12345678"
      },
      "vatAtRequestor": {
        "value": "ATU12345678"
      },
      "vatEuRequestor": {
        "value": "ATU12345678"
      }
    },
    "upsertBusinessPartnerSettings": {
      "featuresOn": [
        "FEATURE"
      ]
    }
  }'

Responses

successful operation

Body
credentialsArray of objects(Credential)

List of credentials.

dataMirrorsArray of objects(DataMirrorSettings)

List of data mirrors.

dnbStoragesArray of objects(DnbStorageSettings)

List of DNB storages.

sgwStoragesArray of objects(SgwStorageSettings)

List of SGW storages.

dataCurationRulesArray of objects(DataCurationRule)

List of data curation rules.

confirmBankAccountobject(ConfirmBankAccountSettings)

Confirm bank account settings.

searchIndexIdstring(SearchIndexId)

UUID of a Search Index.

Example: "basf-5cdcc759d9-9pz6r"
dataComplianceSettingsobject(DataComplianceSettings)

Data compliance settings.

requestorsobject(RequestorsSettings)

Requestors settings.

upsertBusinessPartnerSettingsobject(UpsertBusinessPartnerSettings)

Upsert Business Partner settings.

idstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
organizationstring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
Response
{
  "credentials": [
    { … }
  ],
  "dataMirrors": [
    { … }
  ],
  "dnbStorages": [
    { … }
  ],
  "sgwStorages": [
    { … }
  ],
  "dataCurationRules": [
    { … }
  ],
  "confirmBankAccount": {
    "trustScoreIntervals": [ … ],
    "enableAccountOwnerVerification": "true"
  },
  "searchIndexId": "basf-5cdcc759d9-9pz6r",
  "dataComplianceSettings": {
    "disclosedDataSource": [ … ]
  },
  "requestors": {
    "vatDeRequestor": { … },
    "vatAtRequestor": { … },
    "vatEuRequestor": { … }
  },
  "upsertBusinessPartnerSettings": {
    "featuresOn": [ … ]
  },
  "id": "cdq_monitor",
  "organization": "Adidas AG"
}

Update Specific Fields

Request

Update only specific fields of an existing organizational settings.

Security
oAuth2
Path
idstringrequired

Organizational settings ID.

Example: c074b9f3-abf0-4f8e-9a20-75deb6cfa2a4
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Body
credentialsArray of objects(CredentialParam)

List of credentials.

dataMirrorsArray of objects(DataMirrorSettings)

List of data mirrors.

dnbStoragesArray of objects(DnbStorageSettings)

List of DNB storages.

sgwStoragesArray of objects(SgwStorageSettings)

List of SGW storages.

dataCurationRulesArray of objects(DataCurationRule)

List of data curation rules.

confirmBankAccountobject(ConfirmBankAccountSettings)

Confirm bank account settings.

searchIndexIdstring(SearchIndexId)

UUID of a Search Index.

Example: "basf-5cdcc759d9-9pz6r"
dataComplianceSettingsobject(DataComplianceSettingsParam)

Data compliance settings.

requestorsobject(RequestorsSettings)

Requestors settings.

upsertBusinessPartnerSettingsobject(UpsertBusinessPartnerSettings)

Upsert Business Partner settings.

curl -i -X PATCH \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/organizations/settings/c074b9f3-abf0-4f8e-9a20-75deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "credentials": [
      {
        "username": "user",
        "password": "password",
        "baseUrl": "https://api.cdq.com/data-exchange/rest",
        "type": "AT.FON.TID"
      }
    ],
    "dataMirrors": [
      {
        "storageId": "72d6900fce6b326088f5d9d91049e3e6",
        "storage": {
          "id": "72d6900fce6b326088f5d9d91049e3e6"
        },
        "featuresOn": [
          "CATENA_X_REPLICA"
        ]
      }
    ],
    "dnbStorages": [
      {
        "type": {
          "technicalKey": "DNB_TechnicalKey"
        },
        "storageId": "72d6900fce6b326088f5d9d91049e3e6"
      }
    ],
    "sgwStorages": [
      {
        "storageId": "72d6900fce6b326088f5d9d91049e3e6"
      }
    ],
    "dataCurationRules": [
      {
        "context": {
          "country": {
            "shortName": "CH"
          }
        },
        "addressCurationLevelThreshold": "0.5",
        "outputLanguage": "en",
        "outputLanguageTechnicalKey": "en",
        "outputCharsets": [
          {
            "concept": "ISO-8859-1",
            "charset": "INTERNATIONAL"
          }
        ],
        "profile": "BUSINESS_PARTNER_ONLY",
        "featuresOn": [
          "N/A"
        ],
        "featuresOff": [
          "N/A"
        ],
        "addressDataSources": {
          "primaryAddressDataSource": {
            "technicalKey": "HERE",
            "threshold": "0.4"
          },
          "secondaryAddressDataSources": [
            {
              "technicalKey": "HERE",
              "threshold": "0.4"
            }
          ]
        },
        "numberSeparator": {
          "value": ","
        },
        "inputAddressConceptsIgnored": [
          "POST_CODE"
        ]
      }
    ],
    "confirmBankAccount": {
      "trustScoreIntervals": [
        {
          "fromNumberOfTransactions": "100",
          "toNumberOfTransactions": "100",
          "trustScore": "100"
        }
      ],
      "enableAccountOwnerVerification": "true"
    },
    "searchIndexId": "basf-5cdcc759d9-9pz6r",
    "dataComplianceSettings": {
      "disclosedDataSource": [
        {
          "technicalKey": "WATCHLIST"
        }
      ]
    },
    "requestors": {
      "vatDeRequestor": {
        "value": "ATU12345678"
      },
      "vatAtRequestor": {
        "value": "ATU12345678"
      },
      "vatEuRequestor": {
        "value": "ATU12345678"
      }
    },
    "upsertBusinessPartnerSettings": {
      "featuresOn": [
        "FEATURE"
      ]
    }
  }'

Responses

successful operation

Body
credentialsArray of objects(Credential)

List of credentials.

dataMirrorsArray of objects(DataMirrorSettings)

List of data mirrors.

dnbStoragesArray of objects(DnbStorageSettings)

List of DNB storages.

sgwStoragesArray of objects(SgwStorageSettings)

List of SGW storages.

dataCurationRulesArray of objects(DataCurationRule)

List of data curation rules.

confirmBankAccountobject(ConfirmBankAccountSettings)

Confirm bank account settings.

searchIndexIdstring(SearchIndexId)

UUID of a Search Index.

Example: "basf-5cdcc759d9-9pz6r"
dataComplianceSettingsobject(DataComplianceSettings)

Data compliance settings.

requestorsobject(RequestorsSettings)

Requestors settings.

upsertBusinessPartnerSettingsobject(UpsertBusinessPartnerSettings)

Upsert Business Partner settings.

idstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
organizationstring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
Response
{
  "credentials": [
    { … }
  ],
  "dataMirrors": [
    { … }
  ],
  "dnbStorages": [
    { … }
  ],
  "sgwStorages": [
    { … }
  ],
  "dataCurationRules": [
    { … }
  ],
  "confirmBankAccount": {
    "trustScoreIntervals": [ … ],
    "enableAccountOwnerVerification": "true"
  },
  "searchIndexId": "basf-5cdcc759d9-9pz6r",
  "dataComplianceSettings": {
    "disclosedDataSource": [ … ]
  },
  "requestors": {
    "vatDeRequestor": { … },
    "vatAtRequestor": { … },
    "vatEuRequestor": { … }
  },
  "upsertBusinessPartnerSettings": {
    "featuresOn": [ … ]
  },
  "id": "cdq_monitor",
  "organization": "Adidas AG"
}

Update Data Pool Access Settings

Request

Update data pool access settings for a specific organization.

Security
oAuth2
Path
idstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
dataSourceTechnicalKeystring(DataSourceTechnicalKey)required

Data Source Technical Key.

Example: BR_RF
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
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://idp.cdq.com/_mock/apis/identity-management-api/api-v2/organizations/cdq_monitor/globalsettings/datapoolaccesssettings/BR_RF \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -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": [
    { … }
  ]
}

List Organizational SettingsDeprecated

Request

Find organizational settings by user ID, organization name, or features.

Security
oAuth2
Query
userIdstring(UserId)

Find organizational settings by user ID.

Example: userId=johndoe
credentialTypestring(CredentialType)

Search for organizational settings by organization name.

Enum ValueDescription
AT.FON.TID

Austrian tax identification number.

AT.FON.BENID

Austrian beneficiary identification number.

EU_VAT_ID_AT

Austrian VAT identification number.

BZST

German Federal Central Tax Office.

NL.BR

Dutch Chamber of Commerce.

DNB

Duns & Bradstreet data source.

DNB_MASTER_DATA_BASIC

Duns & Bradstreet master data basic.

DNB_MASTER_DATA_EXTENDED

Duns & Bradstreet master data extended.

DNB_LNKELI

Duns & Bradstreet LNKELI.

SGW

Swiss government.

Example: credentialType=AT.FON.TID
organizationstring(OrganizationName)

Search for organizational settings by organization name.

Example: organization=Adidas AG
pageSizeinteger

Number of items per page.

Default 50
Example: pageSize=50
pageinteger

Page number.

Default 0
Example: page=0
featuresOnArray of strings(SettingsFeature)

Features to be activated.

Items ValueDescription
MASK_CREDENTIALS

Mask credentials.

Example: featuresOn=MASK_CREDENTIALS
featuresOffArray of strings(SettingsFeature)

Features to be deactivated.

Items ValueDescription
MASK_CREDENTIALS

Mask credentials.

Example: featuresOff=MASK_CREDENTIALS
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/organizations/settings \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

successful operation

Body
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(OrganizationalSettings)

List of organizational settings.

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

Organization Admins

Manage organization admins. It includes operations such as creating a new organization administrator, switching the organization of the current user, and managing organization administrators.

Operations

Organization Resource Quotas

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

Operations

Product Packages

Manage product packages. It includes operations such as retrieving all product packages.

Quotas

Manage quotas. It includes operations such as upserting quotas and reading quotas.

Operations

Settings

Manage settings. It includes operations such as finding effective settings, managing organizational settings, and managing workspace settings.

Operations

Token Exchange

Manage token exchange. It includes operations such as exchanging an access token.

Operations

Users

Manage users. It includes operations such as listing users, creating a new user, reading specific user details, updating a user, and deleting a user.

Operations

Workspace Configurations

Manage workspace configurations. It includes operations such as creating a new workspace configuration, reading workspace configurations, updating workspace configurations, and deleting workspace configurations.

Operations

Workspaces

Manage workspaces. It includes operations such as listing all workspaces, creating a new workspace, reading specific workspace details, updating a workspace, and deleting a workspace.

Operations

Workspace Resource Quotas

Manage workspace resource quotas. It includes operations such as listing all workspace resource quotas, creating a new workspace resource quota, reading specific workspace resource quota details, updating a workspace resource quota, and deleting a workspace resource quota.

Operations

Maintenance

Maintenance operations. It includes operations such as cleaning up linked test users.

Operations

Resources

Operations