OpenManageEnterprise Auth icon

OpenManageEnterprise Auth

Create an OpenManage Enterprise API session and return X-Auth-Token headers

Login

AI-generated

Summary

Authenticate to the OpenManage Enterprise API using stored credentials, initiate a session, and return the authentication token and headers required for subsequent API requests.

Inputs

None.

Output shape

a single JSON object containing the X-Auth-Token string, the corresponding headers object with the X-Auth-Token header, and optionally the set-cookie header array if present in the response

The operation uses the node's configured credentials (baseUrl, username, password, allowInsecureTls) and performs no additional user-input parameters. It throws errors if required credentials are missing or if the login response does not include an authentication token.

Examples

Example 1: Successful login

Requires openManageEnterpriseApi credentials configured with baseUrl, username, and password; allowInsecureTls is optional. Operation set to Login with no additional parameters needed.

Links

Discussion