Skip to main content

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

Platform-specific configuration object.

config.hostName

string

Optional

Hostname or IP address of HPC head node.

config.port

integer

Optional

SSH port. Default: 22.

UpdateManagedIdentity

Update managed identity request

managedIdentity

object

Optional

Managed identity object.

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

Platform-specific configuration object.

managedIdentity.config.hostName

string

Optional

Hostname or IP address of HPC head node.

managedIdentity.config.port

integer

Optional

SSH port. Default: 22.

CreateManagedCredentials

Create managed credentials

provider

string

Optional

Authentication provider type. Currently supports ssh.

credentials

object

Optional

Credentials configuration object. Fields depend on credential type.

UpdateManagedCredentials

Update managed credentials request

provider

string

Optional

Authentication provider type. Currently supports ssh.

credentials

object

Optional

Credentials configuration object. Fields depend on credential type.