Sample iModels

The iTwin Studio CLI provides a set of commands to ease the management of sample iModels.

pnpx @bentley/studio-cli samples --help

Share Keys

The share-key sub-command provides a set of commands to manage share keys, which are used to fetch sample iModels in iTwin Studio.

pnpx @bentley/studio-cli samples share-key --help

Authorization

All share key commands require authentication using the iTwin Platform. The first time you use any command, a browser window will open prompting you for login. You need to have owner access to an iTwin to create a share key for it.

Environment

The following environment variables can be used to override the default authentication and API endpoint configuration:

Variable	Required	Default	Description
STUDIO_CLIENT_ID	No	environment specific iTwin Studio’s client IDs	The iTwin Platform client ID
STUDIO_SCOPE	No	itwin-platform	The OAuth scope for authorization
STUDIO_AUTHORITY	No	https://[env-prefix]ims.bentley.com/	The issuer URL for authentication
STUDIO_REDIRECT_URI	No	http://127.0.0.1:53386/signin-callback/	The redirect URI for OAuth flow
IMJS_URL_PREFIX	No	"" (production)	Alternative environment prefix variable

Note

If you’re overriding the client ID, please note that only the iTwin Studio’s client IDs are authorized to use the iTwinStudioSamples share contract.

Note

If you provide the STUDIO_SCOPE variable, make sure it includes the itwin-platform scope as it is required for the iTwin share endpoints.

List share keys

Lists all share keys for a given iTwin using the Get iTwin Shares API.

pnpx @bentley/studio-cli samples share-key list --itwin-id <ITWIN_ID> [--env-prefix <ENV_PREFIX>]

Create share key

Creates a new share key for a given iTwin with the iTwinStudioSamples contract using the Create iTwin Share API.

Note

The iTwinStudioSamples contract is a custom share contract made specifically for the use of sample iModels.

pnpx @bentley/studio-cli samples share-key create --itwin-id <ITWIN_ID> [--env-prefix <ENV_PREFIX>]

Revoke share key

Revokes an existing share key using the Revoke iTwin Share API.

pnpx @bentley/studio-cli samples share-key revoke --itwin-id <ITWIN_ID> --share-id <SHARE_ID> [--env-prefix <ENV_PREFIX>]