GenerateLinkUserOauthUrlRequestDto

August 7, 2026 · View on GitHub

Fields

FieldTypeRequiredDescriptionExample
subscriberIdString:heavy_check_mark:The subscriber ID to link to their chat identity. Required — this operation always binds a specific subscriber to a user identity in the chat provider.subscriber-123
integrationIdentifierString:heavy_check_mark:Integration identifier
connectionIdentifierOptional<String>:heavy_minus_sign:Identifier of the existing channel connection to associate this user endpoint with. Generated automatically if not provided for providers that support standalone user linking. Required for Webex.slack-connection-abc123
contextMap<String, GenerateLinkUserOauthUrlRequestDtoContextUnion>:heavy_minus_sign:N/A
contextHashOptional<String>:heavy_minus_sign:HMAC-SHA256 of the canonicalized context, signed with the tenant environment secret key (the same "Inbox with context" signing scheme). Required when the integration has HMAC validation enabled and the session did not already HMAC-verify the context, so the per-user link carries a trustworthy subscriber/tenant binding.a1b2c3d4e5f6...
userScopeList<String>:heavy_minus_sign:Slack only: User-level OAuth scopes for "Sign in with Slack". Defaults to: identity.basic. Webex: Optional Webex scopes for people/me; defaults to spark:people_read. MS Teams: ignored — uses delegated OpenID scopes (openid, profile, User.Read).[
"identity.basic"
]