Skip to main content

WinRM Credentials API

This topic lists sample queries for CRUD operations that create, read, update, and delete Harness secrets that manage WinRM credentials.

note

The ! following the type means that this field is required.

Before You Begin​

Get a Secret​

This sample retrieves an existing WinRM Credentials secret by its ID:

query{  
  secret(secretId:"WGFzE4bmRgWBYSUyXsZWHQ",secretType:WINRM_CREDENTIAL){  
    ... on WinRMCredential{  
      id  
      name  
      userName  
      domain  
      skipCertCheck  
      authenticationScheme  
      useSSL  
      usageScope{  
        appEnvScopes{  
          application{  
            filterType  
            appId  
          }  
          environment{  
            filterType  
            envId  
          }  
        }  
      }  
    }  
  }  
}

Get a Secret by Name​

This sample uses a secretByName query to retrieve an existing secret by its name:

query{  
  secretByName(name:"Test WinRM Connection",secretType:WINRM_CREDENTIAL){  
    ... on WinRMCredential{  
      id  
      name  
      userName  
      domain  
            skipCertCheck  
      authenticationScheme  
      useSSL  
      usageScope{  
        appEnvScopes{  
          application{  
            filterType  
            appId  
          }  
          environment{  
            filterType  
            envId  
          }  
        }  
      }  
    }  
  }  
}

Create a WinRM Credentials Secret​

This sample creates a secret. The required CreateSecretInput input must include a SecretType:

mutation($secret: CreateSecretInput!){  
  createSecret(input: $secret){  
    secret{  
      id,  
      name  
      ... on WinRMCredential{  
        id  
        name  
        userName  
      }  
    }  
  }  
}

Query Variables: Inline Value​

For the above query, these sample variables supply the SecretType, along with several other values:

{  
  "secret": {  
    "secretType": "WINRM_CREDENTIAL",  
    "winRMCredential": {  
      "name": "create_winrm_test",  
      "useSSL": true,  
      "authenticationScheme": "NTLM",  
      "port": 5986,  
      "userName": "testingWinRM",  
      "passwordSecretId": "Password",  
      "useSSL": false,  
      "skipCertCheck": false,  
      "usageScope": {  
        "appEnvScopes": [  
          {  
            "application": {  
              "filterType": "ALL"  
            },  
            "environment": {  
              "filterType": "PRODUCTION_ENVIRONMENTS"  
            }  
          }  
        ]  
      }  
    }  
  }  
}

Update a Secret​

This sample updates an existing secret. The required UpdateSecretInput input must supply a secretType and an id. The updateSecret operation will update all fields supplied in the request.

mutation($secret: UpdateSecretInput!){  
  updateSecret(input: $secret){  
    secret{  
      id,  
      name  
    ... on WinRMCredential{  
        id  
        name  
        userName  
      }  
    }  
  }  
}

Query Variables​

These query variables supply the required secretType and id, along with updated values for several other fields:

{  
  "secret": {  
    "secretId": "hudhudeidwjiwd",  
    "secretType": "WINRM_CREDENTIAL",  
    "winRMCredential": {  
      "name": "create_winrm_test",  
      "useSSL": true,  
      "authenticationScheme": "NTLM",  
      "port": 5986,  
      "userName": "testingWinRM",  
      "passwordSecretId": "Password",  
      "useSSL": false,  
      "skipCertCheck": false,  
      "usageScope": {  
        "appEnvScopes": [  
          {  
            "application": {  
              "filterType": "ALL"  
            },  
            "environment": {  
              "filterType": "PRODUCTION_ENVIRONMENTS"  
            }  
          }  
        ]  
      }  
    }  
  }  
}

Delete a Secret​

This sample deletes a specified secret. The required DeleteSecretInput input must supply a secretId and a secretType:

mutation($secret: DeleteSecretInput!){  
  deleteSecret(input: $secret)  
}

Query Variables

{  
  "secret": {  
    "clientMutationId": "DevX-Delete-",  
    "secretId": "IG-4ppX7QQuZmD67mkoW-A",  
 "secretType": "WINRM_CREDENTIAL"  
  }  
}