UiPath Documentation
sdk
latest
false
Developer guide

UiPath.Studio.Activities.Api.Licensing

In this section you can find more information on how to build activities using UiPath.Studio.Activities.Api.Licensing.

ILicenseApiService​

Note:

This feature was introduced in UiPath.Studio.Activities.Api v21.10.

Service used to retrieve license and user sign-in information.

Methods​

string GetLicenseEdition()​

Retrieves license information as defined in LicenseEdition.

UserInfo GetUserInfo()​

Retrieves sign-in information for the current user as defined in UserInfoState.

void RegisterUserInfoHandler(Action userInfoStateHandler)​

Registers a function to be invoked when the user state changes.

Parameter TypeParameter NameRemarks
ActionuserInfoStateHandlerA function that accepts a user's info as parameter which reflects the new user info state.

LicenseEdition​

Note:

This feature was introduced in UiPath.Studio.Activities.Api v21.10.

A list of license states for the current product.

Constants​

TypeNameDescription
stringUndefinedLicense not yet initialized.
stringBasicLicense associated with the Free SKU offering.
stringCommunityCommunity license.
stringAcademicThe license offered for educational purposes.
stringTrialTrial license.
stringEnterpriseEnterprise license.
stringUiPathersLicense used by UiPath employees.

UserInfo​

Note:

This feature was introduced in UiPath.Studio.Activities.Api v21.10.

Information about a user's sign-in state.

Properties​

TypeNameDescription
stringUserInfoStateThe state of the current user as defined in UserInfoState.
stringUserIdThe encrypted user ID.

UserInfoState​

Note:

This feature was introduced in UiPath.Studio.Activities.Api v21.10.

A list of sign-in states for a given user.

Constants​

TypeNameDescription
stringSignInUnavailableUser status when the user is signed out and sign-in is unavailable.
stringSignedOutUser status when the user is signed out.
stringSignedInUnconfirmedUser status when the user is signed in but sign-in not completed.
stringSignedInConfirmedUser status when the user is signed in.
  • ILicenseApiService​
  • Methods​
  • LicenseEdition​
  • Constants​
  • UserInfo​
  • Properties​
  • UserInfoState​
  • Constants​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated