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

Create API Key

Request

Create a new API key for a specific workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: Bearer eyJhbGciOiJIUzI1(...)
Body
required
namestring(ApiKeyName)required

Display name of the API key.

Example: "SAP ERP"
credentialsobject(ApiKeyCredentials)

API Key credentials.

rolesArray of strings(ApiKeyRoleEnum)

List of roles assigned to the API key.

Items Enum"SYSTEM""DELEGABLE"
Example: ["SYSTEM"]
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/apikeys \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "SAP ERP",
    "credentials": {
      "clientId": "12345678-1234-5678-1234-567812345678",
      "clientSecret": "5eg879873sp0f"
    },
    "roles": [
      "SYSTEM"
    ]
  }'

Responses

successful operation

Body
idstring(ApiKeyId)

Uniquely identifying ID of the API key.

Example: "12234324324324"
namestring(ApiKeyName)

Display name of the API key.

Example: "SAP ERP"
credentialsobject(ApiKeyCredentials)

API Key credentials.

rolesArray of strings(ApiKeyRoleEnum)

Roles assigned to the API key.

Items Enum"SYSTEM""DELEGABLE"
Example: ["SYSTEM"]
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
deletedboolean

API key is deleted.

Example: "false"
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"
Response
{
  "id": "12234324324324",
  "name": "SAP ERP",
  "credentials": {
    "clientId": "12345678-1234-5678-1234-567812345678",
    "clientSecret": "5eg879873sp0f"
  },
  "roles": [
    "SYSTEM"
  ],
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "deleted": "false",
  "deletedAt": "2020-08-31T16:47+00:00",
  "deletedBy": "76248934691294444"
}

Update API Key

Request

Update an existing API key for a specific workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
idstringrequired

API Key ID or Client ID.

Example: [API Key ID: 6627bc4156b52b3295fcc0e2, Client ID: a79bbc46-070c-4016-b400-f30461ab036b]
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

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

Display name of the API key.

Example: "SAP ERP"
curl -i -X PUT \
  'https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/apikeys/[API Key ID: 6627bc4156b52b3295fcc0e2, Client ID: a79bbc46-070c-4016-b400-f30461ab036b]' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "SAP ERP"
  }'

Responses

successful operation

Bodyapplication/json
idstring(ApiKeyId)

Uniquely identifying ID of the API key.

Example: "12234324324324"
namestring(ApiKeyName)

Display name of the API key.

Example: "SAP ERP"
credentialsobject(ApiKeyCredentials)

API Key credentials.

rolesArray of strings(ApiKeyRoleEnum)

Roles assigned to the API key.

Items Enum"SYSTEM""DELEGABLE"
Example: ["SYSTEM"]
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
deletedboolean

API key is deleted.

Example: "false"
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"
Response
application/json
{
  "id": "12234324324324",
  "name": "SAP ERP",
  "credentials": {
    "clientId": "12345678-1234-5678-1234-567812345678",
    "clientSecret": "5eg879873sp0f"
  },
  "roles": [
    "SYSTEM"
  ],
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "deleted": "false",
  "deletedAt": "2020-08-31T16:47+00:00",
  "deletedBy": "76248934691294444"
}

Read API Key

Request

Read a specific API key for a specific workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
idstringrequired

API Key ID or Client ID.

Example: [API Key ID: 6627bc4156b52b3295fcc0e2, Client ID: a79bbc46-070c-4016-b400-f30461ab036b]
curl -i -X GET \
  'https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/apikeys/[API Key ID: 6627bc4156b52b3295fcc0e2, Client ID: a79bbc46-070c-4016-b400-f30461ab036b]' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
idstring(ApiKeyId)

Uniquely identifying ID of the API key.

Example: "12234324324324"
namestring(ApiKeyName)

Display name of the API key.

Example: "SAP ERP"
credentialsobject(ApiKeyCredentials)

API Key credentials.

rolesArray of strings(ApiKeyRoleEnum)

Roles assigned to the API key.

Items Enum"SYSTEM""DELEGABLE"
Example: ["SYSTEM"]
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
deletedboolean

API key is deleted.

Example: "false"
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"
Response
application/json
{
  "id": "12234324324324",
  "name": "SAP ERP",
  "credentials": {
    "clientId": "12345678-1234-5678-1234-567812345678",
    "clientSecret": "5eg879873sp0f"
  },
  "roles": [
    "SYSTEM"
  ],
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "deleted": "false",
  "deletedAt": "2020-08-31T16:47+00:00",
  "deletedBy": "76248934691294444"
}

List API Keys

Request

List all API keys for a specific workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Query
sortBystring

Filed by which the results will be sorted.

Default "CREATED_AT"
Example: sortBy=CREATED_AT
sortTypestring

Sort type.

Default "DESC"
Example: sortType=DESC
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: pageSize=100
pageinteger(Page)>= 0

Current page number.

Default 0
Example: page=1
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/apikeys \
  -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(ApiKeySearchResult)

List of API Keys.

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

Delete API Key

Request

Delete an existing API key for a specific workspace.

Security
oAuth2
Path
idstringrequired

API Key ID or Client ID.

Example: [API Key ID: 6627bc4156b52b3295fcc0e2, Client ID: a79bbc46-070c-4016-b400-f30461ab036b]
workspaceIdstring(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/apikeys/[API Key ID: 6627bc4156b52b3295fcc0e2, Client ID: a79bbc46-070c-4016-b400-f30461ab036b]' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

The resource was deleted successfully.

Generate Access Token

Request

Generate Access Token from System API key.

Security
oAuth2
Bodyapplication/jsonrequired
clientIdstring

Client ID.

Example: "a79bbc46-070c-4016-b400-f30461ab036b"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/apikeys/generateToken \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "a79bbc46-070c-4016-b400-f30461ab036b"
  }'

Responses

OK

Bodyapplication/json
accessTokenstring

Generated Access Token.

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflLxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
Response
application/json
{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflLxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

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

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