UiPath Documentation
orchestrator
2021.10
false
Orchestrator API Guide

Get Login Attempts

Returns the login attempt of the specified user.

API Endpoint​

docs image

/identity/api/User/{userId}/loginAttempts

Scopes​

Requires the following scopes:

  • PM.UserLoginAttempt
  • PM.UserLoginAttempt.Read

Request Headers​

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Note:

To obtain the {access_token}, make sure to authenticate through one of the methods described here.

Path Parameters​

Path paramData typeDescription
userId

(required)
StringThe ID of the user you want to retrieve the login attempts for.

Query Parameters​

Query paramData typeDescription
userSID

(optional)
stringThe user secure ID in Azure Active Directory.
top

(optional)
int32Display the top N entries of the login attempts.
skip

(optional)
int32Skip the top N login attempts from displaying.
sortBy

(optional)
stringSpecify the DTO property used to sort login attempts by.

For example, partitionName, clientName, clientIpAddress, etc.
sortOrder

(optional)
stringSpecify the sorting order.

For example, ascending (asc) or descending (desc).
since

(optional)
stringSpecify the desired starting date of login attempts.

Responses​

200 OK​

Returns the queried user login attempts.

  • API Endpoint​
  • Scopes​
  • Request Headers​
  • Path Parameters​
  • Query Parameters​
  • Responses​
  • 200 OK​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated