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

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

Read Workspace

Request

Read a specific workspace.

Security
oAuth2
Path
idstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
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/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

successful operation

Body
idstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(WorkspaceName)

Display name of the workspace.

Example: "This is a workspace."
organizationobject(WorkspaceOrganization)

Organization of the workspace.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
deletedboolean(Deleted)

When true means a resource is deleted.

Example: "true"
deletedAtstring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
deletedBystring(DeletedBy)

Id of identity which deleted a resource.

Example: "76248934691294444"
apiKeysArray of objects(ApiKey)

List of API keys.

configurationsobject(WorkspaceConfigurations)

Workspace configurations.

settingsobject(WorkspaceSettings)

Workspace settings.

typestring(WorkspaceTypeEnum)

Workspace type.

Enum"PRODUCTION""SANDBOX"
Example: "PRODUCTION"
defaultWorkspaceboolean(DefaultWorkspace)

Is this workspace a default workspace for the organization.

Example: "false"
Response
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "This is a workspace.",
  "organization": {
    "id": "cdq_monitor"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "deleted": "true",
  "deletedAt": "2020-08-31T16:47+00:00",
  "deletedBy": "76248934691294444",
  "apiKeys": [
    { … }
  ],
  "configurations": {
    "workspaceConfigurations": [ … ]
  },
  "settings": {
    "dataMirrorSettings": { … },
    "summaryMailSettings": { … }
  },
  "type": "PRODUCTION",
  "defaultWorkspace": "false"
}

Update Workspace

Request

Update an existing workspace.

Security
oAuth2
Path
idstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
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
namestring(WorkspaceName)

Display name of the workspace.

Example: "This is a workspace."
settingsobject(WorkspaceSettings)

Workspace settings.

typestring(WorkspaceTypeEnum)

Workspace type.

Enum"PRODUCTION""SANDBOX"
Example: "PRODUCTION"
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "name": "This is a workspace.",
    "settings": {
      "dataMirrorSettings": {
        "storageId": "72d6900fce6b326088f5d9d91049e3e6",
        "storage": {
          "id": "72d6900fce6b326088f5d9d91049e3e6"
        },
        "featuresOn": [
          "CATENA_X_REPLICA"
        ]
      },
      "summaryMailSettings": {
        "enabled": "true",
        "frequency": "BI-WEEKLY"
      }
    },
    "type": "PRODUCTION"
  }'

Responses

successful operation

Body
idstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(WorkspaceName)

Display name of the workspace.

Example: "This is a workspace."
organizationobject(WorkspaceOrganization)

Organization of the workspace.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
deletedboolean(Deleted)

When true means a resource is deleted.

Example: "true"
deletedAtstring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
deletedBystring(DeletedBy)

Id of identity which deleted a resource.

Example: "76248934691294444"
apiKeysArray of objects(ApiKey)

List of API keys.

configurationsobject(WorkspaceConfigurations)

Workspace configurations.

settingsobject(WorkspaceSettings)

Workspace settings.

typestring(WorkspaceTypeEnum)

Workspace type.

Enum"PRODUCTION""SANDBOX"
Example: "PRODUCTION"
defaultWorkspaceboolean(DefaultWorkspace)

Is this workspace a default workspace for the organization.

Example: "false"
Response
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "This is a workspace.",
  "organization": {
    "id": "cdq_monitor"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "deleted": "true",
  "deletedAt": "2020-08-31T16:47+00:00",
  "deletedBy": "76248934691294444",
  "apiKeys": [
    { … }
  ],
  "configurations": {
    "workspaceConfigurations": [ … ]
  },
  "settings": {
    "dataMirrorSettings": { … },
    "summaryMailSettings": { … }
  },
  "type": "PRODUCTION",
  "defaultWorkspace": "false"
}

Delete Workspaces

Request

Deletes Workspaces and related configurations and API keys.

Security
oAuth2
Path
idstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
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 DELETE \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

The resource was deleted successfully.

List Workspaces

Request

List all workspaces you are owner or member of.

Security
oAuth2
Query
pageSizeinteger

Number of items per page.

Default 50
Example: pageSize=50
pageinteger

Page number.

Default 0
Example: page=0
defaultWorkspaceboolean(DefaultWorkspace)

Default workspace ID.

Example: defaultWorkspace=false
sortBystring

Filed by which the results will be sorted.

Default "CREATED_AT"
Example: sortBy=CREATED_AT
sortTypestring

Sort type.

Default "DESC"
Example: sortType=DESC
organizationIdstring(OrganizationId)Deprecated

Filed should not be used anymore.

Example: organizationId=cdq_monitor
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/workspaces \
  -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(WorkspaceSearchResult)

List of workspaces search results.

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

Create Workspace

Request

Create a new workspace.

Security
oAuth2
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
organizationIdstring(OrganizationId)required

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
namestring(WorkspaceName)required

Display name of the workspace.

Example: "This is a workspace."
dataMirrorIdstring(BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
typestring(WorkspaceTypeEnum)

Workspace type.

Enum"PRODUCTION""SANDBOX"
Example: "PRODUCTION"
dataMirrorNamestring<= 50 charactersDeprecated

This filed is ignored. Please set it as empty. Has no impact on the workspace creation.

Example: "Company Data Mirror"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "organizationId": "cdq_monitor",
    "name": "This is a workspace.",
    "dataMirrorId": "72d6900fce6b326088f5d9d91049e3e6",
    "dataMirrorName": "Company Data Mirror",
    "type": "PRODUCTION"
  }'

Responses

successful operation

Body
idstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(WorkspaceName)

Display name of the workspace.

Example: "This is a workspace."
organizationobject(WorkspaceOrganization)

Organization of the workspace.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
deletedboolean(Deleted)

When true means a resource is deleted.

Example: "true"
deletedAtstring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
deletedBystring(DeletedBy)

Id of identity which deleted a resource.

Example: "76248934691294444"
apiKeysArray of objects(ApiKey)

List of API keys.

configurationsobject(WorkspaceConfigurations)

Workspace configurations.

settingsobject(WorkspaceSettings)

Workspace settings.

typestring(WorkspaceTypeEnum)

Workspace type.

Enum"PRODUCTION""SANDBOX"
Example: "PRODUCTION"
defaultWorkspaceboolean(DefaultWorkspace)

Is this workspace a default workspace for the organization.

Example: "false"
Response
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "This is a workspace.",
  "organization": {
    "id": "cdq_monitor"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "deleted": "true",
  "deletedAt": "2020-08-31T16:47+00:00",
  "deletedBy": "76248934691294444",
  "apiKeys": [
    { … }
  ],
  "configurations": {
    "workspaceConfigurations": [ … ]
  },
  "settings": {
    "dataMirrorSettings": { … },
    "summaryMailSettings": { … }
  },
  "type": "PRODUCTION",
  "defaultWorkspace": "false"
}

Add User

Request

Add a new user to the workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Bodyapplication/jsonrequired
userIdstring(UserId)required

Unique ID of a user.

Example: "johndoe"
rolestring(WorkspaceRoleEnum)required

Workspace role enum.

Enum ValueDescription
ADMIN

Admin role.

EDITOR

Editor role.

VIEWER

Viewer role.

Example: "VIEWER"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/members \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "johndoe",
    "role": "VIEWER"
  }'

Responses

successful operation

Bodyapplication/json
userIdstring(UserId)

Unique ID of a user.

Example: "johndoe"
rolestring(WorkspaceRoleEnum)

Workspace role enum.

Enum ValueDescription
ADMIN

Admin role.

EDITOR

Editor role.

VIEWER

Viewer role.

Example: "VIEWER"
Response
application/json
{
  "userId": "johndoe",
  "role": "VIEWER"
}

List Users

Request

List all users in the workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/members \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/jsonArray [
userIdstring(UserId)

Unique ID of a user.

Example: "johndoe"
rolestring(WorkspaceRole)

Workspace role.

Example: "VIEWER"
firstNamestring(UserFirstName)

First name of a user.

Example: "John"
lastNamestring(UserLastName)

Last name of a user.

Example: "Doe"
emailstring(UserEmail)

Email address of a user.

Example: "info@cdq.ch"
]
Response
application/json
[
  {
    "userId": "johndoe",
    "role": "VIEWER",
    "firstName": "John",
    "lastName": "Doe",
    "email": "info@cdq.ch"
  }
]

Edit User

Request

Edit a user in the workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
userIdstring(UserId)required

User ID.

Example: johndoe
Bodyapplication/jsonrequired
rolestring(WorkspaceRoleEnum)required

Workspace role enum.

Enum ValueDescription
ADMIN

Admin role.

EDITOR

Editor role.

VIEWER

Viewer role.

Example: "VIEWER"
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/members/johndoe \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "role": "VIEWER"
  }'

Responses

successful operation

Bodyapplication/json
userIdstring(UserId)

Unique ID of a user.

Example: "johndoe"
rolestring(WorkspaceRoleEnum)

Workspace role enum.

Enum ValueDescription
ADMIN

Admin role.

EDITOR

Editor role.

VIEWER

Viewer role.

Example: "VIEWER"
Response
application/json
{
  "userId": "johndoe",
  "role": "VIEWER"
}

Delete user from the Workspace

Request

Delete a user from the workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
userIdstring(UserId)required

User ID.

Example: johndoe
curl -i -X DELETE \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/members/johndoe \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Switch Workspace

Request

Switch to another workspace.

Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: Bearer eyJhbGciOiJIUzI1(...)
Bodyapplication/json
requestedWorkspaceIdstringrequired

The workspaceId to which the user will switch.

Example: "a79bbc46-070c-4016-b400-f30461ab036b"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/switch \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1(...)' \
  -H 'Content-Type: application/json' \
  -d '{
    "requestedWorkspaceId": "a79bbc46-070c-4016-b400-f30461ab036b"
  }'

Responses

successful switch

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