Wire Protocol

Credentials

All operations that you issue over the wire protocol run in the context of a specific application user that you specify in the connection string. The user must be registered with one of the following authentication providers:

• Email/Password

• API Key

• Custom JWT

The contents of connection string credentials depend on the authentication provider with which the user registered:

Region

The connection string must specify the deployment region and cloud provider in which the App is hosted.

Global Apps use the global region:

mongodb://<credentials>@global.realm.mongodb.com:27020/?<parameters>

Local Apps specify the cloud provider and region name using <region>.<cloud> format. For example, an app deployed to aws-us-east-1 would use the following connection string:

mongodb://<credentials>@us-east-1.aws.realm.mongodb.com:27020/?<parameters>

Parameters

App Services requires specific connection string options that identify the application you want to connect to and the authentication provider associated with the credentials that you provide.

App Services connection strings have the following query parameters:

<app id>:<service>:<provider>

Connect to App Services with a Connection String

To connect to App Services over the wire protocol, pass a URL-encoded App Services connection string when you create a client, just as you would with a regular connection string.

Read and Modify Data

While connected to App Services over the wire protocol you can use standard MongoDB CRUD operations. App Services applies role-based data access rules to all queries in the context of the authenticated user specified in the connection string credentials.

Call a Function

You can call functions using the callFunction database command.

{
  callFunction: <function name>,
  arguments: [<arg1>, <arg2>, ...]
}

Call a Service Action [DEPRECATED]

You can call service actions using the callServiceFunction database command.

{
  callServiceFunction: <function name>,
  service: <service name>,
  arguments: [<arg1>, <arg2>, ...]
}

Get the Logged In User's Data

You can get the user object for the authenticated user using the userProfile database command.

{
  userProfile: 1
}