Token

Table 1. Token
Element Description
API Token
Description API returns the token based on grant type, username, and password to authenticate HCL BigFix CLM APIs.
Method GET
URL Http(s)://xx.xxx.xx.xx:xxx/token
Body (Parameters (Mandatory for HCL BigFix CLM Users)

Grant_type: password

Username: xxxx

Password: xxxxx

AccessLevel: If user belongs to multi organizations and providers and need to pass “ORG” for access API with organization user or “PVD” for access API with provider user.

RequestedAccessentityId: If user belongs to multi organizations and providers and pass “ORG” as accesslevel then pass orgentityid or unique orgcode for this key and if “PVD” as access level the pas provider name or provider entityid for this key.

Body (Parameters (Mandatory for Ldap Users)

Grant_type: ldap

Username: xxxx (username with domain details e.g. Domain\Username (CONTOSO\USERA))

Password: xxxxx

AccessLevel: If user belongs to multi organizations and providers and need to pass “ORG” for access API with organization user or “PVD” for access API with provider user.

RequestedAccessentityId: If user belongs to multi organizations and providers and pass “ORG” as accesslevel then pass orgentityid or unique orgcode for this key and if “PVD” as access level the pas provider name or provider entityid for this key.

Header Content-Type: application/x-www-form-urlencoded
Response

A Sample Response

{"access_token": "lt9r1xt731ccd7yv8sx2nams_vjiss
Kagbtin5y5mk6jvns
40U_mpxsacztpgmj3h
Febpeq9myn9gveo0hstedm5hhzxx4uy08isqpz_mif
KI0s7c1xkZogNHvpFnKCklW9gPudDkqdyC6UB7Pb
Rlfqss2oypjurrcoq7p4zppy8tga
Dkq7m7vhzak9cuzccpo_c2tcn61ppj08ferz_cmb
Tkiegj6mhqkkwfkta5ijqs6ztsx62r5cfgumok
3DQW25OuM-bvloltrg54o9lly_xn2txj_s3dwisbzftnp9
Kuv0tvrxdjdfxfz44gp_wacudphsewrvzaqz-7spsyxteoo7pm6w2ph3idivypw25azrjmztzfpo
Ku0naoj14snrr492fgyddky30jpu0aleorglv1zx
B8x7flojdkxcexpkblbix8svtuftgfs8ig5o0q11ue
Pilx8csljnhpmhodwa8k3w_jdrfptr2hbylmivu
Oq5tqItTd8izLvS52uPaSAWqS2Imb8WdjhUMLZIg
Nj6pzwc61shkomls_f2ucr0q3obgu0d0tz
Bxarwoys40lweyal5jiov8ft5enkdccon
Xjx2DsG877EX06VapVzC912Vi1HyOwFAjfvGDps-0ekjx5wckzzzztcwmbw9tew",
 "token_type": "bezzzzzzarer",
 "expires_in": 83zzzz999
}
Response Parameters
  • Access_token
  • Token_type
  • Expires_in