Skip to content
Developerhome
Product homepage
Sage Network API

StatusModel

  Less than to read

Represents the status of a user’s credentials

Methods

The following API methods use this data model.

  • Ping

    Required Fields

    loggedIn

boolean

Returns true if authentication for this API was successful.

isImpersonated

boolean

True if the user is being impersonated by the Sage Network support team.

Optional Fields

userName

string, nullable

If authentication is successful, contains the username of the logged-in user.

emailAddress

string, nullable

If authentication is successful, contains the email address of the logged-in user.

accountName

string, nullable

If authentication is successful, contains subscription account name of logged-in user.

accountCompanyId

uuid, nullable

If authentication is successful, contains subscription account company id of logged-in user.

userId

uuid, nullable

If authentication is successful, contains the unique identifier of the logged-in user.

groupKey

uuid, nullable

If authentication is successful, contains the group key of the logged-in user.

errorMessage

string, nullable

The error message.

roles

string[], nullable

The set of roles for this user.

lastLoggedIn

date-time, nullable

Date and time user has last logged into Azure B2C.

apiKeyId

uuid, nullable

The id of the API key used to authenticate.

userStatus

string, nullable

If authentication is successful, contains the user status of the logged-in user.

environment

string, nullable

The environment currently being used

version

string, nullable

The version currently being used

onboardingScheduled

boolean, nullable

If authentication is successful, contains the onboarding session status of the logged-in user’s group account.

baseCurrencyCode

string, nullable

Base Currency of the group

countryCode

string, nullable

Country code of the group

MagicLinkStatusModel, nullable

Magic link information about the user

supportAccess

SupportAccessModel, nullable

Information allowing Lockstep to offer direct support to the user

userGroups

UserGroupModel[], nullable

The set of Groups that the user has access to. You can use the /api/v1/useraccounts/change-group endpoint to change your active group.

dependencies

object, nullable

Statuses for the dependencies of this api. OK if the dependency is working.

Deprecated Fields

Deprecated fields are maintained for backwards compatibility with previous versions of the API. Deprecated fields may be removed in a future release of the API.

magicLinkId

uuid, nullable

The id of the Magic link used to authenticate.

magicLinkCompanyId

uuid, nullable

The id of the target company for the Magic Link