Create New Provider

Table 1. API: Create New Provider
Element Description
API CreateProvider
Description API Creates new Provider. API is accessable to cloud admin and elevated provider service account users
Method POST
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/providers
Body Parameters
{
"name": "providerTest",
"description": "Creating new Provider",
"platforms": [
"AMAZN","ARM","VMWAR"
],
"supportEmail": "providertest@hcl.com",
"authenticationType": "Form",
"ldapAuth": {
"name": "providertest1",
"username": "providertest1",
"password":" xxxxxxx ",
"url":"http://abc.com"
},
"samlAuth": {
"id":"12",
"url":"http://abc.com",
"nameId":"testProvider",
"toolCode":"IDM",
"logoutUrl":"http://xyz.com"
}
}
  • providerInfo (Mandatory): Sample Input Json: {"name": "providerName", "description": "describeProvider", "platforms": ["AMAZN", "ARM", "CICO", "GCP", "LDZ","MHV","SCVM2","VMWAR"],"supportEmail":support1@HCL BigFix CLM.com,support2@.com, "authenticationType":"Form" or "LDAP" or "SAML 20"}.
  • Sample Platform Codes supported by BigFix CLM are: AMAZN for Amazon Web Services, ARM for Microsoft Azure, CICO for Cisco Intersight, GCP for Google Cloud Platform, LDZ for Generic Endpoint, MHV for Multi-HyperVisor, SCVM2 for Compute on Demand-Hyper V 2012, VMWAR for Compute on Demand-Vcenter.
  • Please enter comma (,) seperated value in "supportEmail".
  • Valid Authenticate Types are Form or LDAP or SAML 20

For e.g. If authenticationType is LDAP then only ldapAuth json details require to create provider with "ldapAuth":

{
"name": "providertest1",
"username": "providertest1",
"password":" xxxxxxx ",
"url":"http://abc.com"
}
For e.g. If authenticationType is SAML 20 then only samlAuth json details require to create provider with "samlAuth": {
"id":"12",
"url":"http://abc.com",
"nameId":"testProvider",
"toolCode":"IDM",
"logoutUrl":"http://xyz.com"
}
Header
  • Authorization Key: The initial step that needs to be performed before consuming BigFix CLM APIs is to obtain the Token Value for an authorization key. Once a Token value is obtained, it remains valid for all API calls made in a session. For more information on how to do that, refer Token API description.
  • Content-type: application/json
Response
{
"providerEntityId": "PVD-2998CF39-6E80-4799-93F1-2B09300143AE",
"providerName": "providerTest"
}
Response Parameters
  • Result:
  • providerEntityId
  • providerName