Get database users

Gets the list of users who have been invited to the database and their role assignments.

Request

GET https://www.activityinfo.org/resources/databases/{databaseId}/users

Successful response

application/json

array[object]
databaseId	string		required
userId	string		required
name	string	The user's name, provided either when invited or by the user themselves after activating their account.	required
email	string	This user's email address.	required
role	object	This user's assigned role in the database.	required
roleId	string	The id of the role assigned to this user.	required
roleParameters	object	The values of the parameters defined for this role.	required
roleResources	array[string]	The resources (database, folder, forms, or subforms) to which the role's permissions are to apply.	required
version	integer	A monotonically-increasing version number. This version is incremented each time a change is made to the users permissions.	required
inviteDate	string	The date on which the user was invited to this database.	required
deliveryStatus	string	Values: UNKNOWN No record of email delivery is available for this user. OK Email has been successfully delivered to this user. HARD_BOUNCE Attempts to email this user failed with a "hard bounce," meaning that the account does not exist, or the domain is not accepting email. SPAM_COMPLAINT Attempts to email this user were rejected as spam by their mail server. No additional attempt will be made to send email to this user. MANUAL_SUPPRESSION Mail to this address have been manually blocked by ActivityInfo support staff.	required
inviteAccepted	boolean	True if the user has accepted the invitation to create an ActivityInfo account.	required
locked	boolean	True if this user's account has been locked following too many failed authentication attempts.	required
userLicenseType	string	The type of user license required for this user, in this database. Values: NONE The user has not been assigned any permissions, and so does not require a license, or is a member of the platform technical support team. BASIC The user has only "basic" permissions and requires only a basic user license. FULL The user requires a "full" user license.	required
lastLoginDate	local_date	Date of last login on the platform.	optional
activationStatus	string	The user's current account status. Values: NO_ACCOUNT The email has no account in the system PENDING The user has been invited to access a database, or started signing up for a free trial, but has not confirmed their account. ACTIVE The user has activated their account and accepted the terms of service. INACTIVE The user no longer has access to any databases, nor do they have an active trial or billing account. CLOSED The user has requested the closure of their account.	required
provisioningStatus	string	Whether this user account is managed by an external identity provider via SCIM. Values: NONE The user account is not managed via SCIM. ACTIVE The user account is active in their organization's identity provider. This status is updated via the System for Cross-domain Identity Management (SCIM) standard. INACTIVE This user account is no longer active in their organization's identity provider, indicating that the person is no longer working for the organization.	required

Error responses

Status Code	Error Code	Description
401	AUTHENTICATION_REQUIRED	The request must be authenticated
403	FORBIDDEN	Permission denied
404	NOT_FOUND	The resource could not be found
410	DELETED	The resource has been deleted

Example

curl -u anything:YOUR_API_TOKEN \
  https://www.activityinfo.org/resources/databases/ck8oykh8m5/users

The above command returns JSON structured like this:

[
  {
    "databaseId": "ck8oykh8m5",
    "userId": "401",
    "name": "Bob",
    "email": "bob@example.com",
    "role": {
      "id": "admin",
      "parameters": null,
      "resources": [
        "ck8oykh8m5"
      ]
    },
    "version": 34,
    "inviteDate": "",
    "deliveryStatus": "OK",
    "inviteAccepted": true,
    "locked": false,
    "userLicenseType": "NONE",
    "lastLoginDate": null,
    "activationStatus": "NO_ACCOUNT",
    "provisioningStatus": "NONE"
  },
  {
    "databaseId": "ck8oykh8m5",
    "userId": "499",
    "name": "Amin",
    "email": "amin@abc.org",
    "role": {
      "id": "rp",
      "parameters": {
        "partner": "ck8oyloog8:ckcks8ilh1x8y7q2"
      },
      "resources": [
        "ct0ycadlh1x8y7v3",
        "ctjel0blh1x8y7v4"
      ]
    },
    "version": 34,
    "inviteDate": "",
    "deliveryStatus": "OK",
    "inviteAccepted": true,
    "locked": false,
    "userLicenseType": "NONE",
    "lastLoginDate": null,
    "activationStatus": "NO_ACCOUNT",
    "provisioningStatus": "NONE"
  }
]

Next item

Get databases