Skip to main content
POST
Connect Service

Endpoint

Overview

Connects the authenticated user to a service by setting the connected flag to true. The service entitlement must already exist.

Request

ServiceIdentifier
required
Service identifier: DROP, MAILS, VAULT, or DB

Response

boolean
Always true on success
string
Service identifier
string
Access tier
boolean
Premium access flag
string
“Successfully connected to service”

Implementation Details

Code Reference

Status Codes

OK
Successfully connected or already connected
Bad Request
Validation error
Unauthorized
Missing or invalid authentication token
Not Found
Service entitlement not found

Example Request

Example Response

Audit Events

  • SERVICE_ENTITLEMENT_CONNECT: Service connected successfully

Authorizations

Authorization
string
header
required

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

Body

application/json
service
enum<string>
required
Available options:
DROP,
MAILS,
VAULT,
DB

Response

200

Service connected