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

Add Organization Admin

Request

Set a CDQ user as organization admin.

Security
oAuth2
Path
organizationIdstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
Bodyapplication/json
userIdstring(UserId)

Unique ID of a user.

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

Responses

successful operation

Bodyapplication/json
idstring(OrganizationAdminId)

Technical ID of an organization administrator with which the admin can be removed.

Example: "ae4d2a76-efe8-415c-8908-3fc142ffb032"
userIdstring(UserId)

Unique ID of a user.

Example: "johndoe"
userEmailstring(UserEmail)

Email address of a user.

Example: "info@cdq.ch"
firstNamestring(UserFirstName)

First name of a user.

Example: "John"
lastNamestring(UserLastName)

Last name of a user.

Example: "Doe"
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
organizationNamestring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
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"
deletedboolean(Deleted)

When true means a resource is deleted.

Example: "true"
Response
application/json
{
  "id": "ae4d2a76-efe8-415c-8908-3fc142ffb032",
  "userId": "johndoe",
  "userEmail": "info@cdq.ch",
  "firstName": "John",
  "lastName": "Doe",
  "organizationId": "cdq_monitor",
  "organizationName": "Adidas AG",
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "deletedAt": "2020-08-31T16:47+00:00",
  "deletedBy": "76248934691294444",
  "deleted": "true"
}

Switch Organization

Request

Switch to another organization.

Security
oAuth2
Path
organizationIdstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
Bodyapplication/json
object(SwitchOrganizationRequest)

Request to switch the organization of the current user.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/organizations/cdq_monitor/admins/switch \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

successful operation

Remove Admin

Request

Remove a CDQ user from organization admin.

Security
oAuth2
Path
organizationIdstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
organizationAdminIdstring(OrganizationId)required

Organization Admin ID.

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

Responses

successful operation

Read Organization Admin

Request

Read organization admin.

Security
oAuth2
Path
organizationIdstring(OrganizationId)required

Organization ID.

Example: cdq_monitor
organizationAdminIdstring(OrganizationId)required

Organization Admin ID.

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

Responses

successful operation

Bodyapplication/json
idstring(OrganizationAdminId)

Technical ID of an organization administrator with which the admin can be removed.

Example: "ae4d2a76-efe8-415c-8908-3fc142ffb032"
userIdstring(UserId)

Unique ID of a user.

Example: "johndoe"
userEmailstring(UserEmail)

Email address of a user.

Example: "info@cdq.ch"
firstNamestring(UserFirstName)

First name of a user.

Example: "John"
lastNamestring(UserLastName)

Last name of a user.

Example: "Doe"
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
organizationNamestring(OrganizationName)

Name of the organization.

Example: "Adidas AG"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
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"
deletedboolean(Deleted)

When true means a resource is deleted.

Example: "true"
Response
application/json
{
  "id": "ae4d2a76-efe8-415c-8908-3fc142ffb032",
  "userId": "johndoe",
  "userEmail": "info@cdq.ch",
  "firstName": "John",
  "lastName": "Doe",
  "organizationId": "cdq_monitor",
  "organizationName": "Adidas AG",
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "deletedAt": "2020-08-31T16:47+00:00",
  "deletedBy": "76248934691294444",
  "deleted": "true"
}

List Organization Admins

Request

List organization admins.

Security
oAuth2
Query
organizationIdstring(OrganizationId)

Organization ID.

Example: organizationId=cdq_monitor
userIdstring

User ID of the organization admin

Example: userId=5f7b1b3b-7b3b-4b3b-8b3b-7b3b1b3b7b3b
limitinteger(Limit)

Maximum number of configurations to return. Used for pagination.

Default 10
Example: limit=100
startAfterstring(StartAfter)

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

Example: startAfter=5712566172571652
featuresOnArray of strings(TransactionFeatureParam)unique

Features to be enabled.

Items Enum ValueDescription
CREATE_TRANSACTION

Creates a new transaction and makes the current request a part of it. By default, turned off.

COMMIT_TRANSACTION

Commit transaction. By default, turned off.

Example: featuresOn=CREATE_TRANSACTION
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/organizations/admins \
  -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(OrganizationAdminSearchResult)

List of organization administrators.

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

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