Inductive Automation config-oauth2-client API
OAuth2 client configuration
OpenAPI Specification
openapi: 3.0.3
info:
title: Ignition Gateway REST access-control config-oauth2-client 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: config-oauth2-client
description: OAuth2 client configuration
paths:
/data/api/v1/resources/delete/ignition/oauth2-client:
post:
summary: Delete OAuth2 Client (multiple)
operationId: delete-oauth2-client-(multiple)-post
tags:
- config-oauth2-client
description: Delete multiple OAuth2 Client resources by name
parameters:
- name: confirm
in: query
required: false
schema:
type: string
description: Whether to confirm the deletion, required when the operation would affect other resources.
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
signature: <string>
collection: <string>
- name: <string>
signature: <string>
collection: <string>
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/find/ignition/oauth2-client/{name}:
get:
summary: Get OAuth2 Client Config
operationId: get-oauth2-client-config-get
tags:
- config-oauth2-client
description: Retrieve configuration details about a specific OAuth2 Client resource
parameters:
- name: name
in: path
required: true
schema:
type: string
- 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/ignition/oauth2-client:
put:
summary: Modify OAuth2 Client
operationId: modify-oauth2-client-put
tags:
- config-oauth2-client
description: Modify one or more OAuth2 Client resources
parameters:
- name: allowInvalidReferences
in: query
required: false
schema:
type: string
description: If true, invalid references will be allowed. Default is false.
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
clientId: <string>
clientSecret:
type: <string>
data:
protected:
value: '<Error: Too many levels of nesting to fake this schema>'
encrypted_key:
value: '<Error: Too many levels of nesting to fake this schema>'
iv:
value: '<Error: Too many levels of nesting to fake this schema>'
ciphertext:
value: '<Error: Too many levels of nesting to fake this schema>'
tag:
value: '<Error: Too many levels of nesting to fake this schema>'
tokenUrl: <string>
httpVersion: <string>
httpConnectTimeout: <number>
httpRequestTimeout: <number>
authorizationUrl: <string>
authorizationResponseMode: <string>
backupConfig:
clientId: <string>
clientSecret:
type: <string>
data:
protected:
value: '<Error: Too many levels of nesting to fake this schema>'
encrypted_key:
value: '<Error: Too many levels of nesting to fake this schema>'
iv:
value: '<Error: Too many levels of nesting to fake this schema>'
ciphertext:
value: '<Error: Too many levels of nesting to fake this schema>'
tag:
value: '<Error: Too many levels of nesting to fake this schema>'
tokenUrl: <string>
httpVersion: <string>
httpConnectTimeout: <number>
httpRequestTimeout: <number>
authorizationUrl: <string>
authorizationResponseMode: <string>
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
clientId: <string>
clientSecret:
type: <string>
data:
protected:
value: '<Error: Too many levels of nesting to fake this schema>'
encrypted_key:
value: '<Error: Too many levels of nesting to fake this schema>'
iv:
value: '<Error: Too many levels of nesting to fake this schema>'
ciphertext:
value: '<Error: Too many levels of nesting to fake this schema>'
tag:
value: '<Error: Too many levels of nesting to fake this schema>'
tokenUrl: <string>
httpVersion: <string>
httpConnectTimeout: <number>
httpRequestTimeout: <number>
authorizationUrl: <string>
authorizationResponseMode: <string>
backupConfig:
clientId: <string>
clientSecret:
type: <string>
data:
protected:
value: '<Error: Too many levels of nesting to fake this schema>'
encrypted_key:
value: '<Error: Too many levels of nesting to fake this schema>'
iv:
value: '<Error: Too many levels of nesting to fake this schema>'
ciphertext:
value: '<Error: Too many levels of nesting to fake this schema>'
tag:
value: '<Error: Too many levels of nesting to fake this schema>'
tokenUrl: <string>
httpVersion: <string>
httpConnectTimeout: <number>
httpRequestTimeout: <number>
authorizationUrl: <string>
authorizationResponseMode: <string>
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 OAuth2 Client
operationId: create-oauth2-client-post
tags:
- config-oauth2-client
description: Create a new OAuth2 Client resource
parameters:
- name: allowInvalidReferences
in: query
required: false
schema:
type: string
description: If true, invalid references will be allowed. Default is false.
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
clientId: <string>
clientSecret:
type: <string>
data:
protected:
value: '<Error: Too many levels of nesting to fake this schema>'
encrypted_key:
value: '<Error: Too many levels of nesting to fake this schema>'
iv:
value: '<Error: Too many levels of nesting to fake this schema>'
ciphertext:
value: '<Error: Too many levels of nesting to fake this schema>'
tag:
value: '<Error: Too many levels of nesting to fake this schema>'
tokenUrl: <string>
httpVersion: <string>
httpConnectTimeout: <number>
httpRequestTimeout: <number>
authorizationUrl: <string>
authorizationResponseMode: <string>
backupConfig:
clientId: <string>
clientSecret:
type: <string>
data:
protected:
value: '<Error: Too many levels of nesting to fake this schema>'
encrypted_key:
value: '<Error: Too many levels of nesting to fake this schema>'
iv:
value: '<Error: Too many levels of nesting to fake this schema>'
ciphertext:
value: '<Error: Too many levels of nesting to fake this schema>'
tag:
value: '<Error: Too many levels of nesting to fake this schema>'
tokenUrl: <string>
httpVersion: <string>
httpConnectTimeout: <number>
httpRequestTimeout: <number>
authorizationUrl: <string>
authorizationResponseMode: <string>
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
clientId: <string>
clientSecret:
type: <string>
data:
protected:
value: '<Error: Too many levels of nesting to fake this schema>'
encrypted_key:
value: '<Error: Too many levels of nesting to fake this schema>'
iv:
value: '<Error: Too many levels of nesting to fake this schema>'
ciphertext:
value: '<Error: Too many levels of nesting to fake this schema>'
tag:
value: '<Error: Too many levels of nesting to fake this schema>'
tokenUrl: <string>
httpVersion: <string>
httpConnectTimeout: <number>
httpRequestTimeout: <number>
authorizationUrl: <string>
authorizationResponseMode: <string>
backupConfig:
clientId: <string>
clientSecret:
type: <string>
data:
protected:
value: '<Error: Too many levels of nesting to fake this schema>'
encrypted_key:
value: '<Error: Too many levels of nesting to fake this schema>'
iv:
value: '<Error: Too many levels of nesting to fake this schema>'
ciphertext:
value: '<Error: Too many levels of nesting to fake this schema>'
tag:
value: '<Error: Too many levels of nesting to fake this schema>'
tokenUrl: <string>
httpVersion: <string>
httpConnectTimeout: <number>
httpRequestTimeout: <number>
authorizationUrl: <string>
authorizationResponseMode: <string>
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/ignition/oauth2-client/{name}/{signature}:
delete:
summary: Delete OAuth2 Client
operationId: delete-oauth2-client-delete
tags:
- config-oauth2-client
description: Delete a OAuth2 Client resource by name
parameters:
- name: name
in: path
required: true
schema:
type: string
- 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
- name: confirm
in: query
required: false
schema:
type: string
description: Whether to confirm the deletion, required when the operation would affect other resources.
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/list/ignition/oauth2-client:
get:
summary: List OAuth2 Client Resources
operationId: list-oauth2-client-resources-get
tags:
- config-oauth2-client
description: List all OAuth2 Client resources, in verbose format, including configuration, metrics, and health checks.
parameters:
- name: limit
in: query
required: false
schema:
type: string
description: The maximum number of items to return.
- name: offset
in: query
required: false
schema:
type: string
description: The number of items to skip before returning results.
- name: sortBy
in: query
required: false
schema:
type: string
description: 'The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`
to specify the sort direction as ascending or descending, respectively.
'
- name: search
in: query
required: false
schema:
type: string
description: A search string to filter items by. Terms separated by whitespace.
- name: key_0
in: query
required: false
schema:
type: string
description: 'Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression).'
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/names/ignition/oauth2-client:
get:
summary: Get OAuth2 Client Names
operationId: get-oauth2-client-names-get
tags:
- config-oauth2-client
description: List all OAuth2 Client resources, including just names and enabled bit
parameters:
- name: limit
in: query
required: false
schema:
type: string
description: The maximum number of items to return.
- name: offset
in: query
required: false
schema:
type: string
description: The number of items to skip before returning results.
- name: sortBy
in: query
required: false
schema:
type: string
description: 'The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`
to specify the sort direction as ascending or descending, respectively.
'
- name: search
in: query
required: false
schema:
type: string
description: A search string to filter items by. Terms separated by whitespace.
- name: key_0
in: query
required: false
schema:
type: string
description: 'Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression).'
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/rename/ignition/oauth2-client/{name}:
post:
summary: Rename OAuth2 Client
operationId: rename-oauth2-client-post
tags:
- config-oauth2-client
description: Change the name of a OAuth2 Client resource, and update all references to it
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to rename the resource in
requestBody:
content:
application/json:
schema:
type: object
example:
name: <string>
references: <string>
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/ignition/oauth2-client:
get:
summary: Describe 'OAuth2 Client' Resource Type
operationId: describe-'oauth2-client'-resource-type-get
tags:
- config-oauth2-client
description: Describe the OAuth2 Client 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