- Source
Members
userId
Get the default user ID.
This gets the first available user ID from the userIds property.
- Source
userId
Set the user ID.
This will set the userIds property to a new array of just the given value.
- Source
Methods
baseUrl() → {string}
Get the base URL to the SolarUser v1 REST API.
The returned URL uses the configured environment to resolve the hostUrl and a solarUserPath context path. If the context path is not available, it will default to /solaruser.
- Source
the base URL to SolarUser
- Type:
- string
nimAuthorizeUrl() → {string}
Generate a URL to get a Node Image Maker (NIM) session key.
the URL to obtain a NIM session key
- Type:
- string
updateNodeArchivedStatusUrl(nodeId, archived) → {string}
Generate a URL to update the archived status of a set of nodes via a POST request.
| Name | Type | Description |
|---|---|---|
nodeId | number | | a specific node ID, or array of node IDs, to update; if not provided the |
archived | boolean |
|
the URL to update the nodes archived status
- Type:
- string
viewArchivedNodesUrl() → {string}
Generate a URL to get a list of all archived nodes for the user account.
the URL to access the user's archived nodes
- Type:
- string
viewNodesUrl() → {string}
Generate a URL to get a list of all active nodes for the user account.
- Source
the URL to access the user's active nodes
- Type:
- string
viewPendingNodesUrl() → {string}
Generate a URL to get a list of all pending nodes for the user account.
the URL to access the user's pending nodes
- Type:
- string
whoamiUrl() → {string}
Generate a URL to get information about the requesting authenticated user.
- Source
the URL to view information about the authenticated user
- Type:
- string