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

Maintenance

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

Operations

Resources

Operations

Find By Client ID

Request

Check if the user has permission to access the resource.

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
required
requestorIdstring(RequestorId)required

Client or User ID.

Example: "3425457z56756"
resourceIdstring(ResourceId)required

ID of the resource.

Example: "89453938475483975398"
resourceTypeTechnicalKeystring(ResourceTypeTechnicalKey)required

Technical key of the resource type.

Example: "STORAGES"
scopeTechnicalKeystring(ScopeTechnicalKey)

Technical key of a scope.

Example: "WORKSPACE:CREATE"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/resources/checkPermission \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "requestorId": "3425457z56756",
    "resourceId": "89453938475483975398",
    "resourceTypeTechnicalKey": "STORAGES",
    "scopeTechnicalKey": "WORKSPACE:CREATE"
  }'

Responses

successful operation

Body
statusstring(CheckPermissionResultStatus)
  • AUTHORIZED: The requestor is authorized for this resource * UNAUTHORIZED: The requestor is not authorized for this resource. Please check scopes and roles.
Example: "AUTHORIZED"
messagestring

Explanation of the status.

Example: "The requestor is not authorized for this resource. Please check scopes and roles."
scopesArray of objects(Scope)

List of scopes.

rolesArray of objects(Role)

List of roles.

Response
{
  "status": "AUTHORIZED",
  "message": "The requestor is not authorized for this resource. Please check scopes and roles.",
  "scopes": [
    { … }
  ],
  "roles": [
    { … }
  ]
}