Create User Credential

Select

SaaS

Customer Managed

This operation is used to create a user credential under credentials manager in control panel.

application/json

Request Body

credentialRecordInfo object[]
recordType integer
description string
additionalInformation object
dbName string
connectString string
azureCredInfo object
environment string
tenantId string
applicationId string
subscriptionId string
credentialRecord object
credentialName string required
record object
password string required
userName string required
createAs object
user object
userGroup object
userGroupId integer
userGroupName string

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

records object[]
recordType integer
credentialRecord object
credentialId integer
error object
errorMessage string
errorCode integer

{
  "records": [
    {
      "recordType": 0,
      "credentialRecord": {
        "credentialId": 0
      }
    }
  ],
  "error": {
    "errorMessage": "string",
    "errorCode": 0
  }
}

{
  "records": [
    {
      "recordType": 1,
      "credentialRecord": {
        "credentialId": 5
      }
    }
  ],
  "error": {
    "errorMessage": "Successful!",
    "errorCode": 0
  }
}

POST /commcell/credentials

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

Body

Default
Credentials

{
  "credentialRecordInfo": [
    {
      "recordType": 0,
      "description": "string",
      "additionalInformation": {
        "dbName": "string",
        "connectString": "string",
        "azureCredInfo": {
          "environment": "string",
          "tenantId": "string",
          "applicationId": "string",
          "subscriptionId": "string"
        }
      },
      "credentialRecord": {
        "credentialName": "string"
      },
      "record": {
        "password": "string",
        "userName": "string"
      },
      "createAs": {
        "user": {},
        "userGroup": {
          "userGroupId": 0,
          "userGroupName": "string"
        }
      }
    }
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CommCell/Credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credentialRecordInfo": [
    {
      "recordType": 0,
      "description": "string",
      "additionalInformation": {
        "dbName": "string",
        "connectString": "string",
        "azureCredInfo": {
          "environment": "string",
          "tenantId": "string",
          "applicationId": "string",
          "subscriptionId": "string"
        }
      },
      "credentialRecord": {
        "credentialName": "string"
      },
      "record": {
        "password": "string",
        "userName": "string"
      },
      "createAs": {
        "user": {},
        "userGroup": {
          "userGroupId": 0,
          "userGroupName": "string"
        }
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CommCell/Credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credentialRecordInfo": [
    {
      "recordType": 0,
      "description": "string",
      "additionalInformation": {
        "dbName": "string",
        "connectString": "string",
        "azureCredInfo": {
          "environment": "string",
          "tenantId": "string",
          "applicationId": "string",
          "subscriptionId": "string"
        }
      },
      "credentialRecord": {
        "credentialName": "string"
      },
      "record": {
        "password": "string",
        "userName": "string"
      },
      "createAs": {
        "user": {},
        "userGroup": {
          "userGroupId": 0,
          "userGroupName": "string"
        }
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CommCell/Credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credentialRecordInfo": [
    {
      "recordType": 0,
      "description": "string",
      "additionalInformation": {
        "dbName": "string",
        "connectString": "string",
        "azureCredInfo": {
          "environment": "string",
          "tenantId": "string",
          "applicationId": "string",
          "subscriptionId": "string"
        }
      },
      "credentialRecord": {
        "credentialName": "string"
      },
      "record": {
        "password": "string",
        "userName": "string"
      },
      "createAs": {
        "user": {},
        "userGroup": {
          "userGroupId": 0,
          "userGroupName": "string"
        }
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CommCell/Credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credentialRecordInfo": [
    {
      "recordType": 0,
      "description": "string",
      "additionalInformation": {
        "dbName": "string",
        "connectString": "string",
        "azureCredInfo": {
          "environment": "string",
          "tenantId": "string",
          "applicationId": "string",
          "subscriptionId": "string"
        }
      },
      "credentialRecord": {
        "credentialName": "string"
      },
      "record": {
        "password": "string",
        "userName": "string"
      },
      "createAs": {
        "user": {},
        "userGroup": {
          "userGroupId": 0,
          "userGroupName": "string"
        }
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CommCell/Credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credentialRecordInfo": [
    {
      "recordType": 0,
      "description": "string",
      "additionalInformation": {
        "dbName": "string",
        "connectString": "string",
        "azureCredInfo": {
          "environment": "string",
          "tenantId": "string",
          "applicationId": "string",
          "subscriptionId": "string"
        }
      },
      "credentialRecord": {
        "credentialName": "string"
      },
      "record": {
        "password": "string",
        "userName": "string"
      },
      "createAs": {
        "user": {},
        "userGroup": {
          "userGroupId": 0,
          "userGroupName": "string"
        }
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CommCell/Credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credentialRecordInfo": [
    {
      "recordType": 0,
      "description": "string",
      "additionalInformation": {
        "dbName": "string",
        "connectString": "string",
        "azureCredInfo": {
          "environment": "string",
          "tenantId": "string",
          "applicationId": "string",
          "subscriptionId": "string"
        }
      },
      "credentialRecord": {
        "credentialName": "string"
      },
      "record": {
        "password": "string",
        "userName": "string"
      },
      "createAs": {
        "user": {},
        "userGroup": {
          "userGroupId": 0,
          "userGroupName": "string"
        }
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CommCell/Credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credentialRecordInfo": [
    {
      "recordType": 0,
      "description": "string",
      "additionalInformation": {
        "dbName": "string",
        "connectString": "string",
        "azureCredInfo": {
          "environment": "string",
          "tenantId": "string",
          "applicationId": "string",
          "subscriptionId": "string"
        }
      },
      "credentialRecord": {
        "credentialName": "string"
      },
      "record": {
        "password": "string",
        "userName": "string"
      },
      "createAs": {
        "user": {},
        "userGroup": {
          "userGroupId": 0,
          "userGroupName": "string"
        }
      }
    }
  ]
}'

Create User Credential​

Authorization

Request

Create User Credential