Users

User data is managed using the SCIM protocol which provides a standard way for applications to request and manage user data in other tools. 
We currently support read-only access to users, but this will be expanded in due course.
get
https://app.trelica.com/api
/scim/v2/Users
List users
SCIM end-points have a different pagination scheme to other Trelica end-points. 
Read more about SCIM pagination and filtering.
Data structure
User
Field
Type
Description
userName
string
The user's Trelica user name (typically the email address)
displayName
string
The user's full name
preferredLanguage
string
ISO format code, e.g. en-US
locale
string
ISO format code, e.g. en-US
active
boolean
Whether the user is active or not
emails
array
The user's email addresses​
phoneNumbers
array
The user's phone numbers​
roles
array
The user's roles in Trelica
id
string
Trelica ID for the user
externalId
string
ID if sourced from an alternative IdP
meta
object
​Metadata object
Email
Field
Type
Description
primary
boolean
If false, this email is an alias
type
string
Currently always work
value
string
Email address
Phone number
Field
Type
Description
type
string
Currently always work
value
string
Phone number
Role
Field
Type
Description
value
string
Name of role
SCIM Metadata
Field
Type
Description
created
datetime
When the object was created
resourceType
string
The type of the object (User)

Workflow contexts

People

Last modified 28d ago

Copy link

Outline

get

List users

Data structure

User

Phone number

Role

SCIM Metadata