ApiKeyLoginRequest

Credentials and connector context used to establish an App Connect session for an API-key connector.

Properties

Property	Type	Required	Description
platform	string	Yes	Connector platform identifier from the App Connect manifest. Minimum length: 1.
apiKey	string · password	No	Primary connector credential. It can be omitted when managed authentication supplies the value.
rcAccessToken	string · password	No	Legacy body location for a RingCentral access token. Use the X-RC-Access-Token header instead.
rcAccountId	any of: string, number	No	Ignored browser-client compatibility field. The server derives the RingCentral account from rcAccessToken.
rcExtensionId	any of: string, number	No	Ignored browser-client compatibility field. The server derives the RingCentral extension from rcAccessToken.
userEmail	string	No	Ignored browser-client compatibility field. Connector credential fields belong in additionalInfo.
hostname	string	No	Optional connector host name for CRM deployments with tenant-specific endpoints.
proxyId	string	No	Optional proxy connector identifier.
connectorId	string	No	Developer Portal connector identifier used to resolve managed authentication fields.
isPrivate	boolean	No	Whether connectorId identifies a private connector. Default: False.
additionalInfo	object of any	No	Connector-defined credential fields, such as tenant or user identifiers.

Example

{
  "platform": "exampleCRM",
  "apiKey": "string",
  "rcAccessToken": "string",
  "rcAccountId": "string",
  "rcExtensionId": "string",
  "userEmail": "string",
  "hostname": "string",
  "proxyId": "string",
  "connectorId": "string",
  "isPrivate": false,
  "additionalInfo": {}
}