Quotas

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

Upsert Quotas

Request

After creating a rate limit quota for a service it can only be called a certain amount of times in defined period of time. Depending on the parameters this affects the whole organization or a certain workspace.

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

Bodyapplication/jsonrequired

quotasArray of objects(RateLimitQuotaUpsert)[ 1 .. 100 ] itemsrequired

List of quotas to upsert.

quotas[].serviceobject(RateLimitQuotaServiceUpsert)required

Service to upsert.

quotas[].service.technicalKeystring(DataSourceTechnicalKey)required

Technical key of the data source.

Example: "BR_RF"

quotas[].organizationobject(RateLimitQuotaOrganizationUpsert)

Should remain empty for regular customer use cases (will throw 400 if provided) Available values:

system - applicable only for users with CDQ_ADMINISTRATOR.

quotas[].workspaceobject(RateLimitQuotaWorkspaceUpsert)

Workspace to upsert.

quotas[].maxAmountinteger(int64)(QuotaAmount)

Defines the amount of the quota.

Example: "20000"

quotas[].resetstring(QuotaReset)

Defines after which time interval to reset the amount of the quota.

Example: "WEEK"

curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/identity-management-api/api-v2/quotas/ratelimits \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "quotas": [
      {
        "service": {
          "technicalKey": "BR_RF"
        },
        "organization": {
          "id": "cdq_monitor"
        },
        "workspace": {
          "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
        },
        "maxAmount": "20000",
        "reset": "WEEK"
      }
    ]
  }'

Responses

OK

Bodyapplication/json

numberOfUpsertedinteger(int32)

Number of quotas upserted.

Example: "10"

Response

application/json

{
  "numberOfUpserted": "10"
}

Read Quotas

Request

Load a page of rate limit quota. Result list can be adjusted to only contain quotas for a certain service, organization or workspace.

Security

oAuth2

Query

pageSizeinteger

Number of items per page.

Default 50

Example: pageSize=50

pageinteger

Page number.

Default 0

Example: page=0

serviceTechnicalKeyArray of strings

List of service technical keys for which quotas are to be returned. When not provided (null or empty list), all available data sources with release status LIVE (see https://meta.cdq.com/Property:Release_status) are returned.

Example: serviceTechnicalKey=Data Exchange

organizationIdstring(OrganizationId)

When not provided, organization will be extracted from X-Credential-Username. When provided, must match organization from X-Credential-Username. When service, X-Credential-Username must have CDQ_ADMINISTRATOR role.

Example: organizationId=cdq_monitor

workspaceIdstring(WorkspaceId)

Return workspace quota for this workspace. When not provided, all workspace quotas can be loaded when using feature FETCH_WORKSPACE_QUOTAS.

Example: workspaceId=c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

serviceNamestring(DataSourceName)

Return quotas for services that match provided name in substring approach. Requires FETCH_SERVICE_DETAILS to be turned on.

Example: serviceName=Receita Federal Brazil

countryShortNamesArray of strings(CountryShortName)

Return quotas for services supported in these countries. Requires FETCH_SERVICE_DETAILS to be turned on.

Example: countryShortNames=CH

organizationQuotaStatusesArray of strings(RateLimitQuotaStatusParam)

Return quotas having expected statuses in organization quota. Requires DERIVE_STATUSES to be turned on.

Items Enum Value	Description
OK	when details is ok (green)
WARNING	FULL_ORGANIZATION_QUOTA_CONSUMED or FULL_EFFECTIVE_QUOTA_CONSUMED or `ULL_SYSTEM_QUOTA_CONSUMED (orange)
NOT_APPLICABLE	DEACTIVATED_BY_QUOTA or DATA_SOURCE_DEACTIVATED (red)

Example: organizationQuotaStatuses=OK

featureOnArray of strings(ReadQuotasFeatures)

Features to be activated during the reading of quotas:

FETCH_QUOTA_USAGE - fill usedQuota field. By default, turned on.
DERIVE_STATUSES - fill statuses of returned quotas. Can be activated only when FETCH_QUOTA_USAGE is activated. By default, turned off.
FETCH_WORKSPACE_NAME - fetch workspace name
FETCH_WORKSPACE_QUOTAS - fetch workspace quotas additionally when organizationId provided and workspaceId is not provided. By default, turned off.
FETCH_SERVICE_DETAILS - fetch service details like e.g. name. By default, turned off.
FETCH_SYSTEM_QUOTAS - fetch system quota. To be used by service usage api only (not UI). By default, turned off.

Items Enum"FETCH_QUOTA_USAGE""DERIVE_STATUSES""FETCH_WORKSPACE_NAME""FETCH_WORKSPACE_QUOTAS""FETCH_SERVICE_DETAILS""FETCH_SYSTEM_QUOTAS"

Example: featureOn=FETCH_QUOTA_USAGE

featureOffArray of strings(ReadQuotasFeatures)

Features to be deactivated during the reading of quotas:

FETCH_QUOTA_USAGE - fill usedQuota field. By default, turned on.
DERIVE_STATUSES - fill statuses of returned quotas. Can be activated only when FETCH_QUOTA_USAGE is activated. By default, turned off.
FETCH_WORKSPACE_NAME - fetch workspace name
FETCH_WORKSPACE_QUOTAS - fetch workspace quotas additionally when organizationId provided and workspaceId is not provided. By default, turned off.
FETCH_SERVICE_DETAILS - fetch service details like e.g. name. By default, turned off.
FETCH_SYSTEM_QUOTAS - fetch system quota. To be used by service usage api only (not UI). By default, turned off.

Items Enum"FETCH_QUOTA_USAGE""DERIVE_STATUSES""FETCH_WORKSPACE_NAME""FETCH_WORKSPACE_QUOTAS""FETCH_SERVICE_DETAILS""FETCH_SYSTEM_QUOTAS"

Example: featureOff=FETCH_QUOTA_USAGE

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/quotas/ratelimits \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

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

List of rate limit quotas.

Response

application/json

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

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

Identity Management API (2)

API Keys

Global Settings

Organizations

Organization Admins

Organization Resource Quotas

Product Packages

Quotas

Upsert Quotas

Request

Responses

Share the feedback!

Read Quotas

Request

Responses

Share the feedback!

Settings

Token Exchange

Users

Workspace Configurations

Workspaces

Workspace Resource Quotas

Maintenance

Resources

Identity Management API (2)

API Keys

Global Settings

Organizations

Organization Admins

Organization Resource Quotas

Product Packages

Quotas

Upsert Quotas

RequestExpand all

Responses

Share the feedback!

Read Quotas

Request

Responses

Share the feedback!

Settings

Token Exchange

Users

Workspace Configurations

Workspaces

Workspace Resource Quotas

Maintenance

Resources

Request