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

Create Workspace Configuration

Request

Create a new configuration for a specific workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Bodyapplication/json
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
featuresOnArray of strings(TransactionFeaturesOn)

Features to be enabled.

  • 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. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.
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: ["CREATE_TRANSACTION"]
namestring(WorkspaceConfigurationName)

The name of the configuration.

Example: "MyConfiguration"
configurationobject(WorkspaceConfigurationContent)

Configuration content. Depending on the domain the content can be different.

typeobject(WorkspaceConfigurationType)required

Configuration type.

type.​namestring

Display name of the configuration type. Always null.

Example: "null"
type.​technicalKeystring

Type of the workspace configuration. Must be written in SCREAMING_SNAKE_CASE.

Example: "BUSINESS_PARTNER_LOOKUP"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
relatedConfigurationsArray of objects(RelatedConfiguration)<= 10 items

List of related configurations.

copiedFromobject(WorkspaceConfigurationCopiedFrom)

The configuration from which the new configuration is copied.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/configurations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "name": "MyConfiguration",
    "configuration": {},
    "type": {
      "name": "null",
      "technicalKey": "BUSINESS_PARTNER_LOOKUP"
    },
    "defaultConfiguration": true,
    "relatedConfigurations": [
      {
        "id": "a0200062daa56952a8640005",
        "owner": {
          "service": "reference-data-api",
          "path": "/public/configurations/businesspartnerlookup"
        }
      }
    ],
    "copiedFrom": {
      "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
      "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
    }
  }'

Responses

successful operation

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

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

The name of the configuration.

Example: "MyConfiguration"
versioninteger(WorkspaceConfigurationVersionNumber)

Version number of a configuration.

Example: 1
configurationobject(WorkspaceConfigurationContent)

Configuration content. Depending on the domain the content can be different.

typeobject(WorkspaceConfigurationType)

Configuration type.

relatedConfigurationsArray of objects(RelatedConfiguration)

List of related configurations.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "MyConfiguration",
  "version": 1,
  "configuration": {},
  "type": {
    "name": "null",
    "technicalKey": "BUSINESS_PARTNER_LOOKUP"
  },
  "relatedConfigurations": [
    { … }
  ],
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444",
  "defaultConfiguration": true,
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

List Workspace Configurations

Request

List all configurations for a specific workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

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

Number of items per page.

Default 50
Example: pageSize=50
pageinteger

Page number.

Default 0
Example: page=0
configurationOwnerstring(UserId)

Owner of the configuration.

Example: configurationOwner=johndoe
technicalKeystring

Technical Key for the configuration.

Example: technicalKey=lookupconfiguration
sortBystring

Filed by which the results will be sorted.

Default "CREATED_AT"
Example: sortBy=CREATED_AT
sortTypestring

Sort type.

Default "DESC"
Example: sortType=DESC
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Default configuration.

Example: defaultConfiguration=true
clientIdstring(ClientId)

API Key ID or Client ID. When present returns only configurations assigned to the given API key.

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

Responses

successful operation

Bodyapplication/json
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(WorkspaceConfiguration)

List of workspace configurations.

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

Read Workspace Configuration

Request

Read a specific configuration for a specific workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
configurationIdstring(ConfigurationId)required

Workspace Configuration 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/configurations/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

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

The name of the configuration.

Example: "MyConfiguration"
versioninteger(WorkspaceConfigurationVersionNumber)

Version number of a configuration.

Example: 1
configurationobject(WorkspaceConfigurationContent)

Configuration content. Depending on the domain the content can be different.

typeobject(WorkspaceConfigurationType)

Configuration type.

relatedConfigurationsArray of objects(RelatedConfiguration)

List of related configurations.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "MyConfiguration",
  "version": 1,
  "configuration": {},
  "type": {
    "name": "null",
    "technicalKey": "BUSINESS_PARTNER_LOOKUP"
  },
  "relatedConfigurations": [
    { … }
  ],
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444",
  "defaultConfiguration": true,
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Update Workspace Configurations

Request

Update an existing configuration for a specific workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
configurationIdstring(ConfigurationId)required

Workspace Configuration ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Bodyapplication/json
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
featuresOnArray of strings(TransactionFeaturesOn)

Features to be enabled.

  • 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. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.
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: ["CREATE_TRANSACTION"]
namestring(WorkspaceConfigurationName)

The name of the configuration.

Example: "MyConfiguration"
configurationobject(WorkspaceConfigurationContent)

Configuration content. Depending on the domain the content can be different.

defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/configurations/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "name": "MyConfiguration",
    "configuration": {},
    "defaultConfiguration": true
  }'

Responses

successful operation

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

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

The name of the configuration.

Example: "MyConfiguration"
versioninteger(WorkspaceConfigurationVersionNumber)

Version number of a configuration.

Example: 1
configurationobject(WorkspaceConfigurationContent)

Configuration content. Depending on the domain the content can be different.

typeobject(WorkspaceConfigurationType)

Configuration type.

relatedConfigurationsArray of objects(RelatedConfiguration)

List of related configurations.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "MyConfiguration",
  "version": 1,
  "configuration": {},
  "type": {
    "name": "null",
    "technicalKey": "BUSINESS_PARTNER_LOOKUP"
  },
  "relatedConfigurations": [
    { … }
  ],
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444",
  "defaultConfiguration": true,
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Delete Workspace Configurations

Request

Delete an existing configuration for a specific workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
configurationIdstring(ConfigurationId)required

Workspace Configuration ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Query
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: transactionId=8e37da1e-ee9d-4ee0-b03d-24a1f89988f2
featuresOnArray of strings(TransactionFeatureParam)

Features to be enabled. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

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 DELETE \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/configurations/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK.

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

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

The name of the configuration.

Example: "MyConfiguration"
versioninteger(WorkspaceConfigurationVersionNumber)

Version number of a configuration.

Example: 1
configurationobject(WorkspaceConfigurationContent)

Configuration content. Depending on the domain the content can be different.

typeobject(WorkspaceConfigurationType)

Configuration type.

relatedConfigurationsArray of objects(RelatedConfiguration)

List of related configurations.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "MyConfiguration",
  "version": 1,
  "configuration": {},
  "type": {
    "name": "null",
    "technicalKey": "BUSINESS_PARTNER_LOOKUP"
  },
  "relatedConfigurations": [
    { … }
  ],
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444",
  "defaultConfiguration": true,
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Read Workspace Configuration Version

Request

Read a specific version of a configuration for a specific workspace.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
configurationIdstring(ConfigurationId)required

Workspace Configuration ID.

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

Configuration version.

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

Responses

successful operation

Bodyapplication/json
idstring

Uniquely identifies a configuration version. Not to be confused with the configuration id.

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

The name of the configuration.

Example: "MyConfiguration"
workspaceConfigurationIdstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
versioninteger(WorkspaceConfigurationVersionNumber)

Version number of a configuration.

Example: 1
createdAtstring

Date and time when the first version of the configuration was created (ISO 8601-compliant).

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

Date and time when this version of the configuration was created (ISO 8601-compliant).

Example: "2020-08-22T13:45+00:00"
createdBystring

User who created the first version of the configuration.

Example: "69129435489347624"
modifiedBystring

User who created this version of the configuration.

Example: "76248934691294444"
configurationobject(WorkspaceConfigurationContent)

Configuration content. Depending on the domain the content can be different.

typeobject(WorkspaceConfigurationType)

Configuration type.

defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
relatedConfigurationsArray of objects(RelatedConfiguration)

List of related configurations.

Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "MyConfiguration",
  "workspaceConfigurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-22T13:45+00:00",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444",
  "configuration": {},
  "type": {
    "name": "null",
    "technicalKey": "BUSINESS_PARTNER_LOOKUP"
  },
  "defaultConfiguration": true,
  "relatedConfigurations": [
    { … }
  ]
}

Find Workspace Configuration

Request

Find a specific configuration for a specific workspace.

Security
oAuth2
Path
configurationIdstring(ConfigurationId)required

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

Responses

successful operation

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

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

The name of the configuration.

Example: "MyConfiguration"
versioninteger(WorkspaceConfigurationVersionNumber)

Version number of a configuration.

Example: 1
configurationobject(WorkspaceConfigurationContent)

Configuration content. Depending on the domain the content can be different.

typeobject(WorkspaceConfigurationType)

Configuration type.

relatedConfigurationsArray of objects(RelatedConfiguration)

List of related configurations.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
defaultConfigurationboolean(DefaultWorkspaceConfiguration)

Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.

Example: true
transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "MyConfiguration",
  "version": 1,
  "configuration": {},
  "type": {
    "name": "null",
    "technicalKey": "BUSINESS_PARTNER_LOOKUP"
  },
  "relatedConfigurations": [
    { … }
  ],
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444",
  "defaultConfiguration": true,
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Update Workspace Configuration Assignment

Request

Update Workspace Configuration Assignment for a API key. Thanks to that assignment in the GET /workspace/{workspaceId}/configurations/ endpoint it is possible to find all workspace configurations which are assigned to a given API key.

Security
oAuth2
Path
workspaceIdstring(WorkspaceId)required

Workspace ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
clientIdstring(ClientId)required

The Client Id of an api key

Example: 12345678-1234-5678-1234-567812345678
Bodyapplication/jsonrequired
workspaceConfigurationIdsArray of strings(ConfigurationId)

The list of workspace configuration ids which are assigned to a api key

Example: ["c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"]
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/workspaces/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/configurations/assignments/12345678-1234-5678-1234-567812345678 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "workspaceConfigurationIds": [
      "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
    ]
  }'

Responses

successful operation

Bodyapplication/json
clientIdstring(ClientId)

Uniquely identifying ID of the client.

Example: "12345678-1234-5678-1234-567812345678"
workspaceConfigurationIdsArray of strings(ConfigurationId)

The list of workspace configuration ids which are assigned to a api key

Example: ["c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"]
Response
application/json
{
  "clientId": "12345678-1234-5678-1234-567812345678",
  "workspaceConfigurationIds": [
    "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
  ]
}

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