UiPath Documentation
automation-hub
2023.10
false
Automation Hub API guide

User Status Table

User status and invitation value combinations for the Automation Hub API, showing valid configurations for creating and updating user accounts.

Based on how you use the user status values the user's status can be set up as follows:

User Statususer_invite_status valueuser_is_active valueUse Case
Inactive useruser_invite_status=0user_is_active=0GET and POST request parameters
Pending user with no invitation email sentuser_invite_status=1user_is_active=1GET and POST request parameters
Pending user with the invitation email sentuser_invite_status=2user_is_active=1GET and POST request parameters
Not invited useruser_invite_status=0user_is_active=1GET and POST request parameters
Active useruser_invite_status=3
Note: This status can only be used when editing a user account.Creating a user with user_invite_status: 3 is not possible.
user_invite_status=1Only GET request parameter

Example:

      "user_email": "jane.doe@email.com",
      "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
        }
      ]
    }
      "user_email": "jane.doe@email.com",
      "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
        }
      ]
    }

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated