Skip to main content
GET
Get a user by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

user
string
required

The unique ID of the user to return.

Query Parameters

fullProfile
boolean

When true, include the user's roles in the response.

Response

OK

Entity for storing all information pertaining to a user.

id
string
required
active
boolean
required
created
string<date-time>
required
updated
string<date-time>
required
discriminator
string
required
status
string
required
idOrTransientId
string
transientIdOrId
string
textOrNumericValue
string
empty
boolean
email
string
company
string
imageUrl
string
tier
enum<string>
Available options:
PRIMARY,
SECONDARY,
LIMITED
pricingUserTier
enum<string>
Available options:
STANDARD,
POWER
first
string
last
string
languageTag
string
timeZone
string
mfaEnabled
boolean
mfaSetup
boolean
autoprovisioned
boolean
scimStatus
string
allowLocalLogin
boolean
externalId
string
password
string
sendEmail
boolean
automatedUser
boolean
automatedUserFieldLabels
string[]
roles
object[]
stepPermissionSets
object[]
applicationEntitlements
object[]
records
string

records

lastLogin
object

Entity used to track authentication attempts.

workEmailSummary
enum<string>
Available options:
ENABLED,
DISABLED,
NOT_SET
aecFailedJobSummary
enum<string>
Available options:
NOT_SET,
ENABLED,
DISABLED
recordCommentNotifications
enum<string>
Available options:
ENABLED,
DISABLED
lastDeactivated
string<date-time>
external
boolean
disabled
boolean
serviceAccount
boolean
superUser
boolean
name
string
locked
boolean