automation-hub
2023.10
false
Automation Hub API guide
- Open API
- Introduction to Automation Hub API
- API References
- Generate your Token from Automation Hub
- 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
API call pattern for retrieving user accounts from an Automation Suite tenant by name using the GET users endpoint with search filters.
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://{yourDomain}/automationhub_/api/v1/openapi/users?s=jane
Request
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-token
Response
"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
}
]
}