Managed identities

Managed identities offer significant advantages for high performance computing (HPC) environments by enabling granular access control for individual workspace users. Unlike traditional SSH credentials that grant all workspace users access to HPC clusters using the same set of credentials, managed identities ensure each user’s activity is logged under their own credentials.

Path and query parameters

Name	Type	Location	Req/Opt	Description
orgId	integer	query	Optional	Organization numeric identifier. Append to list managed identities within an organization other than the requester's default.
search	string	query	Optional	Filter search parameter. Supports free text search on name and keywords: platform:.
max	integer	query	Optional	Maximum number of results to return. Default: 20.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
managedIdentityId	integer	path	Required	Managed identity numeric identifier.
checked	boolean	query	Optional	If true, deletion is blocked if running jobs depend on associated managed credentials. Default: false.
userId	integer	query	Optional	User numeric identifier. Filter managed credentials by specific user.
managedCredentialsId	integer	path	Required	Managed credentials numeric identifier.

Request body parameters

Name	Type	Req/Opt	Description
CreateManagedIdentity			Create managed identity
name	string	Optional	Unique name for the managed identity. Must consist of alphanumeric, dash, or underscore characters.
platform	string	Optional	HPC platform type for this managed identity.
config	object	Optional
config.workDir	string	Optional	Compute environment working directory.
config.preRunScript	string	Optional	Script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
config.postRunScript	string	Optional	Script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
config.nextflowConfig	string	Optional	Additional Nextflow configuration content.
config.launchDir	string	Optional	Launch directory for Nextflow execution.
config.userName	string	Optional	Username for SSH authentication to the HPC cluster.
config.hostName	string	Optional	Hostname or IP address of the HPC cluster head node.
config.port	integer	Optional	SSH port for connecting to the HPC cluster. Default: 22.
config.headQueue	string	Optional	Queue name for submitting the Nextflow head job.
config.computeQueue	string	Optional	Queue name for submitting Nextflow compute jobs.
config.maxQueueSize	integer	Optional	Maximum number of jobs that can be queued at one time.
config.headJobOptions	string	Optional	Additional options for the head job submission.
config.propagateHeadJobOptions	boolean	Optional	If true, head job options are propagated to compute jobs. Default: false.
UpdateManagedIdentity			Update managed identity
managedIdentity	object	Optional
managedIdentity.id	integer	Optional	Managed identity numeric identifier.
managedIdentity.name	string	Optional	Name of the managed identity.
managedIdentity.platform	string	Optional	HPC platform type.
managedIdentity.config	object	Optional
managedIdentity.config.workDir	string	Optional	Compute environment working directory.
managedIdentity.config.preRunScript	string	Optional	Script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
managedIdentity.config.postRunScript	string	Optional	Script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
managedIdentity.config.nextflowConfig	string	Optional	Additional Nextflow configuration content.
managedIdentity.config.launchDir	string	Optional	Launch directory for Nextflow execution.
managedIdentity.config.userName	string	Optional	Username for SSH authentication to the HPC cluster.
managedIdentity.config.hostName	string	Optional	Hostname or IP address of the HPC cluster head node.
managedIdentity.config.port	integer	Optional	SSH port for connecting to the HPC cluster. Default: 22.
managedIdentity.config.headQueue	string	Optional	Queue name for submitting the Nextflow head job.
managedIdentity.config.computeQueue	string	Optional	Queue name for submitting Nextflow compute jobs.
managedIdentity.config.maxQueueSize	integer	Optional	Maximum number of jobs that can be queued at one time.
managedIdentity.config.headJobOptions	string	Optional	Additional options for the head job submission.
managedIdentity.config.propagateHeadJobOptions	boolean	Optional	If true, head job options are propagated to compute jobs. Default: false.
CreateManagedCredentials			Create managed credentials
provider	string	Optional	Authentication provider type. Currently supports ssh.
credentials	object	Optional
credentials.id	string	Optional
credentials.name	string	Required
credentials.description	string	Optional
credentials.provider	string	Required
credentials.baseUrl	string	Optional
credentials.category	string	Optional
credentials.deleted	boolean	Optional
credentials.lastUsed	string	Optional
credentials.dateCreated	string	Optional
credentials.lastUpdated	string	Optional
credentials.keys	object	Optional
credentials.keys.discriminator	string	Optional
metadata	object	Optional
metadata.discriminator	string	Optional	Type discriminator for metadata structure (read-only).
UpdateManagedCredentials			Update managed credentials
provider	string	Optional	Authentication provider type. Currently supports ssh.
credentials	object	Optional
credentials.id	string	Optional
credentials.name	string	Required
credentials.description	string	Optional
credentials.provider	string	Required
credentials.baseUrl	string	Optional
credentials.category	string	Optional
credentials.deleted	boolean	Optional
credentials.lastUsed	string	Optional
credentials.dateCreated	string	Optional
credentials.lastUpdated	string	Optional
credentials.keys	object	Optional
credentials.keys.discriminator	string	Optional
metadata	object	Optional
metadata.discriminator	string	Optional	Type discriminator for metadata structure (read-only).