Security API
Jan 1 2022 at 12:00 AM
Security API is an Identity server and is the authentication provider that manages logins and tokens into the IoT system as a whole. Tokens are used across other services for authentication.
Token clients include:
- SPA JS Clients
- Mobile Applications
- External System to System integrators (aka Robot clients)
Roles and permissions are also stored and managed by the Security API.
APIs within Security API
Country Code
API Calls
GetCountryList
Gets the list of countries/regions per code.
GET
Permission
None
Accessible
Core and Tenant Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/CountryCode/GetCountryListhttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/CountryCode/GetCountryListURL Params
None
Data Params
None
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetCountryEnglishName
Gets the full name of the country/region in English.
GET
Permission
None
Accessible
Core and Tenant Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/CountryCode/GetCountryEnglishNamehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/CountryCode/GetCountryEnglishNameURL Params
None
Data Params
{
"code": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetInternationalDialingCodeFromAlpha2
Gets the international dialing code of the country/region.
GET
Permission
None
Accessible
Core and Tenant Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/CountryCode/GetInternationalDialingCodeFromAlpha2https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CountryCode/GetInternationalDialingCodeFromAlpha2URL Params
None
Data Params
{
"alpha2": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetInternationalDialingCodeFromAlpha3
Gets the international dialing code of the country/region.
GET
Permission
None
Accessible
Core and Tenant Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/CountryCode/GetInternationalDialingCodeFromAlpha3https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CountryCode/GetInternationalDialingCodeFromAlpha3URL Params
None
Data Params
{
"alpha3": "string"
}Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Entity Access Group
API Calls
Add
POST
Permission
security:entityaccessgroups:add
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/EntityAccessgroup/Addhttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccessgroup/AddURL Params
None
Data Params
{
"Id": "string"
"Name": "string",
"Description": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Update
POST
Permission
security:entityaccessgroups:update
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/EntityAccessgroup/Updatehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccessgroup/UpdateURL Params
None
Data Params
{
"newData": {
"Id": "string"
"Name": "string",
"Description": "string"
},
"oldData": {
"Id": "string"
"Name": "string",
"Description": "string"
}
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Delete
POST
Permission
security:entityaccessgroups:delete
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/EntityAccessgroup/Deletehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccessgroup/DeleteURL Params
None
Data Params
{
"groupId": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Get
GET
Permission
security:entityaccessgroups:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/EntityAccessgroup/Gethttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccessgroup/GetURL Params
None
Data Params
{
"groupId": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetList
GET
Permission
security:entityaccessgroups:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/EntityAccessgroup/GetListhttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccessgroup/GetListURL Params
None
Data Params
None
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetUsersByGroupId
GET
Permission
security:entityaccessgroups:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/EntityAccessgroup/GetUsersByGroupIdhttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccessgroup/GetUsersByGroupIdURL Params
None
Data Params
{
"groupIds": ["string"]
}Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None