SDK users

If you do not already have access to the SDK, contact sales@perforce.com. The SDK is not available on the free trial version of P4 Plan.

Every SDK plugin or integration needs to have access to a unique SDK user in order to authenticate itself towards a Helix Plan database. Similarly to a regular user, each SDK user can only have one active session towards the server, though it can impersonate multiple users at the same time.

SDK users can only be created by the default Administrator account.

SDK users get assigned an SDK Token, which is automatically generated when the user is created. You can also generate a new token by right-clicking the SDK user in ADMIN/Users and selecting Reset SDK Token from the menu.

Existing SDK users may have either an old password or an SDK token.

The following settings are unique to SDK users:

  • SDK sync methods - Any integration which connects to a server downloads a local copy of the database. This setting determines which data to download. The default value will only sync data linked to the projects the SDK user is a member of, while the alternative will sync all project data on the database (as if the SDK user is a member of all projects on the database).
  • Services provided - Integrations can be used to authenticate users logging in from outside the client. In that case, the Account can provide credential resolution services option must be ticked on the SDK user for that integration. The Account can provide login authentication integration services option is used for SDK users used with the LDAP integration.
  • Chat - Tick this option if you want the SDK user to be available in the chat tool. This can be used to enable integrations to send automated chat messages, such as status updates.