Overview
The article documents the structure and fields of credential objects returned in JetPatch API responses.
It provides a detailed table of all available fields, including type, URL, account information, and authentication details, along with a JSON example showing the format of a Windows credential object.
When an API response includes one or more credentials objects, each such object includes the following fields, in JSON format:
| Field | Type | Description |
| type | string | Windows or Linux |
| url | URL | The resource URL for the credentials. The provided URL is referred to in this guide as <credentials-url> |
| accountname | string | A descriptive label for the account |
| username | string | The username for login |
| password | string | The password for login. This field is omitted from responses, and is only used in the request body when adding credentials. |
| sshKey | string | OpenSSH private key, for Linux SSH authentication. This field is omitted from responses, and is only used in the request body when adding credentials. |
| sshKeyPassphrase | string | Passphrase for private key, for Linux SSH authentication. This field is omitted from responses, and is only used in the request body when adding credentials. |
For example:
Content-Type: vnd.intigua.vmanager.Credentials+json { "type":"WINDOWS", "username":"administrator", "accountname":"Admin account", "url":"/vmanage-server/rest/rest-api/credentials/58" } |
Comments
0 comments
Please sign in to leave a comment.