Open Sharing profile fields

Review the fields in an external sharing profile and how to handle profile secrets.

Profile example

An external sharing profile is a JSON file that gives a supported Delta Sharing client the information it needs to read a shared analytics table. The following example uses placeholder values.

JSON
{
  "shareCredentialsVersion": 1,
  "endpoint": "https://<sharing-endpoint>/delta-sharing/",
  "bearerToken": "<redacted-bearer-token>",
  "expirationTime": "2026-09-30T23:59:59.0Z"
}

Profile fields

Field Description How clients use it
shareCredentialsVersion The profile file format version. The client checks this value to determine whether it can read the profile format.
endpoint The Delta Sharing server URL for the shared table. Clients use this URL to request shares, schemas, table metadata, and table data.
bearerToken The bearer token that authorizes read access through the sharing endpoint. Clients send this token when they authenticate to the sharing service.
expirationTime The time when the bearer token expires, if the profile includes an expiration time. Clients stop authenticating with the profile after the token expires. Create a new profile only when continued access is authorized.

For more information about the Delta Sharing profile format, see Profile File Format in the Delta Sharing protocol.

Handling guidance

  • Store the profile in a location that only the authorized user, service account, or client workflow can read.

  • Do not commit the profile to source control or include it in notebooks, application logs, support cases, screenshots, chat messages, or shared troubleshooting notes.

  • Use the profile path with clients such as Python and pandas. Use the endpoint and bearerToken values when a client asks for the server URL and token separately.

  • If the profile or bearer token is exposed, revoke sharing for the analytics table. Create and distribute a new profile only if the recipient still requires authorized access.