SDK Keys are keys that you use to integrate with our systems. They are not customer facing.
SDK Keys are used to authenticate your application with our systems. SDK Keys are not customer facing and should be stored securely in your backend.
The concept of workspace does not apply to SDK Keys. SDK Keys are global and can be used across all workspaces.
SDK Keys can only be generated using the Dashboard.
You can associate scopes with the SDK Key to ensure more security.
When you create a SDK Key you can configure the following scopes
Scope Name | Description |
---|---|
workspace | Access to workspace resources |
workspace_scopes | Access to workspace scopes |
api_keys | Access to API keys |
Based on the scope, the SDK key can access certain functionality.
For example, a SDK Key without the api_keys
write scope, can not create API keys on the fly.
Following are some considerations:
SDK Keys are keys that you use to integrate with our systems. They are not customer facing.
SDK Keys are used to authenticate your application with our systems. SDK Keys are not customer facing and should be stored securely in your backend.
The concept of workspace does not apply to SDK Keys. SDK Keys are global and can be used across all workspaces.
SDK Keys can only be generated using the Dashboard.
You can associate scopes with the SDK Key to ensure more security.
When you create a SDK Key you can configure the following scopes
Scope Name | Description |
---|---|
workspace | Access to workspace resources |
workspace_scopes | Access to workspace scopes |
api_keys | Access to API keys |
Based on the scope, the SDK key can access certain functionality.
For example, a SDK Key without the api_keys
write scope, can not create API keys on the fly.
Following are some considerations: