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

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

List Workspace Resource Quotas

Request

Get all quota for resource in workspace.

Security
oAuth2
Query
workspaceIdstring(WorkspaceId)

Workspace ID.

Example: workspaceId=c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
limitinteger(schemas-Limit)

Maximum number of configurations to return. Used for pagination.

Example: limit=100
startAfterstring(StartAfter)

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

Example: startAfter=5712566172571652
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/quotas/resources/workspaces \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

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(WorkspaceResourceQuotaSearchResult)

List of organization resource quotas.

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

Create Workspace Resource Quotas

Request

Creates quota for resource in workspace.

Security
oAuth2
Bodyapplication/json
workspaceIdstring(WorkspaceId)required

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
quotainteger(ResourceQuota)

Quota.

Example: "1"
resourceobject(WorkspaceResourceQuotaResourceItem)required

Workspace resource quota resource item.

resource.​technicalKeystring(WorkspaceQuotaResourceTechnicalKey)required

Workspace quota resource technical key enum. This can be any technical key of a configuration type or an API_KEYS. The value is not checked. If the technical key is wrongly set then quota will not be enforced.

Example: "API_KEYS"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/quotas/resources/workspaces \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "quota": "1",
    "resource": {
      "technicalKey": "API_KEYS"
    }
  }'

Responses

OK

Bodyapplication/json
idstring(WorkspaceResourceQuotaId)

Workspace resource quota ID.

Example: "6633348b2b5f2b772013eb91"
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
quotainteger(ResourceQuota)

Quota.

Example: "1"
usageinteger(QuotaUsage)

The current usage of a quota.

Example: "1"
resourceobject(WorkspaceResourceQuotaResourceItem)

Workspace resource quota resource item.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "6633348b2b5f2b772013eb91",
  "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "quota": "1",
  "usage": "1",
  "resource": {
    "technicalKey": "API_KEYS"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444"
}

Read Workspace Resource Quotas

Request

Get quota for resource in workspace by Id.

Security
oAuth2
Path
idstring(WorkspaceResourceQuotaId)required

ID of the workspace resource quota.

Example: 6633348b2b5f2b772013eb91
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/quotas/resources/workspaces/6633348b2b5f2b772013eb91 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idstring(WorkspaceResourceQuotaId)

Workspace resource quota ID.

Example: "6633348b2b5f2b772013eb91"
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
quotainteger(ResourceQuota)

Quota.

Example: "1"
usageinteger(QuotaUsage)

The current usage of a quota.

Example: "1"
resourceobject(WorkspaceResourceQuotaResourceItem)

Workspace resource quota resource item.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "6633348b2b5f2b772013eb91",
  "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "quota": "1",
  "usage": "1",
  "resource": {
    "technicalKey": "API_KEYS"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444"
}

Update Workspace Resource Quotas

Request

Update quota for resource in workspace by Id.

Security
oAuth2
Path
idstring(WorkspaceResourceQuotaId)required

ID of the workspace resource quota.

Example: 6633348b2b5f2b772013eb91
Bodyapplication/json
quotainteger(ResourceQuota)

Quota.

Example: "1"
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/quotas/resources/workspaces/6633348b2b5f2b772013eb91 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "quota": "1"
  }'

Responses

OK

Bodyapplication/json
idstring(WorkspaceResourceQuotaId)

Workspace resource quota ID.

Example: "6633348b2b5f2b772013eb91"
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
quotainteger(ResourceQuota)

Quota.

Example: "1"
usageinteger(QuotaUsage)

The current usage of a quota.

Example: "1"
resourceobject(WorkspaceResourceQuotaResourceItem)

Workspace resource quota resource item.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "6633348b2b5f2b772013eb91",
  "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "quota": "1",
  "usage": "1",
  "resource": {
    "technicalKey": "API_KEYS"
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444"
}

Delete Workspace Resource Quotas

Request

deleted quota for resource in workspace.

Security
oAuth2
Path
idstring(WorkspaceResourceQuotaId)required

ID of the workspace resource quota.

Example: 6633348b2b5f2b772013eb91
curl -i -X DELETE \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/quotas/resources/workspaces/6633348b2b5f2b772013eb91 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The resource was deleted successfully.

Maintenance

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

Operations

Resources

Operations