StatusModel

Represents the status of a user's credentials

Methods

Fields

userName

string, nullable

If authentication is successful, contains the username 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.

loggedIn

boolean

Returns true if authentication for this API was successful.

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

dependencies

object, nullable

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


Did this page help you?