User

(API Version v8)

What can you do with User?

GET User/{userId}/LoginHistory
Returns the login history based on the user id.
GET User/{userName}/LoginHistory
Returns the login history based on the user name

Properties

Property Details

identity READ-ONLY	"identity": 5 Type: Number This is the unique numeric identifier for the User
roleId	"roleId": 1 Type: Number Unique identifier for the associated Role object.
roleName	"roleName": "Sample Name" Type: String The name of the object associated with the roleId property.
localeId	"localeId": 11 Type: Number Unique identifier for the associated Locale object.
localeName	"localeName": "Sample Name" Type: String The name of the object associated with the localeId property.
ownerId READ-ONLY	"ownerId": 5 Type: Number Unique identifier for the associated Owner object.
ownerName READ-ONLY	"ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property.
userStatusTypeId	"userStatusTypeId": 2 Type: Number Unique identifier for the associated UserStatusType object.
userStatusTypeName	"userStatusTypeName": "Sample Name" Type: String The name of the object associated with the userStatusTypeId property.
name	"name": "Hello World" Type: String
created READ-ONLY	"created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
expire	"expire": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format.
isInteractive	"isInteractive": true Type: Boolean
firstName	"firstName": "Hello World" Type: String
lastName	"lastName": "Hello World" Type: String
email	"email": "Hello World" Type: String
forcePasswordReset	"forcePasswordReset": true Type: Boolean
timeZone	"timeZone": "Hello World" Type: String
failedLoginCount	"failedLoginCount": 24 Type: Number
displayName	"displayName": "Hello World" Type: String
credentialId	"credentialId": 17 Type: Number Unique identifier for the associated Credential object.
credentialName	"credentialName": "Sample Name" Type: String The name of the object associated with the credentialId property.
isInternal	"isInternal": true Type: Boolean
exemptFromPasswordExpiry	"exemptFromPasswordExpiry": true Type: Boolean
sAMLUserIdentifier	"sAMLUserIdentifier": "Hello World" Type: String

End Points

Returns the login history based on the user id.

GET User/{userId}/LoginHistory

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "de86927f-d9d2-44ca-9570-ba44560908c9",
    "totalCount": 3,
    "items": [
        {
            "identity": 7,
            "userId": 153,
            "userName": "admin",
            "userLoginResultTypeId": 1,
            "userLoginResultTypeName": "Login - Success",
            "date": "2023-07-14T13:19:10.643Z",
            "message": [
                {
                    "code": 1,
                    "message": "Login - Success"
                }
            ],
            "sourceIPAddress": "127.0.0.1"
        },
        {
            "identity": 6,
            "userId": 153,
            "userName": "admin",
            "userLoginResultTypeId": 2,
            "userLoginResultTypeName": "Login - Failure",
            "date": "2023-07-13T16:48:52.227Z",
            "message": [
                {
                    "code": 80000,
                    "message": "Unable to authenticate username and password"
                }
            ],
            "sourceIPAddress": "127.0.0.1"
        },
        {
            "identity": 5,
            "userId": 153,
            "userName": "admin",
            "userLoginResultTypeId": 1,
            "userLoginResultTypeName": "Login - Success",
            "date": "2023-07-13T16:45:13.617Z",
            "message": [
                {
                    "code": 1,
                    "message": "Login - Success"
                }
            ],
            "sourceIPAddress": "127.0.0.1"
        }
    ]
}

Returns the login history based on the user name

GET User/{userName}/LoginHistory

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "de86927f-d9d2-44ca-9570-ba44560908c9",
    "totalCount": 3,
    "items": [
        {
            "identity": 7,
            "userId": 153,
            "userName": "admin",
            "userLoginResultTypeId": 1,
            "userLoginResultTypeName": "Login - Success",
            "date": "2023-07-14T13:19:10.643Z",
            "message": [
                {
                    "code": 1,
                    "message": "Login - Success"
                }
            ],
            "sourceIPAddress": "127.0.0.1"
        },
        {
            "identity": 6,
            "userId": 153,
            "userName": "admin",
            "userLoginResultTypeId": 2,
            "userLoginResultTypeName": "Login - Failure",
            "date": "2023-07-13T16:48:52.227Z",
            "message": [
                {
                    "code": 80000,
                    "message": "Unable to authenticate username and password"
                }
            ],
            "sourceIPAddress": "127.0.0.1"
        },
        {
            "identity": 5,
            "userId": 153,
            "userName": "admin",
            "userLoginResultTypeId": 1,
            "userLoginResultTypeName": "Login - Success",
            "date": "2023-07-13T16:45:13.617Z",
            "message": [
                {
                    "code": 1,
                    "message": "Login - Success"
                }
            ],
            "sourceIPAddress": "127.0.0.1"
        }
    ]
}