User sources

Changed on

Creates a new user_source

post/api/application/{application_id}/user-sources/

Request

  • Base URL
    https://api.baserow.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.baserow.io/api/application/{application_id}/user-sources/
  • Auth
    HTTP bearer

Path parameters

application_idinteger required

Creates an user_source for the application related to the provided value.

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

Request body

before_idinteger

If provided, creates the user_source before the user_source with the given id.

type'local_baserow' required
  • local_baserow - local_baserow
namestring required
integration_idinteger required

The related integration id.

table_idinteger nullable

The id of the Baserow table we want the data for.

email_field_idinteger nullable

The id of the field to use as email for the user account.

name_field_idinteger nullable

The id of the field that contains the user name.

role_field_idinteger nullable

The id of the field that contains the user role.

Response

idinteger required
uidstring required

Unique id for this user source.

application_idinteger required
integration_idinteger nullable required

The Integration used to establish the connection with the service.

typestring required

The type of the user_source.

namestring required
orderstring decimal required

Lowest first.

user_countinteger required

The total number of users in the user source.

user_count_updated_atstring date-time required

When the last user count took place.

table_idinteger nullable

The id of the Baserow table we want the data for.

email_field_idinteger nullable

The id of the field to use as email for the user account.

name_field_idinteger nullable

The id of the field that contains the user name.

role_field_idinteger nullable

The id of the field that contains the user role.

Changes