List of Integrations

GET /workspace/integrations

List of Integrations

cURL

curl --request GET \
  --url https://wks-a1b2c3d4.provisionr.io/api/v1/workspace/integrations \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "<string>",
    "is_primary": true,
    "vendor": "<string>",
    "name": "<string>",
    "handle": "<string>",
    "domain": "<string>",
    "manager_enabled": true,
    "manager_id_child_key": "<string>",
    "manager_id_parent_key": "<string>",
    "retention_days": 123,
    "sync_enabled": true,
    "metadata": {},
    "timestamp": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "synced_at": "2023-11-07T05:31:56Z"
    },
    "count": {
      "directory_attributes": 123,
      "directory_dimensions": 123,
      "directory_identities": 123,
      "policy_conditions": 123,
      "workspace_logs_parent": 123,
      "workspace_logs_record": 123,
      "workspace_logs_related": 123
    },
    "links": {
      "self": "<string>",
      "directory_attributes": "<string>",
      "directory_dimensions": "<string>",
      "directory_identities": "<string>",
      "policy_conditions": "<string>",
      "workspace_logs_parent": "<string>",
      "workspace_logs_record": "<string>",
      "workspace_logs_related": "<string>"
    }
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter[id] · string

filter[is_primary] · string

filter[vendor] · string

filter[handle] · string

filter[domain] · string

filter[sync_enabled] · string

filter[manager_enabled] · string

filter[created_before] · string

filter[created_after] · string

filter[updated_before] · string

filter[updated_after] · string

filter[deactivated_before] · string

filter[deactivated_after] · string

filter[deleted_before] · string

filter[deleted_after] · string

filter · string

page · string

sort · string

Response

200

application/json

The collection of WorkspaceIntegrationDetailedResponseData

id · string · required

Example:

"wsitg_01hq8xyzabc123def456ghi789"

is_primary · boolean · required

Whether this is the primary identity integration for the workspace

vendor · string · required

The vendor of the identity integration

Example:

"okta"

name · string · required

The display name of the identity integration

Example:

"Okta"

handle · string · required

The handle of the identity integration

Example:

"okta-prod"

domain · string | null · required

The domain of the identity integration

Example:

"example.okta.com"

manager_enabled · boolean · required

Whether manager hierarchy is enabled for this integration

manager_id_child_key · string | null · required

The field name in the integration data that contains the manager ID

Example:

"managerId"

manager_id_parent_key · string | null · required

The field name in the target data where the manager ID should be stored

Example:

"manager_id"

retention_days · integer · required

The number of days to retain synced data

Example:

90

sync_enabled · boolean · required

Whether automatic syncing is enabled

metadata · object · required

The integration's custom key/value metadata added by someone or automation in your organization

Show child attributes

Example:

{
  "managed_by": "Identity Team",
  "security_classification": "red"
}

timestamp · WorkspaceIntegrationTimestampResponseData · object · required

The timestamps for the workspace integration record

Show child attributes

count · object · required

Counts of related resources

Show child attributes

links · object · required

API hyperlinks related to the workspace integration record

Show child attributes