Inductive Automation access-control API
Access control configuration
OpenAPI Specification
openapi: 3.0.3
info:
title: Ignition Gateway REST access-control API
description: The Ignition Gateway REST API (Ignition 8.3+) provides an OpenAPI-compliant HTTP interface to Gateway configuration resources including tags, projects, modules, device connections, historian data, user management (SCIM), alarm notification, OPC connections, and more. The specification is dynamically generated based on installed modules. Authentication uses API keys exchanged for time-limited tokens via the X-Ignition-API-Token header. Mutative requests are audit-logged. Supports Kubernetes and Helm-based cloud-native deployments.
version: 8.3.0
contact:
name: Inductive Automation Support
url: https://support.inductiveautomation.com/
license:
name: Commercial
url: https://inductiveautomation.com/pricing/
x-postman-collection: https://raw.githubusercontent.com/inductiveautomation/83-api/main/postman/8.3.postman_collection_v2.json
servers:
- url: http://{gateway-host}:{port}
description: Ignition Gateway (HTTP)
variables:
gateway-host:
default: localhost
description: Hostname or IP address of the Ignition Gateway
port:
default: '8088'
description: Gateway HTTP port (default 8088; HTTPS default 8043)
- url: https://{gateway-host}:{port}
description: Ignition Gateway (HTTPS)
variables:
gateway-host:
default: localhost
description: Hostname or IP address of the Ignition Gateway
port:
default: '8043'
description: Gateway HTTPS port
security:
- apiKeyAuth: []
tags:
- name: access-control
description: Access control configuration
paths:
/data/api/v1/resources/com.inductiveautomation.opcua/access-control:
put:
summary: Modify OPC UA Access Control Config
operationId: modify-opc-ua-access-control-config-put
tags:
- access-control
description: Modify one or more OPC UA Access Control Config resources
requestBody:
content:
application/json:
schema:
type: object
example:
- signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
defaultDeviceRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
defaultTagProviderRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
tagProviderRolePermissionMappings:
key_0:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
defaultDeviceRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
defaultTagProviderRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
tagProviderRolePermissionMappings:
key_0:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
defaultDeviceRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
defaultTagProviderRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
tagProviderRolePermissionMappings:
key_0:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
key_1:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
key_2:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
key_3:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
defaultDeviceRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
defaultTagProviderRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
tagProviderRolePermissionMappings:
key_0:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
key_1:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
post:
summary: Create OPC UA Access Control Config
operationId: create-opc-ua-access-control-config-post
tags:
- access-control
description: Create the OPC UA Access Control Config resource
requestBody:
content:
application/json:
schema:
type: object
example:
- collection: <string>
enabled: <boolean>
description: <string>
config:
defaultDeviceRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
defaultTagProviderRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
tagProviderRolePermissionMappings:
key_0:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
defaultDeviceRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
defaultTagProviderRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
tagProviderRolePermissionMappings:
key_0:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- collection: <string>
enabled: <boolean>
description: <string>
config:
defaultDeviceRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
defaultTagProviderRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
tagProviderRolePermissionMappings:
key_0:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
key_1:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
key_2:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
defaultDeviceRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
defaultTagProviderRolePermissionMappings:
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
- role: <string>
permissions:
- value: '<Error: Too many levels of nesting to fake this schema>'
- value: '<Error: Too many levels of nesting to fake this schema>'
tagProviderRolePermissionMappings:
key_0:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
key_1:
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
- role:
value: '<Error: Too many levels of nesting to fake this schema>'
permissions:
value: '<Error: Too many levels of nesting to fake this schema>'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/com.inductiveautomation.opcua/access-control/{signature}:
delete:
summary: Delete OPC UA Access Control Config
operationId: delete-opc-ua-access-control-config-delete
tags:
- access-control
description: Delete the OPC UA Access Control Config resource.
parameters:
- name: signature
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to delete the resource from
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/singleton/com.inductiveautomation.opcua/access-control:
get:
summary: Get OPC UA Access Control Config Config
operationId: get-opc-ua-access-control-config-config-get
tags:
- access-control
description: Retrieve configuration details about the OPC UA Access Control Config resource
parameters:
- name: defaultIfUndefined
in: query
required: false
schema:
type: string
description: If true, return the default configuration if the resource is not defined. Otherwise, return 404. Default is false.
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to read the resource from
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/type/com.inductiveautomation.opcua/access-control:
get:
summary: Describe 'OPC UA Access Control Config' Resource Type
operationId: describe-'opc-ua-access-control-config'-resource-type-get
tags:
- access-control
description: Describe the OPC UA Access Control Config resource type
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-Ignition-API-Token
description: Time-limited API token. Obtain by posting credentials to the token endpoint. See /data/api/v1/token for details.
externalDocs:
description: Ignition 8.3 Gateway REST API Documentation
url: https://www.docs.inductiveautomation.com/docs/8.3/platform/gateway/openapi