Entity Access API

• Username = 1
• GroupId = 2

• Allowed = 1
• Denied = 2

Permission

SECURITY_ENTITYACCESSGROUPS_GET on Client Id

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccess/GetPathAccess

URL Params

None

Data Params

Example:
{
    "path": "string", 
    "recursive": "bool",
    "sidType": "Username = 1 (EntityAccessSidType enum)",
    "sid": "string"
}

• path: string

• recursive: bool

• sidType: EntityAccessSidType? (optional)

• sid: string (optional)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

SECURITY_ENTITYACCESSGROUPS_ASSIGNENTITIES

SECURITY_USERS_ASIGNENTITIES

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccess/UpsertEntityAccess

URL Params

None

Data Params

{
  "entityAccess": [
    {
      "Path": "string",
      "SidType": "Username=1 (EntityAccessSidType enum)",
      "Sid": "string",
      "Grant": "Allowed=1 (EntityAccessGrant enum)"
    }
  ]
}

• entityAccess: EntityAccessUpsertDto[]

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

SECURITY_ENTITYACCESSGROUPS_ASSIGNENTITIES

SECURITY_USERS_ASIGNENTITIES

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccess/RemoveEntityAccess 

URL Params

None

Data Params

Example:
{
    "paths": {"string", "string"},
    "sidType": "Username = 1 (EntityAccessSidType enum)",
    "sid": "string" 
}

• paths: string[]

• sidType: EntityAccessSidType? (optional)

• sid: string (optional)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

SECURITY_USERS_GET

SECURITY_ENTITYACCESSGROUPS_GET

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccess/GetEntityAccessGroups

URL Params

None

Data Params

{
    "username": "string"
}

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

SECURITY_USERS_GET

SECURITY_USERS_ASSIGNENTITYACCESSGROUPS

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccessgroup/SetEntityAccessGroup

URL Params

None

Data Params

{
    "username": "string",
    "groupIds": "Guid[]"
}

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

security.users:assign_entity_access_groups security.users:get security.entity_access_groups:get

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccess/GetAssignableEntityAccessGroups

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

When calling as an account owner all entity access groups for the account will be returned. When calling as a user with all permissions only the user’s assigned entity access groups will be returned.

Permission

security.users:assign_entity_access_groups security.users:get security.entity_access_groups:get

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/EntityAccess/UpdateUserEntityAccessGroups

URL Params

None

Data Params

Example:
{
    "userId": "string",
    "groupIdsToAdd": [],
    "groupIdsToRemove": []
}

• userId: string

• grouIdsToAdd: Guid[] (optional)

• grouIdsToRemove: Guid[] (optional)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

The calling user will not be allowed to change their own entity access groups.