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

List Data Source Settings

Request

List all data source settings for a specific organization.

Security
oAuth2
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://idp.cdq.com/_mock/apis/identity-management-api/api-v2/v2/organizations/cdq_monitor/globalsettings/datapoolaccesssettings \
  -H 'Authorization: Bearer <YOUR_TOKEN_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
oAuth2
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://idp.cdq.com/_mock/apis/identity-management-api/api-v2/v2/organizations/cdq_monitor/globalsettings/datapoolaccesssettings/BR_RF \
  -H 'Authorization: Bearer <YOUR_TOKEN_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: "2021-04-11T12:34-56:00"
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: "2021-04-11T12:34-56:00"
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: "2021-04-11T12:34-56:00"
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: "2021-04-11T12:34-56:00"
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": "2021-04-11T12:34-56:00",
  "activatedBy": "tom.sawyer@twain.com",
  "deactivatedAt": "2021-04-11T12:34-56:00",
  "deactivatedBy": "tom.sawyer@twain.com",
  "termsAcceptanceStatus": "ACCEPTED",
  "termsAcceptedAt": "2021-04-11T12:34-56:00",
  "termsAcceptedBy": "huckleberry.finn@twain.com",
  "termsUnacceptedAt": "2021-04-11T12:34-56:00",
  "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": [
    { … }
  ]
}

Read Data Source Credentials

Request

Read data source credentials for a specific organization. Endpoint only accessible for system "clients".

Security
oAuth2
Path
idstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
dataSourceTechnicalKeystring(DataSourceTechnicalKey)required

Data Source Technical Key.

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

Responses

successful operation

Bodyapplication/json
credentialsArray of objects(DataSourceCredential)

Organization-specific credentials to access a data source

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

Organizations

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

Operations

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