Get billing account domains

Gets the list of email domains owned by a billing account.

Request

GET https://www.activityinfo.org/resources/billingAccounts/{accountId}/domains

Successful response

application/json

array[object]
domain	string	The email domain. (for example, "acme.com")	required
idp	string	The Identity Provider (IdP) that is linked to this email domain, if any. If present, user accounts with this email domain must authenticate with this IdP.	optional
deliveryStatus	string	Status of email delivery to this domain. Values: OK We have successfully sent email to this domain in the past. UNKNOWN We have never tried to send email to this domain or have no record of past attempts.	required
userCount	integer	The number of user accounts within this domain. Note that this count includes all user accounts associated with this email domain, even if they have not been invited to a database owned by this billing account.	required
provisioning	object	The breakdown of this domain's user accounts by the provisioning status reported over SCIM by the organization's identity provider. The three counts sum to the total user count.	required
none	integer	The number of accounts the identity provider has never reported over SCIM. A large count here usually means the provisioning application covers only part of the organization, rather than that these people have left it.	required
active	integer	The number of accounts the identity provider currently reports as active.	required
inactive	integer	The number of accounts the identity provider has de-provisioned, indicating that these people are no longer with the organization.	required
autoDeprovisioning	boolean	Whether users on this domain who the organization's identity provider has de-provisioned have their database access revoked automatically.	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/billingAccounts/190780004/domains

Next item

Get billing account idps