Register Workspace Integration

POST/api/v1/system/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/system/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: REGISTER_WORKSPACE_INTEGRATION" \
  -H "Content-Type: application/json" \
  -d '{
    "integration_type": "string",
    "provider": "Microsoft365",
    "tenant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  }'

Authorization

Minimum role: Tenant administratorThe caller must hold this role or a higher one.
Action: REGISTER_WORKSPACE_INTEGRATION

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be REGISTER_WORKSPACE_INTEGRATION for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

integration_typestringRequired
No description yet.
minimum length 1
providerenumRequired
Provider a workspace can pin its organization to.
Allowed values
- Microsoft365
- Google
tenant_iduuidRequired
No description yet.
azure_tenant_idstring or nullOptional
Azure AD tenant id this integration pins to. Required by workspace_integrations_enterprise_pin_chk when provider is "Microsoft365" and integration_type is "TenantLevelOAuth".
google_workspace_hdstring or nullOptional
Google Workspace hosted domain this integration pins to. Required by the same constraint when provider is "Google".

Response

Status 202. The command was applied. The body is the record as it stands after the command: a JSON object whose fields depend on the record.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send REGISTER_WORKSPACE_INTEGRATION.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below tenantadmin or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.