custom-user-data

Get the Custom User Data Configuration

Changed on

Get the Custom User Data configuration for an Atlas App Services App.

get/groups/{groupId}/apps/{appId}/custom_user_data

Request

  • Base URL
    https://services.cloud.mongodb.com/api/admin/v3.0
  • URL
    https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/custom_user_data
  • Auth
    HTTP bearer

Response

Ok

database_namestring

The name of the database that contains custom user data.

collection_namestring

The name of the collection that contains custom user data.

user_id_fieldstring

The name of a field that appears in every custom user data document and that contains the user account ID of each document's corresponding user.

enabledboolean

If true, custom user data is enabled.

mongo_service_idstring

The _id value of a linked MongoDB data source.

You can list services with the Get all services endpoint.

Data sources are services whose type is "mongodb-atlas". Use the _id value for the data source you want to link to the Trigger.

on_user_creation_function_idstring

The _id value of a user creation function that runs whenever a new user registers.

Example response

{
  "database_name": "myapp",
  "collection_name": "users",
  "user_id_field": "user_account_id",
  "mongo_service_id": "63c060ed32043ef4c93c2a9c",
  "on_user_creation_function_id": "63c055d8019a6ab879f661d6"
}

Changes

  • v3e2240dd053bdRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status