{ "opencollection": "1.0.0", "info": { "name": "UiPath Automation Hub Alerts Users API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "UiPath List Users", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/users", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Page number for pagination (1-based)" }, { "name": "pageSize", "value": "1", "type": "query", "description": "Number of records per page" } ] }, "docs": "Retrieves a list of users registered in Automation Hub. Returns user identifiers, names, email addresses, and assigned roles. Used by administrators to manage user assignments and role configurations." }, { "info": { "name": "UiPath Add a User", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/adduser", "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new user to Automation Hub. The user must already exist in the UiPath identity directory. This endpoint assigns the user a role within Automation Hub and makes them available for collaboration and idea submission." }, { "info": { "name": "UiPath Edit a User", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/edituser", "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing user's properties in Automation Hub, such as their assigned role or active status. The user is identified by their unique ID in the request body." }, { "info": { "name": "UiPath List Roles", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/roles" }, "docs": "Retrieves the list of roles available in Automation Hub. Each role defines a set of permissions controlling what a user can view and perform within the platform. Roles are assigned when adding or editing users." }, { "info": { "name": "UiPath List Users", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/odata/Users", "params": [ { "name": "$filter", "value": "", "type": "query", "description": "OData filter expression to narrow results (e.g., State eq 'Running')" }, { "name": "$top", "value": "", "type": "query", "description": "Maximum number of records to return (default 100, max 1000)" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of records to skip for pagination" } ] }, "docs": "Retrieves a list of users registered in Orchestrator. Each user has associated roles, robot configurations, and folder memberships. Supports OData filtering and pagination." }, { "info": { "name": "UiPath Get a User by ID", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/:organizationName/identity_/api/User/:userId", "params": [ { "name": "organizationName", "value": "", "type": "path", "description": "The name of the UiPath organization" }, { "name": "userId", "value": "", "type": "path", "description": "Unique identifier of the user" } ] }, "docs": "Retrieves user account information by the user's unique identifier. Returns user properties including name, email address, active status, and authentication configuration. Requires the PM.Users or PM.Users.Read OAuth scope." }, { "info": { "name": "UiPath Delete a User", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/:organizationName/identity_/api/User/:userId", "params": [ { "name": "organizationName", "value": "", "type": "path", "description": "The name of the UiPath organization" }, { "name": "userId", "value": "", "type": "path", "description": "Unique identifier of the user" } ] }, "docs": "Permanently deletes a user account from the organization by their unique identifier. This action removes the user from all tenants and revokes their access to UiPath Automation Cloud. This action cannot be undone. Requires the PM.Users OAuth scope." }, { "info": { "name": "UiPath Create a User", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/:organizationName/identity_/api/User", "params": [ { "name": "organizationName", "value": "", "type": "path", "description": "The name of the UiPath organization" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user account in the UiPath organization. The user will receive an invitation email to set up their credentials. The request must include the user's email address, display name, and the tenants or roles to initially assign. Requires the PM.Users OAuth scope." } ] } ], "bundled": true }