Service Accounts

To access the RKStudio API, you don’t use your usual username and password. Instead you create a service account dedicated to the application that will be accessing the API.

Understanding Public Key Authentication

Your service account does not have a password, but instead uses public key authentication. Public key authentication is a highly secure method for authenticating automated applications. It works like this:

  1. You create a key pair containing one public key and one private key. You can do this within RKStudio itself (explained in Creating a Service Account below), or use an external application.
  2. You assign the public key to your RKStudio service account. The private key is not stored by RKStudio, and is known only by your application.
  3. When your application requests access to a RKStudio resource, you use your private key to sign your request. RKStudio then uses your public key to verify your signature and authorize your application. For more information, see Authentication.

Creating a Service Account

To create a service account for your application:

  1. Open the “Settings” screen.
  2. Select “Service Accounts.”
  3. Enter a name for the account and click “Add Service Account.”

Adding Keys to a Service Account

To use a service account, you need to have one or more public keys associated with it. To add a key to your service account:

  1. Open the “Settings” screen.
  2. Select “Service Accounts.”
  3. Click “Add New Key” next to the service account you want to associate the key with.
  4. You may paste in an existing public key (in RSA_X509_PEM format) if you have one. If you don’t, just click “Add Key” and a public/private key pair will be generated for you automatically.

Managing Service Accounts

To view and manage your service accounts:

  1. Open the “Settings” screen.
  2. Select “Service Accounts.”

From this screen, you can delete a service account, delete a public key, or add a new public key.

To delete a service account entirely, click the big red trash can icon at the far right.

To delete a public key associated with the account, click the smaller trash can icon next to each key.

To add a new public key to the account, see Adding Keys to a Service Account.