Wire Protocol

Credentials

All Atlas App Services 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 the Email/Password, API Key, or Custom JWT authentication provider.

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

Parameters

Atlas 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.

Atlas App Services connection strings have the following query parameters:

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

Connect to App Services with a Connection String

To connect to Atlas App Services over the wire protocol, pass a URL-encoded Atlas 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 Atlas App Services over the wire protocol you can use standard MongoDB CRUD operations. Atlas 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
}