Authentication

Methods

These are the authentication methods available when using the Domino Data API:

  • Credential propagation: A token is periodically refreshed and stored in a file. The file location is defined in the DOMINO_TOKEN_FILE env variable

  • API Key: If enabled, the user API key is exported in the DOMINO_USER_API_KEY env variable

Availability

Note
Those methods are not available in all run types. The following table lists the availability for these methods.
Run typeWho?TokenAPI Key

Workspace

Creator

Yes

Yes

Job

Creator

Yes

Yes

Scheduled Job

Creator

Yes

Yes

Launcher

User

Yes

Yes

App

Creator

Yes

Yes

Model API

N/A

No

No

Note
Anonymous users don’t have a token or API key, and are therefore not allowed to access data sources through public launchers automatically. If you still want to support anonymous execution, the launcher author would need to configure the launcher following the instructions in the custom authentication section or pass the credentials as a parameter.
Important
As described in the matrix, Model API does not support automatic authentication. You can set the DOMINO_USER_API_KEY environment variable for Model API or follow the instructions in the custom authentication section to use the DataSourceClient or the TrainingSetClient in this type of run.