Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Inductive Automation user-management-scim API

SCIM 2.0 user and group management

Inductive Automation user-management-scim API is one of 88 APIs that Inductive Automation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include user-management-scim. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 15 operations across 9 paths. It is described by OpenAPI 3.0.3, at version 8.3.0.

Requests are made against 2 base URLs: http://{gateway-host}:{port}, https://{gateway-host}:{port}.

15 operations 9 paths 0 schemas 2 DELETE9 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.3.0
Base URL
https://{gateway-host}:8088/api
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Inductive Automation user-management-scim API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Ignition-API-Token (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Time-limited API token. Obtain by posting credentials to the token endpoint. See /data/api/v1/token for details.

Paths & Operations 15

Across 9 paths, the API surfaces 15 operations — 2 DELETE, 9 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

user-management-scim 15

SCIM 2.0 user and group management

GET
/data/api/v1/scim/{profile-name}/{scim-version}/Groups
List Group Resources
list-group-resources-get 2 params → 200400401404
POST
/data/api/v1/scim/{profile-name}/{scim-version}/Groups
Create Group Resource
create-group-resource-post 2 params body → 200400401404
GET
/data/api/v1/scim/{profile-name}/{scim-version}/Groups/{group-id}
Get Group Resource
get-group-resource-get 3 params → 200400401404
PUT
/data/api/v1/scim/{profile-name}/{scim-version}/Groups/{group-id}
Modify Group Resource
modify-group-resource-put 3 params → 200400401404
DELETE
/data/api/v1/scim/{profile-name}/{scim-version}/Groups/{group-id}
Delete Group Resource
delete-group-resource-delete 3 params → 200400401404
GET
/data/api/v1/scim/{profile-name}/{scim-version}/ResourceTypes
List Resource Types
list-resource-types-get 2 params → 200400401404
GET
/data/api/v1/scim/{profile-name}/{scim-version}/ResourceTypes/{type-id}
Get Resource Type
get-resource-type-get 3 params → 200400401404
GET
/data/api/v1/scim/{profile-name}/{scim-version}/Schemas
List Schemas
list-schemas-get 2 params → 200400401404
GET
/data/api/v1/scim/{profile-name}/{scim-version}/Schemas/{schema-id}
Get Schema
get-schema-get 3 params → 200400401404
GET
/data/api/v1/scim/{profile-name}/{scim-version}/ServiceProviderConfig
Get Service Provider Configuration
get-service-provider-configuration-get 2 params → 200400401404
GET
/data/api/v1/scim/{profile-name}/{scim-version}/Users
List User Resources
list-user-resources-get 2 params → 200400401404
POST
/data/api/v1/scim/{profile-name}/{scim-version}/Users
Create User Resource
create-user-resource-post 2 params body → 200400401404
GET
/data/api/v1/scim/{profile-name}/{scim-version}/Users/{user-id}
Get User Resource
get-user-resource-get 3 params → 200400401404
PUT
/data/api/v1/scim/{profile-name}/{scim-version}/Users/{user-id}
Modify User Resource
modify-user-resource-put 3 params → 200400401404
DELETE
/data/api/v1/scim/{profile-name}/{scim-version}/Users/{user-id}
Delete User Resource
delete-user-resource-delete 3 params → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-user-management-scim-api-openapi.yml Raw ↑

Other APIs Inductive Automation publishes across the network.

Ignition Gateway REST API
Inductive Automation access-control API
Inductive Automation agent-group API
Inductive Automation agent-management API
Inductive Automation alarm-journal-resources API
Inductive Automation alarm-notification-profile API
Inductive Automation api-token API
Inductive Automation audit API
Inductive Automation call-script API
Inductive Automation certificate-management API
Inductive Automation charts-info API
Inductive Automation client-pki-certificate-management API