Admin API parameter reference

Endpoint	Method	Parameter	Usage
Account
	POST		Create a new account.
		organizationId	ID of the organization to which this account belongs.
		name	Name of this account.
		parentId	ID of the parent account to this account. If this is the top-level account, enter `null`.
		id
		createdAt
		updatedAt
	LIST		List all accounts in this Formant organization.
	GET ONE		Get account by account ID.
		id	ID of the account whose information you want to get.
	PATCH		Update existing account.
		id	ID of the account you want to update.
	DELETE		Delete account.
		id	ID of the account you want to delete.
	GET ACCOUNT TREE		Get account tree.
		id	ID of the account whose account tree you want to get.
Adapter
	POST		Create a new adapter.
		organizationID	ID of the organization to which you want to apply this adapter.
		name	Name of this adapter.
		fileId	ID of the zip file which contains the adapter you want to add.
		execCommand	Enter the execution command to start this adapter (typically `./start.sh`).
		configurationSchema	Enter the configuration schema for this adapter (max 5000 characters).
		id
		createdAt
		updatedAt
	LIST		List all adapters for this Formant organization.
	GET ONE		Get an adapter by adapter ID.
		id	ID of the adapter you want to get.
	PATCH		Update an adapter.
		id	ID of the adapter you want to update.
	DELETE		Delete an adapter.
		id	ID of the adapter you want to delete.
Custom event
	POST		Create a new custom event.
		type	Set this to 'custom'.
		severity	Severity of the event.
		id
		createdAt
		updatedAt
		tags	Tags associated with this event.
		organizationId	ID of the organization in which you want to create this new custom event.
		time	Start time of the data range relevant to this event.
		endTime	End time of the data range relevant to this event.
		parentId	If this custom event is related to another event, you can add the ID of that parent event here.
		metadata	User-customizable metadata associated with this event in key-value pair format.
		message	Message of this event. Must match the `message` field in the Formant UI when configuring a custom event.
		viewed
		deviceId	ID of the device relevant to this event.
		streamName
		streamType
		eventTriggerId	If you want to trigger this custom event off an existing event trigger, add the event trigger ID here.
		notificationEnabled	Set this to `true` to enable notifications for this custom event.
Role
	POST		Create a new role.
		organizationId	ID of the organization in which this new role should be created.
		name	Name of this role.
		policies	Access policies of this role in JSON format.
		isImmutable	Can this role be changed after creation?
		id
		createdAt
		updatedAt
		tags	Tag associated with this role.
	LIST		List all roles in your organization.
	GET ONE		Get a role by role ID.
		id	ID of the role you want to get.
	PATCH		Update an existing role.
		id	ID of the role you want to update.
	DELETE		Delete a role.
		id	ID of the role you want to delete.

Parameter	Usage
CreateUserRequest
Password	Only required if you want to pre-populate the email, otherwise the user will get an email, and can set their own password
User
organizationId	ID of organization the entity is part of
accountId	ID of the Account the entity is under
roleId	ID of the Role of this entity
Email	Email of the entity
externalUserId	This is an internal field
firstName	First name of entity
lastName	Last name of the entity
Scope	Access control scope for this entity
teamId	ID of the team this entity belongs to
phoneNumber	Phone number of the entity, used for SMS events
Enabled	If the user is enabled or not (set to false to delete user)
isOrganizationOwner	If the user has owner permissions for the organization
termsAccepted	If the user has accepted the terms and conditions
lastLoggedIn	When the user last logged in
passwordHash	Hash of their password
isSingleSignOn	If the user authenticates through an SSO provider
smsOptInStatus	If the user has opted in to SMS notifications
Region	Regional Database that user information is stored in
isServiceAccount	If it is a service account (we won’t try to send an email when you create the user)
Organization	Organization object this user belongs to
Account	Account object this entity belongs to
Role	Role this entity has
Team	Team this entity is on
Devices	Devices this entity has access to
jobTitle	Job title of the entity
Language	Language preference for the user
Units	Metric or imperial
Timezone	Timezone the user’s frontend should be
UserScope	What entities the user has access to
Roles:ScopeFilter	What Roles a user with this scope can have access to
Users:ScopeFilter	What Users a user with this scope can have access to
Teams:ScopeFilter	What Teams a user with this scope can have access to
Devices:ScopeFilter	What Devices a user with this scope can have access to
Fleets:ScopeFilter	What Fleets a user with this scope can have access to
Events:ScopeFilter	What Events a user with this scope can have access to
Views:ScopeFilter	What Views a user with this scope can have access to
keyValue:ScopeFilter	What keyValue entries a user with this scope can have access to
ScopeFilter
Start	Start time of the filter
End	End time of the filter
deviceIds	Specific devices that are part of the filter
Names	Specific stream names that are part of the filter
Types	Specific stream types that are part of the filter
Tags	Specific tags to match against for inclusion of the filter
notTags	Specific tags to match against that will exclude entities from the filter
notNames	Specific stream names that are not part of the filter
agentIds	Deprecated
Team
organizationId	ID of Organization this team is part of
Name	Name of the team
roleId	ID of Role that all team-members will be given
Scope: UserScope	UserScope that all team-members will be given
Role	Role that all team members have
Users	Users in the team
Organization	Organization this team is part of
Role
organizationId	ID of Organization this Role is in
Name	Name of Role
Policies	Access Policies of the Role
isImmutable	If the Role is changeable or not
Organization	Organization this Role is under
Users	Users that have this Role
Teams	Teams that use this role

👋
If you notice an issue with this page or need help, please reach out to us! Use the 'Did this page help you?' buttons below, or get in contact with our Customer Success team via the Intercom messenger in the bottom-right corner of this page, or at [email protected].