› Management Console › User menu › User API keys

User API keys

From the User menu, create and manage user API keys.

The list of key names is available in Management Console, but keys are hidden for security purposes.

"RPA" is a reserved name. For this reason, you cannot use it to name your keys.

We recommend updating your applications that use APIs and have robots that use Robot File System, Document Transformation Service, or the Management Console Vault to include User API keys in the requests, instead of user names and passwords.

Create API keys

  1. Click Create an API key.

    The "Create a new user API key" window appears.

  2. Enter the key name.

  3. Specify the key expiration interval. You can select a given value from the list (default is 180 days), set a custom expiration duration in days, or set the key to never expire.

  4. Click Create.

  5. Copy the key, then click Close.

    You can view the key only once at this step.

  6. Paste it into an "X-Api-Key" HTTP request header.

    Example:

    X-Api-Key: usr:30b36629-5725-46da-9672-1d521d24f890

Delete API keys

To remove a key, click Delete.

Refresh Design Studio API keys

Design Studio API keys give robots running in Design Studio access to Management Console resources, such as Vault and Robot File System. Design Studio automatically retrieves the key after successful login.

To refresh a key, click Refresh.