Security

Jan 1 2022 at 12:00 AM

APIs within Security
1. API Calls

APIs within Security

API Calls

ApiResource

/api/v1/authorization/api-resource

Permission

security.api_resource:get

Accessible

Tenant only

URL

  https://iotnxtinternal.commander.io/api/v1/authorization/api-resource

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types ForbiddenResponse 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

/api/v1/authorization/api-resource

Permission

usage.billing.cycle:update

Accessible

Tenant only

URL

  https://iotnxtinternal.commander.io/api/v1/authorization/api-resource

URL Params

NONE

Data Params

  {
    "description": "string",
    "name": "string",
    "enabled": true,
    "apiScopes": [
      {
        "name": "string",
        "emphasize": true,
        "required": true,
        "showInDiscoveryDocument": true,
        "apiClaims": [
          {
            "type": "string",
            "value": "string"
          }
        ]
      }
    ]
  }

description: string [maxLength:500]
name: string [minLength: 5 - maxLength: 100]
enabled: boolean
apiScopes: ApiScopesContract [maxLength: 20]

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/api-resource/{id}/secret

Permission

security.api_resource:add

Accessible

Tenant only

URL

  https://iotnxtinternal.commander.io/api/v1/authorization/api-resource/{id}/secret

URL Params

  {
    "id": "string"
  }

id: string (required)

Data Params

  {
    "expire": "2020-09-01T16:36:24.836Z",
    "value": "string",
    "type": "string"
  }

expire: string
value: string
type: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/api-resource/{id}/scope

Permission

security.api_resource:add

Accessible

Tenant only

URL

  https://iotnxtinternal.commander.io/api/v1/authorization/api-resource/{id}/scope

URL Params

  {
    "id": "string"
  }

id: string (required)

Data Params

  {
    "name": "string",
    "emphasize": true,
    "required": true,
    "showInDiscoveryDocument": true,
    "apiClaims": [
      {
        "type": "string",
        "value": "string"
      }
    ]
  }

name: string [minLength: 5 - maxLength: 100] (required)
emphasize: boolean
required: boolean
showInDiscoveryDocument: boolean
apiClaims: ApiClaimContract [maxLength: 20]

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/api-resource/{id}/scope/{name}/claim

Permission

security.api_resource:add

Accessible

Tenant only

URL

  https://iotnxtinternal.commander.io/api/v1/authorization/api-resource/{id}/scope/{name}/claim

URL Params

  {
    "id": "string",
    "name": "string"
  }

id: string (required)
name: string (required)

Data Params

  {
    "type": "string",
    "value": "string"
  }

type: string
value: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/api-resource/{id}/secret/{secretId}

Permission

security.api_resource:delete

Accessible

Tenant only

URL

  https://iotnxtinternal.commander.io/api/v1/authorization/api-resource/{id}/secret/{secretId}

URL Params

  {
    "id": "string",
    "secretId": "string"
  }

id: string (required)
secretId: string (required)

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/api-resource/{id}/scope/{name}

Permission

security.api_resource:delete

Accessible

Tenant only

URL

  https://iotnxtinternal.commander.io/api/v1/authorization/api-resource/{id}/scope/{name}

URL Params

  {
    "id": "string",
    "name": "string"
  }

id: string (required)
name: string (required)

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/api-resource/{id}/scope/{name}/claim/{type}

Permission

security.api_resource:delete

Accessible

Tenant only

URL

  https://iotnxtinternal.commander.io/api/v1/authorization/api-resource/{id}/scope/{name}/claim/{type}

URL Params

  {
    "id": "string",
    "name": "string",
    "type": "string"
  }

id: string (required)
name: string (required)
type: string (required)

Data Params

  {
    "type": "string",
    "value": "string"
  }

type: string [minLength: 1 - maxLength: 500]
value: string [minLength: 1 - maxLength: 500]

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

Client

/api/v1/authorization/clients/claim-types

Permission

client:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/claim-types

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/spa-clients

Permission

client:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/spa-clients

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/robot-clients

Permission

client:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/robot-clients

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/web-clients

Permission

client:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/web-clients

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/mobile-clients

Permission

client:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/mobile-clients

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/secret-types

Permission

client:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/secret-types

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/{username}/landing-page/applications

Permission

client:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/{username}/landing-page/applications

URL Params

{
    "username": "string"
}

username: string (required)

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/groupings

Permission

client:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/groupings

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/spa-client

Permission

client:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/spa-client

URL Params

NONE

Data Params

{
  "logoUri": "string",
  "redirectUris": [
    "string"
  ],
  "allowedCorsOrigins": [
    "string"
  ],
  "postLogoutRedirectUris": [
    "string"
  ],
  "clientUri": "string",
  "shouldDisplayOnLandingPage": true,
  "clientId": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "locked": true,
  "allowedScopes": [
    "string"
  ],
  "clientRoles": [
    "string"
  ],
  "clientClaims": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "clientSecrets": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "grouping": "string"
}

logoUri: string
redirectUris: string[]
allowedCorsOrigins: string[]
postLogoutRedirectUris: string[]
clientUri: string
shouldDisplayOnLandingPage: boolean
clientId: string [minLength: 2 - maxLength: 52] (required)
name: string [minLength: 2 - maxLength: 52] (required)
description: string [maxLength: 1200]
enabled: boolean
locked: boolean
allowedScopes: string[]
clientRoles: string[]
clientClaims: ClientClaim[]
clientRoles: Secret[]
grouping: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/web-application-client

Permission

client:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/web-application-client

URL Params

NONE

Data Params

{
  "logoUri": "string",
  "redirectUris": [
    "string"
  ],
  "allowedCorsOrigins": [
    "string"
  ],
  "postLogoutRedirectUris": [
    "string"
  ],
  "clientUri": "string",
  "shouldDisplayOnLandingPage": true,
  "clientId": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "locked": true,
  "allowedScopes": [
    "string"
  ],
  "clientRoles": [
    "string"
  ],
  "clientClaims": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "clientSecrets": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "grouping": "string"
}

logoUri: string
redirectUris: string[]
allowedCorsOrigins: string[]
postLogoutRedirectUris: string[]
clientUri: string
shouldDisplayOnLandingPage: boolean
clientId: string [minLength: 2 - maxLength: 52] (required)
name: string [minLength: 2 - maxLength: 52] (required)
description: string [maxLength: 1200]
enabled: boolean
locked: boolean
allowedScopes: string[]
clientRoles: string[]
clientClaims: ClientClaim[]
clientRoles: Secret[]
grouping: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/robot-client

Permission

client:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/robot-client

URL Params

NONE

Data Params

{
  "logoUri": "string",
  "clientId": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "locked": true,
  "allowedScopes": [
    "string"
  ],
  "clientRoles": [
    "string"
  ],
  "clientClaims": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "clientSecrets": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "grouping": "string"
}

logoUri: string
clientId: string [minLength: 2 - maxLength: 52] (required)
name: string [minLength: 2 - maxLength: 52] (required)
description: string [maxLength: 1200]
enabled: boolean
locked: boolean
allowedScopes: string[]
clientRoles: string[]
clientClaims: ClientClaim[]
clientRoles: Secret[]
grouping: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/mobile-client

Permission

client:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/mobile-client

URL Params

NONE

Data Params

{
  "logoUri": "string",
  "redirectUris": [
    "string"
  ],
  "postLogoutRedirectUris": [
    "string"
  ],
  "clientUri": "string",
  "clientId": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "locked": true,
  "allowedScopes": [
    "string"
  ],
  "clientRoles": [
    "string"
  ],
  "clientClaims": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "clientSecrets": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "grouping": "string"
}

logoUri: string
redirectUris: string[]
postLogoutRedirectUris: string[]
clientUri: string
clientId: string [minLength: 2 - maxLength: 52] (required)
name: string [minLength: 2 - maxLength: 52] (required)
description: string [maxLength: 1200]
enabled: boolean
locked: boolean
allowedScopes: string[]
clientRoles: string[]
clientClaims: ClientClaim[]
clientRoles: Secret[]
grouping: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/disable

Permission

client:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/disable

URL Params

{
    "clientId": "string"
}

clientId: string (required)

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/enable

Permission

client:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/disable

URL Params

{
    "clientId": "string"
}

clientId: string (required)

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/spa-client

Permission

client:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/spa-client

URL Params

NONE

Data Params

{
  "logoUri": "string",
  "redirectUris": [
    "string"
  ],
  "allowedCorsOrigins": [
    "string"
  ],
  "postLogoutRedirectUris": [
    "string"
  ],
  "clientUri": "string",
  "shouldDisplayOnLandingPage": true,
  "clientId": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "locked": true,
  "allowedScopes": [
    "string"
  ],
  "clientRoles": [
    "string"
  ],
  "clientClaims": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "clientSecrets": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "grouping": "string"
}

logoUri: string
redirectUris: string[]
allowedCorsOrigins: string[]
postLogoutRedirectUris: string[]
clientUri: string
shouldDisplayOnLandingPage: boolean
clientId: string [minLength: 2 - maxLength: 52] (required)
name: string [minLength: 2 - maxLength: 52] (required)
description: string [maxLength: 1200]
enabled: boolean
locked: boolean
allowedScopes: string[]
clientRoles: string[]
clientClaims: ClientClaim[]
clientRoles: Secret[]
grouping: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/web-application-client

Permission

client:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/web-application-client

URL Params

NONE

Data Params

{
  "logoUri": "string",
  "redirectUris": [
    "string"
  ],
  "allowedCorsOrigins": [
    "string"
  ],
  "postLogoutRedirectUris": [
    "string"
  ],
  "clientUri": "string",
  "shouldDisplayOnLandingPage": true,
  "clientId": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "locked": true,
  "allowedScopes": [
    "string"
  ],
  "clientRoles": [
    "string"
  ],
  "clientClaims": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "clientSecrets": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "grouping": "string"
}

logoUri: string
redirectUris: string[]
allowedCorsOrigins: string[]
postLogoutRedirectUris: string[]
clientUri: string
shouldDisplayOnLandingPage: boolean
clientId: string [minLength: 2 - maxLength: 52] (required)
name: string [minLength: 2 - maxLength: 52] (required)
description: string [maxLength: 1200]
enabled: boolean
locked: boolean
allowedScopes: string[]
clientRoles: string[]
clientClaims: ClientClaim[]
clientRoles: Secret[]
grouping: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/robot-client

Permission

client:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/robot-client

URL Params

NONE

Data Params

{
  "logoUri": "string",
  "clientId": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "locked": true,
  "allowedScopes": [
    "string"
  ],
  "clientRoles": [
    "string"
  ],
  "clientClaims": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "clientSecrets": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "grouping": "string"
}

logoUri: string
clientId: string [minLength: 2 - maxLength: 52] (required)
name: string [minLength: 2 - maxLength: 52] (required)
description: string [maxLength: 1200]
enabled: boolean
locked: boolean
allowedScopes: string[]
clientRoles: string[]
clientClaims: ClientClaim[]
clientRoles: Secret[]
grouping: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/mobile-client

Permission

client:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/mobile-client

URL Params

NONE

Data Params

{
  "logoUri": "string",
  "redirectUris": [
    "string"
  ],
  "postLogoutRedirectUris": [
    "string"
  ],
  "clientUri": "string",
  "clientId": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "locked": true,
  "allowedScopes": [
    "string"
  ],
  "clientRoles": [
    "string"
  ],
  "clientClaims": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "clientSecrets": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "grouping": "string"
}

logoUri: string
redirectUris: string[]
postLogoutRedirectUris: string[]
clientUri: string
clientId: string [minLength: 2 - maxLength: 52] (required)
name: string [minLength: 2 - maxLength: 52] (required)
description: string [maxLength: 1200]
enabled: boolean
locked: boolean
allowedScopes: string[]
clientRoles: string[]
clientClaims: ClientClaim[]
clientRoles: Secret[]
grouping: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/robot-client/upsert

Permission

client:edit

client:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/robot-client/upsert

URL Params

NONE

Data Params

{
  "logoUri": "string",
  "clientId": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "locked": true,
  "allowedScopes": [
    "string"
  ],
  "clientRoles": [
    "string"
  ],
  "clientClaims": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "clientSecrets": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "grouping": "string"
}

logoUri: string
clientId: string [minLength: 2 - maxLength: 52] (required)
name: string [minLength: 2 - maxLength: 52] (required)
description: string [maxLength: 1200]
enabled: boolean
locked: boolean
allowedScopes: string[]
clientRoles: string[]
clientClaims: ClientClaim[]
clientRoles: Secret[]
grouping: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/{clientId}/secrets

Permission

client:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/{clientId}/secrets

URL Params

{
    "clientId": "string"
}

clientId: string (required)

Data Params

[
  {
    "value": "string",
    "type": "string"
  }
]

value: string
type: 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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/{clientId}

Permission

client:delete

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/{clientId}

URL Params

{
  "clientId": "string"
}

clientId: string (required)

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/clients/{clientId}/revoke-secrets

Permission

client:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/clients/{clientId}/revoke-secrets

URL Params

{
  "clientId": "string",
}

clientId: string (required)

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

Configuration

/api/v1/authorization/configuration

Permission

security.configuration:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/configuration

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/configuration/apply

Permission

security.configuration:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/configuration/apply

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

Applies the configuration changes. NB: Restarts Identity Server instances in order to apply changes

/api/v1/authorization/configuration

Permission

security.configuration:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/configuration

URL Params

NONE

Data Params

{
  "passwordPolicy": {
    "matchCommonPasswords": true,
    "requireDigit": true,
    "requireLowercase": true,
    "requireNonAlphanumeric": true,
    "requireUppercase": true,
    "requiredLength": 0,
    "passwordMayContainUsername": true
  },
  "signIn": {
    "enabled": false,
    "lockoutTimeSpanMinutes": 0,
    "maxFailedAccessAttempts": 0,
    "allowLockoutForNewUsers": false
  },
  "authentication": {
    "facebookAuthentication": {
      "enabled": false,
      "appId": "string",
      "appSecret": "string",
      "isSecretSet": true,
      "overrideSecret": true
    },
    "googleAuthentication": {
      "enabled": false,
      "clientId": "string",
      "clientSecret": "string",
      "isSecretSet": true,
      "overrideSecret": true
    },
    "activeDirectoryAuthentications": [
      {
        "enabled": false,
        "clientId": "string",
        "clientSecret": "string",
        "isSecretSet": true,
        "overrideSecret": true,
        "signInScheme": "string",
        "authorizationEndpoint": "string",
        "tokenEndpoint": "string",
        "name": "string"
      }
    ]
  }
}

passwordPolicy: PasswordPolicyOptionsContract
signIn: SignInOptionsContract
authentication: AuthenticationOptionsContract

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/configuration

Permission

security.configuration:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/configuration

URL Params

NONE

Data Params

{
  "passwordPolicy": {
    "matchCommonPasswords": true,
    "requireDigit": true,
    "requireLowercase": true,
    "requireNonAlphanumeric": true,
    "requireUppercase": true,
    "requiredLength": 0,
    "passwordMayContainUsername": true
  },
  "signIn": {
    "enabled": false,
    "lockoutTimeSpanMinutes": 0,
    "maxFailedAccessAttempts": 0,
    "allowLockoutForNewUsers": false
  },
  "authentication": {
    "facebookAuthentication": {
      "enabled": false,
      "appId": "string",
      "appSecret": "string",
      "isSecretSet": true,
      "overrideSecret": true
    },
    "googleAuthentication": {
      "enabled": false,
      "clientId": "string",
      "clientSecret": "string",
      "isSecretSet": true,
      "overrideSecret": true
    },
    "activeDirectoryAuthentications": [
      {
        "enabled": false,
        "clientId": "string",
        "clientSecret": "string",
        "isSecretSet": true,
        "overrideSecret": true,
        "signInScheme": "string",
        "authorizationEndpoint": "string",
        "tokenEndpoint": "string",
        "name": "string"
      }
    ]
  }
}

passwordPolicy: PasswordPolicyOptionsContract
signIn: SignInOptionsContract
authentication: AuthenticationOptionsContract

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/configuration/reset

Permission

security.configuration:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/configuration/reset

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

Resets security configuration back to default

/api/v1/authorization/configuration

Permission

security.configuration:delete

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/configuration

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

Invite

/api/v1/authorization/invites

Permission

security.users:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/invites

URL Params

{
    "username": "string"
}

username: string

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/invites

Permission

security.users:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/invites

URL Params

NONE

Data Params

{
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "inviteEmail": "[email protected]",
  "roles": [
    "string"
  ],
  "groups": [
    "string"
  ],
  "applications": [
    "string"
  ]
}

username: string (required)
firstName: string (required)
lastName: string (required)
inviteEmail: string (required)
roles: string[] [maxLength: 50]
groups: string[] [maxLength: 50]
applications: string[] [maxLength: 50]

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/invites/{username}/invite

Permission

security.users:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/invites/{username}/invite

URL Params

{
    "username": "string"
}

username: string (requried)

Data Params

{
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "inviteEmail": "[email protected]",
  "roles": [
    "string"
  ],
  "groups": [
    "string"
  ],
  "applications": [
    "string"
  ]
}

username: string (required)
firstName: string (required)
lastName: string (required)
inviteEmail: string (required)
roles: string[] [maxLength: 50]
groups: string[] [maxLength: 50]
applications: string[] [maxLength: 50]

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

Configuration

/api/v1/authorization/permissions

Permission

security.permissions:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/permissions

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/permissions/{permissionId}

Permission

security.permissions:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/permissions/{permissionId}

URL Params

{
    "permissionId": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

Roles

/api/v1/authorization/roles

Permission

security.roles:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/roles

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/roles/{roleId}

Permission

security.roles:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/roles/{roleId}

URL Params

{
    "roleId": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

User

/api/v1/authorization/users

Permission

security.users:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/users

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}

Permission

security.users:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/users/{username}

URL Params

{
    "username": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}/permissions/{permissionKey}/has-permission

Permission

security.users:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/users/{username}/permissions/{permissionKey}/has-permission

URL Params

{
    "username": "string",
    "permissionKey ": "string",
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}/contact-information

Permission

security.users:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/users/{username}/contact-information

URL Params

{
    "username": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}/roles/{roleKey}

Permission

-security.users:get -security.users:assign_roles

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io​/api​/v1​/authorization​/users​/{username}​/roles​/{roleKey}

URL Params

{
    "username": "string",
    "roleKey": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}/roles

Permission

-security.users:get -security.users:assign_roles

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/users/{username}/roles

URL Params

{
    "username": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}/roles/{roleKey}/remove

Permission

-security.users:get -security.users:assign_roles

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io​/api/v1/authorization/users/{username}/roles/{roleKey}/remove

URL Params

{
    "username": "string",
    "roleKey": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}/application/{clientId}

Permission

security.users:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io​/api/v1/authorization/users/{username}/application/{clientId}

URL Params

{
    "username": "string",
    "clientId": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}

Permission

-security.users:get -security.users:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/users/{username}

URL Params

{
    "username": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}/enable

Permission

security.users:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io​/api/v1/authorization/users/{username}/enable

URL Params

{
    "username": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}/disable

Permission

security.users:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io​/api/v1/authorization/users/{username}/disable

URL Params

{
    "username": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}

Permission

security.users:delete

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/users/{username}

URL Params

{
    "username": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/users/{username}/application/{clientId}

Permission

security.users:delete

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io​/api/v1/authorization/users/{username}/application/{clientId}

URL Params

{
    "username": "string",
    "clientId": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

User-Group

/api/v1/authorization/user-groups

Permission

security.group:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/user-groups

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/user-groups/{key}

Permission

security.group:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/user-groups/{key}

URL Params

{
    "key": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/user-groups/{key}/users

Permission

security.users:get

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/user-groups/{key}/users

URL Params

{
    "key": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/user-groups

Permission

security.group:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/user-groups

URL Params

NONE

Data Params

{
  "key": "string",
  "displayName": "string",
  "roles": [
    "string"
  ],
  "applications": [
    "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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/user-groups/{key}/user/{username}

Permission

security.group:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/user-groups/{key}/user/{username}

URL Params

{
  "key": "string",
  "username": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/user-groups/key

Permission

security.group:add

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/user-groups/key

URL Params

{
  "key": "string"
}

Data Params

{
  "displayName": "string",
  "roles": [
    "string"
  ],
  "applications": [
    "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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/user-groups/{key}/enable

Permission

security.group:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io​/api​/v1​/authorization​/user-groups​/{key}​/enable

URL Params

{
  "key": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/user-groups/{key}/disable

Permission

security.group:edit

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io​/api/v1/authorization/user-groups/{key}/disable

URL Params

{
  "key": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/user-groups/{key}

Permission

security.group:delete

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/user-groups/{key}

URL Params

{
  "key": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

/api/v1/authorization/user-groups/{key}/user/{username}

Permission

NONE

Accessible

Tenant only

URL

https://iotnxtinternal.commander.io/api/v1/authorization/user-groups/{key}/user/{username}

URL Params

{
  "key": "string",
  "username": "string"
}

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

Unauthorized Response

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

ForbiddenResponse

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Forbidden 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

Security

APIs within Security

API Calls

Continue reading

Community

Questions

Website