automation-hub
latest
false
- Open API
- Introduction to Automation Hub API
- API References
- Generate your Token from Automation Hub
- Authenticating to Your Automation Hub Tenant
- Retrieve Automation Idea in Idea Phase Awaiting Review Status
- Retrieve the Cost Benefit Analysis for a Specific Idea
- Update Automation Idea Phase and Status
- Power BI Integration Video Tutorial
- Service Now Outbound Integration Video Tutorial
- Retrieve a User Account
- Update Account Details for Employees from Automation Hub
- Inactivate User Accounts that are Not Part of the Company
- Input for Automation Pipeline
- Input for Submission Type
- Input for Phase
- Input for Status
- Input for Phase and Status Update
- Input for Business Unit
- Input for Applications
- Input for Category
- Input for Cost Benefit Analysis
- Input for High Level Assessment
- Input for Detailed Assessment
- Input for Automation Idea Creation Date
- Input for Users
- Input for User Status
- User Status Table
- Input for Collaborators
- Output Dictionary
- Automation Hub Open API Power Query Data Parsing
- Automation Hub Custom Connector - Preview
Automation Hub API Guide for Public Sector
Last updated Apr 8, 2024
Retrieve a User Account
The following request exemplifies how to retrieve the user accounts within your tenant that match the following criteria:
-
search for all users accounts from the tenant where the name is set to “Jane”: s=jane
GET:
https://govcloud.uipath.us/api/v1/openapi/users?s=janeRequest
Content-Type: application/json
Authorization: Bearer [Tenant ID/Token]
x-ah-openapi-app-key: [API key if added]
x-ah-openapi-auth: openapi-token Content-Type: application/json
Authorization: Bearer [Tenant ID/Token]
x-ah-openapi-app-key: [API key if added]
x-ah-openapi-auth: openapi-tokenResponse
"message": "Success",
"statusCode": 200,
"data": {
"page": 1,
"pageSize": 4,
"totalItems": 4,
"totalPages": 1,
"users": [
{
"user_email": "jane.doe@email",
"user_first_name": "Jane",
"user_last_name": "Doe",
"user_location": "Brooklyn",
"user_department": "Engineering",
"user_business_unit": "Product",
"user_job_title": "Developer",
"user_is_active": 1,
"user_invite_status": 2,
"user_roles": [
{
"role_id": 6,
"category_id": 0
},
{
"role_id": 4,
"category_id": 0
},
{
"role_id": 5,
"category_id": 3
}
]
} "message": "Success",
"statusCode": 200,
"data": {
"page": 1,
"pageSize": 4,
"totalItems": 4,
"totalPages": 1,
"users": [
{
"user_email": "jane.doe@email",
"user_first_name": "Jane",
"user_last_name": "Doe",
"user_location": "Brooklyn",
"user_department": "Engineering",
"user_business_unit": "Product",
"user_job_title": "Developer",
"user_is_active": 1,
"user_invite_status": 2,
"user_roles": [
{
"role_id": 6,
"category_id": 0
},
{
"role_id": 4,
"category_id": 0
},
{
"role_id": 5,
"category_id": 3
}
]
}
