UiPath Documentation
automation-hub
2023.4
false

Automation Hub API Guide

User Status Table

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

User Status

user_invite_status value

user_is_active value

Use Case

Inactive user

user_invite_status=0

user_is_active=0

GET and POST request parameters

Pending user with no invitation email sent

user_invite_status=1

user_is_active=1

GET and POST request parameters

Pending user with the invitation email sent

user_invite_status=2

user_is_active=1

GET and POST request parameters

Not invited user

user_invite_status=0

user_is_active=1

GET and POST request parameters

Active user

user_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=1

Only 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