orchestrator
2023.4
false
UiPath logo, featuring letters U and I in white

Orchestrator API Guide

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Dec 5, 2024

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 param

Data type

Description

userId

(required)

String

The ID of the user you want to retrieve the login attempts for.

Query Parameters

Query param

Data type

Description

userSID

(optional)

string

The user secure ID in Azure Active Directory.

top

(optional)

int32

Display the top N entries of the login attempts.

skip

(optional)

int32

Skip the top N login attempts from displaying.

sortBy

(optional)

string

Specify the DTO property used to sort login attempts by.

For example, partitionName, clientName, clientIpAddress, etc.

sortOrder

(optional)

string

Specify the sorting order.

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

since

(optional)

string

Specify 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?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.