SDA GraphQL Ident API Reference

🚀 Welcome to the SDA GraphQL Ident API

The SDA GraphQL Ident API Reference contains the Queries, Mutations and Types you can use to interact with the SDA IDENT API to manage users, user-roles and security related settings.

⚠️ This website only contains the Schema reference. For examples and more information, please visit the SDA GraphQL API Examples repository.

Contact

Software Defined Automation

support@softwaredefinedautomation.io

https://www.softwaredefinedautomation.io

License

Apache 2.0

https://www.apache.org/licenses/LICENSE-2.0.html

Terms of Service

https://www.softwaredefinedautomation.io/terms-and-conditions/

API Endpoints

# Ident GraphQL API:
https://api.sdaconsole.io/ident/v1/graphql

Headers

# The token you received from the SDA Console or the API
Authorization: Bearer <YOUR_TOKEN_HERE>

Queries

`readAdditionalTenantsForUser`

Response

Returns a PaginatedTenantResponseType!

Example

Query

query ReadAdditionalTenantsForUser {
  readAdditionalTenantsForUser {
    pages
    items {
      tenantId
      ownerId
      users {
        ...PaginatedUserResponseTypeFragment
      }
      vendors {
        ...VendorResponseTypeFragment
      }
      additionalTenants {
        ...PaginatedTenantResponseTypeFragment
      }
      owner {
        ...OwnerUserResponseTypeFragment
      }
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      companyName
      country
      industry
      isActive
      enforceMfa
      enforceMfaForIdeaas
      importDemoData
      maxUserRoleExpirationDays
      expirationTimestamp
      customLogo
      featureFlags {
        ...FeatureFlagTypeFragment
      }
      existingUser
      ssoEnabled
      manageSsoUsersInSda
    }
    itemCount
  }
}

Response

{
  "data": {
    "readAdditionalTenantsForUser": {
      "pages": 123,
      "items": [TenantResponseType],
      "itemCount": 123
    }
  }
}

Queries

`readAllUserGroups`

Response

Returns a PaginatedUserGroupResponseType!

Arguments

Name	Description
`filter` - `UserGroupFilterInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query ReadAllUserGroups(
  $filter: UserGroupFilterInput,
  $pagination: PaginationInput
) {
  readAllUserGroups(
    filter: $filter,
    pagination: $pagination
  ) {
    pages
    items {
      groupId
      creationUserId
      updateUserId
      creationUser {
        ...LightUserResponseTypeFragment
      }
      updateUser {
        ...LightUserResponseTypeFragment
      }
      objectVersion
      deleteUserId
      creationTimestamp
      updateTimestamp
      users {
        ...PaginatedUserResponseTypeFragment
      }
      subGroups {
        ...PaginatedUserGroupResponseTypeFragment
      }
      name
      groupType
      parentGroupId
      isSystemGroup
    }
    itemCount
  }
}

Variables

{"filter": null, "pagination": null}

Response

{
  "data": {
    "readAllUserGroups": {
      "pages": 987,
      "items": [UserGroupResponseType],
      "itemCount": 123
    }
  }
}

Queries

`readAllUserRoles`

Response

Returns a PaginatedUserRoleResponseType!

Arguments

Name	Description
`filter` - `UserRoleFilterInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query ReadAllUserRoles(
  $filter: UserRoleFilterInput,
  $pagination: PaginationInput
) {
  readAllUserRoles(
    filter: $filter,
    pagination: $pagination
  ) {
    pages
    items {
      userRoleId
      creationUserId
      updateUserId
      creationUser {
        ...LightUserResponseTypeFragment
      }
      updateUser {
        ...LightUserResponseTypeFragment
      }
      objectVersion
      deleteUserId
      creationTimestamp
      updateTimestamp
      users {
        ...PaginatedUserResponseTypeFragment
      }
      name
      groupId
      description
      policies {
        ...PolicyTypeFragment
      }
      isSystemRole
      ssoGroupMapping
    }
    itemCount
  }
}

Variables

{"filter": null, "pagination": null}

Response

{
  "data": {
    "readAllUserRoles": {
      "pages": 123,
      "items": [UserRoleResponseType],
      "itemCount": 123
    }
  }
}

Queries

`readAllUsers`

Response

Returns a PaginatedUserResponseType!

Arguments

Name	Description
`filter` - `UserFilterInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query ReadAllUsers(
  $filter: UserFilterInput,
  $pagination: PaginationInput
) {
  readAllUsers(
    filter: $filter,
    pagination: $pagination
  ) {
    pages
    items {
      userId
      creationUserId
      updateUserId
      creationUser {
        ...LightUserResponseTypeFragment
      }
      updateUser {
        ...LightUserResponseTypeFragment
      }
      objectVersion
      deleteUserId
      creationTimestamp
      updateTimestamp
      userRoles {
        ...PaginatedUserRoleResponseTypeFragment
      }
      groupId
      firstName
      lastName
      email
      companyName
      phoneNumber
      privacyAccepted
      locale
      lastLoginTimestamp
      title
      agreeToContact
      uiSlots {
        ...UiSlotCardTypeFragment
      }
      source
    }
    itemCount
  }
}

Variables

{"filter": null, "pagination": null}

Response

{
  "data": {
    "readAllUsers": {
      "pages": 987,
      "items": [UserResponseType],
      "itemCount": 987
    }
  }
}

Queries

`readSubGroupsForUserGroup`

Response

Returns a PaginatedUserGroupResponseType!

Arguments

Name	Description
`parentGroupId` - `String!`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query ReadSubGroupsForUserGroup(
  $parentGroupId: String!,
  $pagination: PaginationInput
) {
  readSubGroupsForUserGroup(
    parentGroupId: $parentGroupId,
    pagination: $pagination
  ) {
    pages
    items {
      groupId
      creationUserId
      updateUserId
      creationUser {
        ...LightUserResponseTypeFragment
      }
      updateUser {
        ...LightUserResponseTypeFragment
      }
      objectVersion
      deleteUserId
      creationTimestamp
      updateTimestamp
      users {
        ...PaginatedUserResponseTypeFragment
      }
      subGroups {
        ...PaginatedUserGroupResponseTypeFragment
      }
      name
      groupType
      parentGroupId
      isSystemGroup
    }
    itemCount
  }
}

Variables

{
  "parentGroupId": "abc123",
  "pagination": null
}

Response

{
  "data": {
    "readSubGroupsForUserGroup": {
      "pages": 987,
      "items": [UserGroupResponseType],
      "itemCount": 987
    }
  }
}

Queries

`readTenant`

Response

Returns a TenantResponseType!

Example

Query

query ReadTenant {
  readTenant {
    tenantId
    ownerId
    users {
      pages
      items {
        ...UserResponseTypeFragment
      }
      itemCount
    }
    vendors {
      vendorId
      name
      requiredFeatureFlag
      ides {
        ...IdeConfigResponseTypeFragment
      }
      licenseConfig {
        ...LicenseConfigTypeFragment
      }
    }
    additionalTenants {
      pages
      items {
        ...TenantResponseTypeFragment
      }
      itemCount
    }
    owner {
      firstName
      lastName
      email
    }
    objectVersion
    creationUserId
    updateUserId
    deleteUserId
    creationTimestamp
    updateTimestamp
    companyName
    country
    industry
    isActive
    enforceMfa
    enforceMfaForIdeaas
    importDemoData
    maxUserRoleExpirationDays
    expirationTimestamp
    customLogo
    featureFlags {
      featureName
      isEnabled
      description
    }
    existingUser
    ssoEnabled
    manageSsoUsersInSda
  }
}

Response

{
  "data": {
    "readTenant": {
      "tenantId": "xyz789",
      "ownerId": "xyz789",
      "users": PaginatedUserResponseType,
      "vendors": [VendorResponseType],
      "additionalTenants": PaginatedTenantResponseType,
      "owner": OwnerUserResponseType,
      "objectVersion": 987,
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "deleteUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "companyName": "abc123",
      "country": "abc123",
      "industry": "abc123",
      "isActive": true,
      "enforceMfa": false,
      "enforceMfaForIdeaas": true,
      "importDemoData": false,
      "maxUserRoleExpirationDays": 987,
      "expirationTimestamp": "2007-12-03T10:15:30Z",
      "customLogo": "abc123",
      "featureFlags": [FeatureFlagType],
      "existingUser": true,
      "ssoEnabled": false,
      "manageSsoUsersInSda": true
    }
  }
}

Queries

`readUser`

Response

Returns a UserResponseType!

Arguments

Name	Description
`userId` - `String!`

Example

Query

query ReadUser($userId: String!) {
  readUser(userId: $userId) {
    userId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    userRoles {
      pages
      items {
        ...UserRoleResponseTypeFragment
      }
      itemCount
    }
    groupId
    firstName
    lastName
    email
    companyName
    phoneNumber
    privacyAccepted
    locale
    lastLoginTimestamp
    title
    agreeToContact
    uiSlots {
      id
      slot
    }
    source
  }
}

Variables

{"userId": "xyz789"}

Response

{
  "data": {
    "readUser": {
      "userId": "xyz789",
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 987,
      "deleteUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "userRoles": PaginatedUserRoleResponseType,
      "groupId": "abc123",
      "firstName": "abc123",
      "lastName": "xyz789",
      "email": "xyz789",
      "companyName": "xyz789",
      "phoneNumber": "abc123",
      "privacyAccepted": false,
      "locale": "xyz789",
      "lastLoginTimestamp": "2007-12-03T10:15:30Z",
      "title": "abc123",
      "agreeToContact": false,
      "uiSlots": [UiSlotCardType],
      "source": "SDA"
    }
  }
}

Queries

`readUserGroup`

Response

Returns a UserGroupResponseType!

Arguments

Name	Description
`groupId` - `String!`

Example

Query

query ReadUserGroup($groupId: String!) {
  readUserGroup(groupId: $groupId) {
    groupId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    users {
      pages
      items {
        ...UserResponseTypeFragment
      }
      itemCount
    }
    subGroups {
      pages
      items {
        ...UserGroupResponseTypeFragment
      }
      itemCount
    }
    name
    groupType
    parentGroupId
    isSystemGroup
  }
}

Variables

{"groupId": "abc123"}

Response

{
  "data": {
    "readUserGroup": {
      "groupId": "abc123",
      "creationUserId": "xyz789",
      "updateUserId": "abc123",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 987,
      "deleteUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "users": PaginatedUserResponseType,
      "subGroups": PaginatedUserGroupResponseType,
      "name": "xyz789",
      "groupType": "USER",
      "parentGroupId": "xyz789",
      "isSystemGroup": true
    }
  }
}

Queries

`readUserGroupsByIds`

Response

Returns a PaginatedUserGroupResponseType!

Arguments

Name	Description
`groupIds` - `[String!]!`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query ReadUserGroupsByIds(
  $groupIds: [String!]!,
  $pagination: PaginationInput
) {
  readUserGroupsByIds(
    groupIds: $groupIds,
    pagination: $pagination
  ) {
    pages
    items {
      groupId
      creationUserId
      updateUserId
      creationUser {
        ...LightUserResponseTypeFragment
      }
      updateUser {
        ...LightUserResponseTypeFragment
      }
      objectVersion
      deleteUserId
      creationTimestamp
      updateTimestamp
      users {
        ...PaginatedUserResponseTypeFragment
      }
      subGroups {
        ...PaginatedUserGroupResponseTypeFragment
      }
      name
      groupType
      parentGroupId
      isSystemGroup
    }
    itemCount
  }
}

Variables

{"groupIds": ["abc123"], "pagination": null}

Response

{
  "data": {
    "readUserGroupsByIds": {
      "pages": 987,
      "items": [UserGroupResponseType],
      "itemCount": 123
    }
  }
}

Queries

`readUserRole`

Response

Returns a UserRoleResponseType!

Arguments

Name	Description
`userRoleId` - `String!`

Example

Query

query ReadUserRole($userRoleId: String!) {
  readUserRole(userRoleId: $userRoleId) {
    userRoleId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    users {
      pages
      items {
        ...UserResponseTypeFragment
      }
      itemCount
    }
    name
    groupId
    description
    policies {
      policyId
      name
      action
      resource
      description
    }
    isSystemRole
    ssoGroupMapping
  }
}

Variables

{"userRoleId": "abc123"}

Response

{
  "data": {
    "readUserRole": {
      "userRoleId": "xyz789",
      "creationUserId": "abc123",
      "updateUserId": "xyz789",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 987,
      "deleteUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "users": PaginatedUserResponseType,
      "name": "xyz789",
      "groupId": "abc123",
      "description": "abc123",
      "policies": [PolicyType],
      "isSystemRole": false,
      "ssoGroupMapping": ["abc123"]
    }
  }
}

Queries

`readUserRoleUserLinksForUser`

Response

Returns a PaginatedUserRoleUserLinkResponseType!

Arguments

Name	Description
`userId` - `String!`

Example

Query

query ReadUserRoleUserLinksForUser($userId: String!) {
  readUserRoleUserLinksForUser(userId: $userId) {
    pages
    items {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userRoleId
      userId
      expirationTimestamp
    }
    itemCount
  }
}

Variables

{"userId": "xyz789"}

Response

{
  "data": {
    "readUserRoleUserLinksForUser": {
      "pages": 987,
      "items": [UserRoleUserLinkResponseType],
      "itemCount": 987
    }
  }
}

Queries

`readUserRoleUserLinksForUserRole`

Response

Returns a PaginatedUserRoleUserLinkResponseType!

Arguments

Name	Description
`userRoleId` - `String!`

Example

Query

query ReadUserRoleUserLinksForUserRole($userRoleId: String!) {
  readUserRoleUserLinksForUserRole(userRoleId: $userRoleId) {
    pages
    items {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userRoleId
      userId
      expirationTimestamp
    }
    itemCount
  }
}

Variables

{"userRoleId": "abc123"}

Response

{
  "data": {
    "readUserRoleUserLinksForUserRole": {
      "pages": 987,
      "items": [UserRoleUserLinkResponseType],
      "itemCount": 123
    }
  }
}

Queries

`readUserRolesForUser`

Response

Returns a PaginatedUserRoleResponseType!

Arguments

Name	Description
`userId` - `String!`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query ReadUserRolesForUser(
  $userId: String!,
  $pagination: PaginationInput
) {
  readUserRolesForUser(
    userId: $userId,
    pagination: $pagination
  ) {
    pages
    items {
      userRoleId
      creationUserId
      updateUserId
      creationUser {
        ...LightUserResponseTypeFragment
      }
      updateUser {
        ...LightUserResponseTypeFragment
      }
      objectVersion
      deleteUserId
      creationTimestamp
      updateTimestamp
      users {
        ...PaginatedUserResponseTypeFragment
      }
      name
      groupId
      description
      policies {
        ...PolicyTypeFragment
      }
      isSystemRole
      ssoGroupMapping
    }
    itemCount
  }
}

Variables

{"userId": "xyz789", "pagination": null}

Response

{
  "data": {
    "readUserRolesForUser": {
      "pages": 987,
      "items": [UserRoleResponseType],
      "itemCount": 123
    }
  }
}

Queries

`readUsersForUserGroup`

Response

Returns a PaginatedUserResponseType!

Arguments

Name	Description
`groupId` - `String!`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query ReadUsersForUserGroup(
  $groupId: String!,
  $pagination: PaginationInput
) {
  readUsersForUserGroup(
    groupId: $groupId,
    pagination: $pagination
  ) {
    pages
    items {
      userId
      creationUserId
      updateUserId
      creationUser {
        ...LightUserResponseTypeFragment
      }
      updateUser {
        ...LightUserResponseTypeFragment
      }
      objectVersion
      deleteUserId
      creationTimestamp
      updateTimestamp
      userRoles {
        ...PaginatedUserRoleResponseTypeFragment
      }
      groupId
      firstName
      lastName
      email
      companyName
      phoneNumber
      privacyAccepted
      locale
      lastLoginTimestamp
      title
      agreeToContact
      uiSlots {
        ...UiSlotCardTypeFragment
      }
      source
    }
    itemCount
  }
}

Variables

{"groupId": "abc123", "pagination": null}

Response

{
  "data": {
    "readUsersForUserGroup": {
      "pages": 987,
      "items": [UserResponseType],
      "itemCount": 987
    }
  }
}

Queries

`readUsersForUserRole`

Response

Returns a PaginatedUserResponseType!

Arguments

Name	Description
`userRoleId` - `String!`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query ReadUsersForUserRole(
  $userRoleId: String!,
  $pagination: PaginationInput
) {
  readUsersForUserRole(
    userRoleId: $userRoleId,
    pagination: $pagination
  ) {
    pages
    items {
      userId
      creationUserId
      updateUserId
      creationUser {
        ...LightUserResponseTypeFragment
      }
      updateUser {
        ...LightUserResponseTypeFragment
      }
      objectVersion
      deleteUserId
      creationTimestamp
      updateTimestamp
      userRoles {
        ...PaginatedUserRoleResponseTypeFragment
      }
      groupId
      firstName
      lastName
      email
      companyName
      phoneNumber
      privacyAccepted
      locale
      lastLoginTimestamp
      title
      agreeToContact
      uiSlots {
        ...UiSlotCardTypeFragment
      }
      source
    }
    itemCount
  }
}

Variables

{"userRoleId": "xyz789", "pagination": null}

Response

{
  "data": {
    "readUsersForUserRole": {
      "pages": 123,
      "items": [UserResponseType],
      "itemCount": 123
    }
  }
}

Mutations

`createUser`

Response

Returns a UserResponseType!

Arguments

Name	Description
`user` - `CreateUserInput!`

Example

Query

mutation CreateUser($user: CreateUserInput!) {
  createUser(user: $user) {
    userId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    userRoles {
      pages
      items {
        ...UserRoleResponseTypeFragment
      }
      itemCount
    }
    groupId
    firstName
    lastName
    email
    companyName
    phoneNumber
    privacyAccepted
    locale
    lastLoginTimestamp
    title
    agreeToContact
    uiSlots {
      id
      slot
    }
    source
  }
}

Variables

{"user": CreateUserInput}

Response

{
  "data": {
    "createUser": {
      "userId": "xyz789",
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 987,
      "deleteUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "userRoles": PaginatedUserRoleResponseType,
      "groupId": "xyz789",
      "firstName": "xyz789",
      "lastName": "xyz789",
      "email": "abc123",
      "companyName": "xyz789",
      "phoneNumber": "xyz789",
      "privacyAccepted": false,
      "locale": "abc123",
      "lastLoginTimestamp": "2007-12-03T10:15:30Z",
      "title": "abc123",
      "agreeToContact": true,
      "uiSlots": [UiSlotCardType],
      "source": "SDA"
    }
  }
}

Mutations

`createUserGroup`

Response

Returns a UserGroupResponseType!

Arguments

Name	Description
`userGroup` - `CreateUserGroupInput!`

Example

Query

mutation CreateUserGroup($userGroup: CreateUserGroupInput!) {
  createUserGroup(userGroup: $userGroup) {
    groupId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    users {
      pages
      items {
        ...UserResponseTypeFragment
      }
      itemCount
    }
    subGroups {
      pages
      items {
        ...UserGroupResponseTypeFragment
      }
      itemCount
    }
    name
    groupType
    parentGroupId
    isSystemGroup
  }
}

Variables

{"userGroup": CreateUserGroupInput}

Response

{
  "data": {
    "createUserGroup": {
      "groupId": "xyz789",
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 123,
      "deleteUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "users": PaginatedUserResponseType,
      "subGroups": PaginatedUserGroupResponseType,
      "name": "xyz789",
      "groupType": "USER",
      "parentGroupId": "abc123",
      "isSystemGroup": true
    }
  }
}

Mutations

`createUserRole`

Response

Returns a UserRoleResponseType!

Arguments

Name	Description
`userRole` - `CreateUserRoleInput!`

Example

Query

mutation CreateUserRole($userRole: CreateUserRoleInput!) {
  createUserRole(userRole: $userRole) {
    userRoleId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    users {
      pages
      items {
        ...UserResponseTypeFragment
      }
      itemCount
    }
    name
    groupId
    description
    policies {
      policyId
      name
      action
      resource
      description
    }
    isSystemRole
    ssoGroupMapping
  }
}

Variables

{"userRole": CreateUserRoleInput}

Response

{
  "data": {
    "createUserRole": {
      "userRoleId": "abc123",
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 123,
      "deleteUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "users": PaginatedUserResponseType,
      "name": "abc123",
      "groupId": "xyz789",
      "description": "xyz789",
      "policies": [PolicyType],
      "isSystemRole": false,
      "ssoGroupMapping": ["xyz789"]
    }
  }
}

Mutations

`createUserRoleUserLink`

Response

Returns a UserRoleUserLinkResponseType!

Arguments

Name	Description
`userRoleId` - `String!`
`userId` - `String!`
`input` - `CreateUserRoleUserLinkInput!`

Example

Query

mutation CreateUserRoleUserLink(
  $userRoleId: String!,
  $userId: String!,
  $input: CreateUserRoleUserLinkInput!
) {
  createUserRoleUserLink(
    userRoleId: $userRoleId,
    userId: $userId,
    input: $input
  ) {
    objectVersion
    creationUserId
    updateUserId
    deleteUserId
    creationTimestamp
    updateTimestamp
    userRoleId
    userId
    expirationTimestamp
  }
}

Variables

{
  "userRoleId": "xyz789",
  "userId": "xyz789",
  "input": CreateUserRoleUserLinkInput
}

Response

{
  "data": {
    "createUserRoleUserLink": {
      "objectVersion": 123,
      "creationUserId": "abc123",
      "updateUserId": "xyz789",
      "deleteUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "userRoleId": "abc123",
      "userId": "abc123",
      "expirationTimestamp": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`deleteUser`

Response

Returns a UserResponseType!

Arguments

Name	Description
`userId` - `String!`

Example

Query

mutation DeleteUser($userId: String!) {
  deleteUser(userId: $userId) {
    userId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    userRoles {
      pages
      items {
        ...UserRoleResponseTypeFragment
      }
      itemCount
    }
    groupId
    firstName
    lastName
    email
    companyName
    phoneNumber
    privacyAccepted
    locale
    lastLoginTimestamp
    title
    agreeToContact
    uiSlots {
      id
      slot
    }
    source
  }
}

Variables

{"userId": "abc123"}

Response

{
  "data": {
    "deleteUser": {
      "userId": "abc123",
      "creationUserId": "xyz789",
      "updateUserId": "xyz789",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 123,
      "deleteUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "userRoles": PaginatedUserRoleResponseType,
      "groupId": "xyz789",
      "firstName": "abc123",
      "lastName": "abc123",
      "email": "abc123",
      "companyName": "xyz789",
      "phoneNumber": "abc123",
      "privacyAccepted": false,
      "locale": "xyz789",
      "lastLoginTimestamp": "2007-12-03T10:15:30Z",
      "title": "xyz789",
      "agreeToContact": false,
      "uiSlots": [UiSlotCardType],
      "source": "SDA"
    }
  }
}

Mutations

`deleteUserGroup`

Response

Returns a UserGroupResponseType!

Arguments

Name	Description
`groupId` - `String!`

Example

Query

mutation DeleteUserGroup($groupId: String!) {
  deleteUserGroup(groupId: $groupId) {
    groupId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    users {
      pages
      items {
        ...UserResponseTypeFragment
      }
      itemCount
    }
    subGroups {
      pages
      items {
        ...UserGroupResponseTypeFragment
      }
      itemCount
    }
    name
    groupType
    parentGroupId
    isSystemGroup
  }
}

Variables

{"groupId": "xyz789"}

Response

{
  "data": {
    "deleteUserGroup": {
      "groupId": "abc123",
      "creationUserId": "xyz789",
      "updateUserId": "abc123",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 123,
      "deleteUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "users": PaginatedUserResponseType,
      "subGroups": PaginatedUserGroupResponseType,
      "name": "xyz789",
      "groupType": "USER",
      "parentGroupId": "abc123",
      "isSystemGroup": true
    }
  }
}

Mutations

`deleteUserRole`

Response

Returns a UserRoleResponseType!

Arguments

Name	Description
`userRoleId` - `String!`

Example

Query

mutation DeleteUserRole($userRoleId: String!) {
  deleteUserRole(userRoleId: $userRoleId) {
    userRoleId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    users {
      pages
      items {
        ...UserResponseTypeFragment
      }
      itemCount
    }
    name
    groupId
    description
    policies {
      policyId
      name
      action
      resource
      description
    }
    isSystemRole
    ssoGroupMapping
  }
}

Variables

{"userRoleId": "abc123"}

Response

{
  "data": {
    "deleteUserRole": {
      "userRoleId": "abc123",
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 123,
      "deleteUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "users": PaginatedUserResponseType,
      "name": "abc123",
      "groupId": "xyz789",
      "description": "xyz789",
      "policies": [PolicyType],
      "isSystemRole": false,
      "ssoGroupMapping": ["xyz789"]
    }
  }
}

Mutations

`deleteUserRoleUserLink`

Response

Returns a Void

Arguments

Name	Description
`userRoleId` - `String!`
`userId` - `String!`

Example

Query

mutation DeleteUserRoleUserLink(
  $userRoleId: String!,
  $userId: String!
) {
  deleteUserRoleUserLink(
    userRoleId: $userRoleId,
    userId: $userId
  )
}

Variables

{
  "userRoleId": "abc123",
  "userId": "abc123"
}

Response

{"data": {"deleteUserRoleUserLink": null}}

Mutations

`selectTenant`

Response

Returns a Void

Arguments

Name	Description
`tenantId` - `String!`

Example

Query

mutation SelectTenant($tenantId: String!) {
  selectTenant(tenantId: $tenantId)
}

Variables

{"tenantId": "abc123"}

Response

{"data": {"selectTenant": null}}

Mutations

`updateTenant`

Response

Returns a TenantResponseType!

Arguments

Name	Description
`tenant` - `UpdateTenantInput!`

Example

Query

mutation UpdateTenant($tenant: UpdateTenantInput!) {
  updateTenant(tenant: $tenant) {
    tenantId
    ownerId
    users {
      pages
      items {
        ...UserResponseTypeFragment
      }
      itemCount
    }
    vendors {
      vendorId
      name
      requiredFeatureFlag
      ides {
        ...IdeConfigResponseTypeFragment
      }
      licenseConfig {
        ...LicenseConfigTypeFragment
      }
    }
    additionalTenants {
      pages
      items {
        ...TenantResponseTypeFragment
      }
      itemCount
    }
    owner {
      firstName
      lastName
      email
    }
    objectVersion
    creationUserId
    updateUserId
    deleteUserId
    creationTimestamp
    updateTimestamp
    companyName
    country
    industry
    isActive
    enforceMfa
    enforceMfaForIdeaas
    importDemoData
    maxUserRoleExpirationDays
    expirationTimestamp
    customLogo
    featureFlags {
      featureName
      isEnabled
      description
    }
    existingUser
    ssoEnabled
    manageSsoUsersInSda
  }
}

Variables

{"tenant": UpdateTenantInput}

Response

{
  "data": {
    "updateTenant": {
      "tenantId": "xyz789",
      "ownerId": "xyz789",
      "users": PaginatedUserResponseType,
      "vendors": [VendorResponseType],
      "additionalTenants": PaginatedTenantResponseType,
      "owner": OwnerUserResponseType,
      "objectVersion": 987,
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "deleteUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "companyName": "abc123",
      "country": "xyz789",
      "industry": "xyz789",
      "isActive": true,
      "enforceMfa": false,
      "enforceMfaForIdeaas": false,
      "importDemoData": false,
      "maxUserRoleExpirationDays": 123,
      "expirationTimestamp": "2007-12-03T10:15:30Z",
      "customLogo": "abc123",
      "featureFlags": [FeatureFlagType],
      "existingUser": false,
      "ssoEnabled": true,
      "manageSsoUsersInSda": false
    }
  }
}

Mutations

`updateUser`

Response

Returns a UserResponseType!

Arguments

Name	Description
`userId` - `String!`
`user` - `UpdateUserInput!`

Example

Query

mutation UpdateUser(
  $userId: String!,
  $user: UpdateUserInput!
) {
  updateUser(
    userId: $userId,
    user: $user
  ) {
    userId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    userRoles {
      pages
      items {
        ...UserRoleResponseTypeFragment
      }
      itemCount
    }
    groupId
    firstName
    lastName
    email
    companyName
    phoneNumber
    privacyAccepted
    locale
    lastLoginTimestamp
    title
    agreeToContact
    uiSlots {
      id
      slot
    }
    source
  }
}

Variables

{
  "userId": "abc123",
  "user": UpdateUserInput
}

Response

{
  "data": {
    "updateUser": {
      "userId": "abc123",
      "creationUserId": "xyz789",
      "updateUserId": "abc123",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 987,
      "deleteUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "userRoles": PaginatedUserRoleResponseType,
      "groupId": "xyz789",
      "firstName": "abc123",
      "lastName": "abc123",
      "email": "abc123",
      "companyName": "abc123",
      "phoneNumber": "abc123",
      "privacyAccepted": false,
      "locale": "abc123",
      "lastLoginTimestamp": "2007-12-03T10:15:30Z",
      "title": "abc123",
      "agreeToContact": false,
      "uiSlots": [UiSlotCardType],
      "source": "SDA"
    }
  }
}

Mutations

`updateUserGroup`

Response

Returns a UserGroupResponseType!

Arguments

Name	Description
`groupId` - `String!`
`userGroup` - `UpdateUserGroupInput!`

Example

Query

mutation UpdateUserGroup(
  $groupId: String!,
  $userGroup: UpdateUserGroupInput!
) {
  updateUserGroup(
    groupId: $groupId,
    userGroup: $userGroup
  ) {
    groupId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    users {
      pages
      items {
        ...UserResponseTypeFragment
      }
      itemCount
    }
    subGroups {
      pages
      items {
        ...UserGroupResponseTypeFragment
      }
      itemCount
    }
    name
    groupType
    parentGroupId
    isSystemGroup
  }
}

Variables

{
  "groupId": "abc123",
  "userGroup": UpdateUserGroupInput
}

Response

{
  "data": {
    "updateUserGroup": {
      "groupId": "abc123",
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 123,
      "deleteUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "users": PaginatedUserResponseType,
      "subGroups": PaginatedUserGroupResponseType,
      "name": "xyz789",
      "groupType": "USER",
      "parentGroupId": "abc123",
      "isSystemGroup": false
    }
  }
}

Mutations

`updateUserRole`

Response

Returns a UserRoleResponseType!

Arguments

Name	Description
`userRoleId` - `String!`
`userRole` - `UpdateUserRoleInput!`

Example

Query

mutation UpdateUserRole(
  $userRoleId: String!,
  $userRole: UpdateUserRoleInput!
) {
  updateUserRole(
    userRoleId: $userRoleId,
    userRole: $userRole
  ) {
    userRoleId
    creationUserId
    updateUserId
    creationUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    updateUser {
      objectVersion
      creationUserId
      updateUserId
      deleteUserId
      creationTimestamp
      updateTimestamp
      userId
      groupId
      firstName
      lastName
      email
    }
    objectVersion
    deleteUserId
    creationTimestamp
    updateTimestamp
    users {
      pages
      items {
        ...UserResponseTypeFragment
      }
      itemCount
    }
    name
    groupId
    description
    policies {
      policyId
      name
      action
      resource
      description
    }
    isSystemRole
    ssoGroupMapping
  }
}

Variables

{
  "userRoleId": "xyz789",
  "userRole": UpdateUserRoleInput
}

Response

{
  "data": {
    "updateUserRole": {
      "userRoleId": "xyz789",
      "creationUserId": "xyz789",
      "updateUserId": "abc123",
      "creationUser": LightUserResponseType,
      "updateUser": LightUserResponseType,
      "objectVersion": 987,
      "deleteUserId": "xyz789",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "users": PaginatedUserResponseType,
      "name": "abc123",
      "groupId": "abc123",
      "description": "abc123",
      "policies": [PolicyType],
      "isSystemRole": false,
      "ssoGroupMapping": ["xyz789"]
    }
  }
}

Mutations

`updateUserRoleUserLink`

Response

Returns a UserRoleUserLinkResponseType!

Arguments

Name	Description
`userRoleId` - `String!`
`userId` - `String!`
`input` - `UpdateUserRoleUserLinkInput!`

Example

Query

mutation UpdateUserRoleUserLink(
  $userRoleId: String!,
  $userId: String!,
  $input: UpdateUserRoleUserLinkInput!
) {
  updateUserRoleUserLink(
    userRoleId: $userRoleId,
    userId: $userId,
    input: $input
  ) {
    objectVersion
    creationUserId
    updateUserId
    deleteUserId
    creationTimestamp
    updateTimestamp
    userRoleId
    userId
    expirationTimestamp
  }
}

Variables

{
  "userRoleId": "xyz789",
  "userId": "abc123",
  "input": UpdateUserRoleUserLinkInput
}

Response

{
  "data": {
    "updateUserRoleUserLink": {
      "objectVersion": 987,
      "creationUserId": "abc123",
      "updateUserId": "abc123",
      "deleteUserId": "abc123",
      "creationTimestamp": "2007-12-03T10:15:30Z",
      "updateTimestamp": "2007-12-03T10:15:30Z",
      "userRoleId": "abc123",
      "userId": "abc123",
      "expirationTimestamp": "2007-12-03T10:15:30Z"
    }
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

true

Types

CreateUserGroupInput

Fields

Input Field	Description
`name` - `String!`
`groupType` - `ResourceGroupTypeEnum!`
`parentGroupId` - `String`

Example

{
  "name": "xyz789",
  "groupType": "USER",
  "parentGroupId": "xyz789"
}

Types

CreateUserInput

Fields

Input Field	Description
`groupId` - `String`
`firstName` - `String!`
`lastName` - `String!`
`email` - `String!`
`companyName` - `String`
`phoneNumber` - `String`
`privacyAccepted` - `Boolean`
`locale` - `String`
`lastLoginTimestamp` - `DateTime`
`title` - `String`
`agreeToContact` - `Boolean`
`password` - `String`
`passwordConfirmation` - `String`

Example

{
  "groupId": "xyz789",
  "firstName": "xyz789",
  "lastName": "abc123",
  "email": "xyz789",
  "companyName": "abc123",
  "phoneNumber": "abc123",
  "privacyAccepted": false,
  "locale": "abc123",
  "lastLoginTimestamp": "2007-12-03T10:15:30Z",
  "title": "xyz789",
  "agreeToContact": false,
  "password": "abc123",
  "passwordConfirmation": "xyz789"
}

Types

CreateUserRoleInput

Fields

Input Field	Description
`name` - `String!`
`groupId` - `String`
`description` - `String`
`policies` - `[PolicyInput!]!`
`ssoGroupMapping` - `[String!]`

Example

{
  "name": "abc123",
  "groupId": "xyz789",
  "description": "xyz789",
  "policies": [PolicyInput],
  "ssoGroupMapping": ["xyz789"]
}

Types

CreateUserRoleUserLinkInput

Fields

Input Field	Description
`expirationTimestamp` - `DateTime`

Example

{
  "expirationTimestamp": "2007-12-03T10:15:30Z"
}

Types

DateTime

Description

Date with time (isoformat)

Example

"2007-12-03T10:15:30Z"

Types

DeviceConfigType

Fields

Field Name	Description
`deviceType` - `DeviceTypeEnum!`
`port` - `Int!`
`additionalInputs` - `[FeatureConfigOptionType!]`

Example

{
  "deviceType": "PLC",
  "port": 123,
  "additionalInputs": [FeatureConfigOptionType]
}

Types

DeviceTypeEnum

Values

Enum Value	Description
`PLC`
`HMI`
`AGV`
`ROBOT`
`DRIVE`
`OTHER`

Example

"PLC"

Types

FeatureConfigOptionType

Fields

Field Name	Description
`value` - `String!`
`label` - `String!`
`description` - `String!`
`inputType` - `InputTypeEnum!`
`inputOptions` - `[InputOptionType!]!`
`validationRegex` - `String`
`required` - `Boolean`
`defaultValue` - `JSON`

Example

{
  "value": "xyz789",
  "label": "xyz789",
  "description": "xyz789",
  "inputType": "CHECKBOX",
  "inputOptions": [InputOptionType],
  "validationRegex": "abc123",
  "required": true,
  "defaultValue": {}
}

Types

FeatureConfigType

Fields

Field Name	Description
`feature` - `FeatureEnum!`
`options` - `[FeatureConfigOptionType!]!`
`requiredFeatureFlag` - `String`
`metaData` - `FeatureMetaDataType!`

Example

{
  "feature": "PROJECT_VIEW",
  "options": [FeatureConfigOptionType],
  "requiredFeatureFlag": "xyz789",
  "metaData": FeatureMetaDataType
}

Types

FeatureEnum

Values

Enum Value	Description
`PROJECT_VIEW`
`PROJECT_BACKUP`
`FTP_BACKUP`
`SMB_BACKUP`
`READ_VARIABLE_LIST_FROM_DEVICE`
`DEVICE_SNAPSHOT`
`PROJECT_MERGE`
`PROJECT_CONVERT`
`PROJECT_LIBRARY_UPGRADE`
`PROJECT_UPDATE_OPC_UA_INTERFACE`
`DEVICE_SNAPSHOT_RESTORE`
`WRITE_VARIABLE_LIST_TO_DEVICE`
`DEVICE_FIRMWARE_UPDATE`
`DEVICE_PASSWORD_UPDATE`
`DEPLOYMENT`
`LICENSE_VALIDATE`
`IDEAAS`

Example

"PROJECT_VIEW"

Types

FeatureFlagType

Fields

Field Name	Description
`featureName` - `String!`
`isEnabled` - `Boolean!`
`description` - `String`

Example

{
  "featureName": "abc123",
  "isEnabled": false,
  "description": "abc123"
}

Types

FeatureMetaDataType

Fields

Field Name	Description
`featureType` - `FeatureTypeEnum!`
`projectFileExtensions` - `[FileExtensionMappingType!]`
`deviceTypes` - `[DeviceTypeEnum!]`
`fileExtensionsToDeviceTypes` - `[FileToDeviceTypeMappingType!]`
`fileToFileExtensions` - `[FileToFileTypeMappingType!]`

Example

{
  "featureType": "DEVICE_FEATURE",
  "projectFileExtensions": [FileExtensionMappingType],
  "deviceTypes": ["PLC"],
  "fileExtensionsToDeviceTypes": [
    FileToDeviceTypeMappingType
  ],
  "fileToFileExtensions": [FileToFileTypeMappingType]
}

Types

FeatureTypeEnum

Values

Enum Value	Description
`DEVICE_FEATURE`
`PROJECT_FEATURE`
`PROJECT_DEVICE_FEATURE`
`PROJECT_PROJECT_FEATURE`
`LICENSE_FEATURE`

Example

"DEVICE_FEATURE"

Types

FileExtensionMappingType

Fields

Field Name	Description
`fileExtension` - `String!`
`projectType` - `ProjectTypeEnum!`

Example

{
  "fileExtension": "xyz789",
  "projectType": "STANDARD"
}

Types

FileToDeviceTypeMappingType

Fields

Field Name	Description
`fileExtension` - `String!`
`deviceType` - `DeviceTypeEnum!`
`projectType` - `ProjectTypeEnum!`

Example

{
  "fileExtension": "xyz789",
  "deviceType": "PLC",
  "projectType": "STANDARD"
}

Types

FileToFileTypeMappingType

Fields

Field Name	Description
`fileExtension` - `String!`
`projectType` - `ProjectTypeEnum!`
`destinationFileExtension` - `String!`
`destinationProjectType` - `ProjectTypeEnum!`

Example

{
  "fileExtension": "xyz789",
  "projectType": "STANDARD",
  "destinationFileExtension": "xyz789",
  "destinationProjectType": "STANDARD"
}

Types

FileTypeType

Fields

Field Name	Description
`extension` - `String!`
`description` - `String!`
`projectType` - `ProjectTypeEnum!`

Example

{
  "extension": "xyz789",
  "description": "abc123",
  "projectType": "STANDARD"
}

Types

FilterOperatorEnum

Values

Enum Value	Description
`eq`
`ne`
`contains`
`not_contains`
`begins_with`
`in_`
`gt`
`lt`
`gte`
`lte`
`between`
`contains_any`

Example

"eq"

Types

IdeConfigResponseType

Fields

Field Name	Description
`ideConfigId` - `String!`
`vendorId` - `String!`
`name` - `String!`
`requiredFeatureFlag` - `String`
`features` - `[FeatureConfigType!]!`
`devices` - `[DeviceConfigType!]!`
`fileTypes` - `[FileTypeType!]!`
`factoryAgentAvailable` - `[ProgrammingLanguageEnum!]!`
`availableLanguages` - `[IdeLanguageEnum!]!`
`allowedLicenseVersions` - `[String!]!`
`licenseRequired` - `Boolean!`
`multiDeviceSupport` - `Boolean!`

Example

{
  "ideConfigId": "abc123",
  "vendorId": "xyz789",
  "name": "abc123",
  "requiredFeatureFlag": "abc123",
  "features": [FeatureConfigType],
  "devices": [DeviceConfigType],
  "fileTypes": [FileTypeType],
  "factoryAgentAvailable": ["SCL"],
  "availableLanguages": ["ENGLISH"],
  "allowedLicenseVersions": ["xyz789"],
  "licenseRequired": true,
  "multiDeviceSupport": true
}

Types

IdeLanguageEnum

Values

Enum Value	Description
`ENGLISH`
`GERMAN`
`FRENCH`
`SPANISH`
`ITALIAN`
`CHINESE`

Example

"ENGLISH"

Types

IdentBaseResponseInterface

Fields

Field Name	Description
`creationUserId` - `String`
`updateUserId` - `String`

Possible Types

IdentBaseResponseInterface Types
`UserGroupResponseType`
`UserResponseType`
`UserRoleResponseType`

Example

{
  "creationUserId": "xyz789",
  "updateUserId": "xyz789"
}

Types

InputOptionType

Fields

Field Name	Description
`value` - `JSON!`
`label` - `String!`

Example

{"value": {}, "label": "abc123"}

Types

InputTypeEnum

Values

Enum Value	Description
`CHECKBOX`
`SWITCH`
`RADIO_BUTTON`
`INPUT_TEXT`
`INPUT_NUMBER`
`INPUT_HIDDEN`
`SELECT`

Example

"CHECKBOX"

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

JSON

Description

The JSON scalar type represents JSON values as specified by ECMA-404.

Example

{}

Types

LicenseConfigType

Fields

Field Name	Description
`inputs` - `[FeatureConfigOptionType!]!`

Example

{"inputs": [FeatureConfigOptionType]}

Types

LightUserResponseType

Fields

Field Name	Description
`objectVersion` - `Int`	Version number of the object, used for optimistic locking and change tracking
`creationUserId` - `String`	Unique identifier of the user who created this object
`updateUserId` - `String`	Unique identifier of the user who last updated this object
`deleteUserId` - `String`	Unique identifier of the user who deleted this object
`creationTimestamp` - `DateTime`	Date and time when this object was first created (ISO 8601 format)
`updateTimestamp` - `DateTime`	Date and time when this object was last modified (ISO 8601 format)
`userId` - `String!`
`groupId` - `String`
`firstName` - `String!`
`lastName` - `String!`
`email` - `String!`

Example

{
  "objectVersion": 123,
  "creationUserId": "xyz789",
  "updateUserId": "abc123",
  "deleteUserId": "xyz789",
  "creationTimestamp": "2007-12-03T10:15:30Z",
  "updateTimestamp": "2007-12-03T10:15:30Z",
  "userId": "abc123",
  "groupId": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "email": "abc123"
}

Types

OwnerUserResponseType

Fields

Field Name	Description
`firstName` - `String!`
`lastName` - `String!`
`email` - `String!`

Example

{
  "firstName": "abc123",
  "lastName": "xyz789",
  "email": "xyz789"
}

Types

PaginatedTenantResponseType

Fields

Field Name	Description
`pages` - `Int!`
`items` - `[TenantResponseType]!`
`itemCount` - `Int!`

Example

{
  "pages": 987,
  "items": [TenantResponseType],
  "itemCount": 123
}

Types

PaginatedUserGroupResponseType

Fields

Field Name	Description
`pages` - `Int!`
`items` - `[UserGroupResponseType]!`
`itemCount` - `Int!`

Example

{
  "pages": 123,
  "items": [UserGroupResponseType],
  "itemCount": 123
}

Types

PaginatedUserResponseType

Fields

Field Name	Description
`pages` - `Int!`
`items` - `[UserResponseType]!`
`itemCount` - `Int!`

Example

{
  "pages": 987,
  "items": [UserResponseType],
  "itemCount": 987
}

Types

PaginatedUserRoleResponseType

Fields

Field Name	Description
`pages` - `Int!`
`items` - `[UserRoleResponseType]!`
`itemCount` - `Int!`

Example

{
  "pages": 987,
  "items": [UserRoleResponseType],
  "itemCount": 123
}

Types

PaginatedUserRoleUserLinkResponseType

Fields

Field Name	Description
`pages` - `Int!`
`items` - `[UserRoleUserLinkResponseType]!`
`itemCount` - `Int!`

Example

{
  "pages": 123,
  "items": [UserRoleUserLinkResponseType],
  "itemCount": 987
}

Types

PaginationInput

Fields

Input Field	Description
`pageSize` - `Int`
`page` - `Int`

Example

{"pageSize": 123, "page": 987}

Types

PolicyInput

Fields

Input Field	Description
`policyId` - `String!`
`name` - `String!`
`action` - `[String!]!`
`resource` - `[String!]!`
`description` - `String`

Example

{
  "policyId": "xyz789",
  "name": "xyz789",
  "action": ["abc123"],
  "resource": ["abc123"],
  "description": "xyz789"
}

Types

PolicyType

Fields

Field Name	Description
`policyId` - `String!`
`name` - `String!`
`action` - `[String!]!`
`resource` - `[String!]!`
`description` - `String`

Example

{
  "policyId": "xyz789",
  "name": "abc123",
  "action": ["xyz789"],
  "resource": ["xyz789"],
  "description": "xyz789"
}

Types

ProgrammingLanguageEnum

Values

Enum Value	Description
`SCL`
`ST`
`LAD`
`FBD`
`SFC`
`IL`
`STL`
`F_FBD`
`F_LAD`
`GRAPH`
`RLL`

Example

"SCL"

Types

ProjectTypeEnum

Values

Enum Value	Description
`STANDARD`
`LIBRARY`
`GENERIC`

Example

"STANDARD"

Types

ResourceGroupTypeEnum

Values

Enum Value	Description
`USER`
`ASSET`

Example

"USER"

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"xyz789"

Types

StringFilterIgnoreDdbInput

Fields

Input Field	Description
`eq` - `String`
`ne` - `String`
`gt` - `String`
`lt` - `String`
`gte` - `String`
`lte` - `String`
`contains` - `String`
`containsAny` - `[String!]`
`notContains` - `String`
`beginsWith` - `String`
`in_` - `[String!]`
`between` - `[String!]`
`doNotIgnoreNullable` - `[FilterOperatorEnum!]`
`ignoreForDdbQuery` - `Boolean!`

Example

{
  "eq": "xyz789",
  "ne": "abc123",
  "gt": "xyz789",
  "lt": "abc123",
  "gte": "abc123",
  "lte": "abc123",
  "contains": "abc123",
  "containsAny": ["xyz789"],
  "notContains": "xyz789",
  "beginsWith": "xyz789",
  "in_": ["xyz789"],
  "between": ["abc123"],
  "doNotIgnoreNullable": ["eq"],
  "ignoreForDdbQuery": true
}

Types

StringFilterInput

Fields

Input Field	Description
`eq` - `String`
`ne` - `String`
`gt` - `String`
`lt` - `String`
`gte` - `String`
`lte` - `String`
`contains` - `String`
`containsAny` - `[String!]`
`notContains` - `String`
`beginsWith` - `String`
`in_` - `[String!]`
`between` - `[String!]`
`doNotIgnoreNullable` - `[FilterOperatorEnum!]`

Example

{
  "eq": "abc123",
  "ne": "abc123",
  "gt": "xyz789",
  "lt": "abc123",
  "gte": "xyz789",
  "lte": "abc123",
  "contains": "abc123",
  "containsAny": ["abc123"],
  "notContains": "xyz789",
  "beginsWith": "abc123",
  "in_": ["xyz789"],
  "between": ["xyz789"],
  "doNotIgnoreNullable": ["eq"]
}

Types

TenantResponseInterface

Fields

Field Name	Description
`tenantId` - `String!`
`ownerId` - `String!`

Possible Types

TenantResponseInterface Types
`TenantResponseType`

Example

{
  "tenantId": "xyz789",
  "ownerId": "abc123"
}

Types

TenantResponseType

Fields

Field Name	Description
`tenantId` - `String!`
`ownerId` - `String!`
`users` - `PaginatedUserResponseType!`
Arguments `pagination` - `PaginationInput`
`vendors` - `[VendorResponseType!]!`
`additionalTenants` - `PaginatedTenantResponseType!`
`owner` - `OwnerUserResponseType!`
`objectVersion` - `Int`	Version number of the object, used for optimistic locking and change tracking
`creationUserId` - `String`	Unique identifier of the user who created this object
`updateUserId` - `String`	Unique identifier of the user who last updated this object
`deleteUserId` - `String`	Unique identifier of the user who deleted this object
`creationTimestamp` - `DateTime`	Date and time when this object was first created (ISO 8601 format)
`updateTimestamp` - `DateTime`	Date and time when this object was last modified (ISO 8601 format)
`companyName` - `String!`
`country` - `String`
`industry` - `String`
`isActive` - `Boolean!`
`enforceMfa` - `Boolean`
`enforceMfaForIdeaas` - `Boolean`
`importDemoData` - `Boolean`
`maxUserRoleExpirationDays` - `Int`
`expirationTimestamp` - `DateTime`
`customLogo` - `String`
`featureFlags` - `[FeatureFlagType!]`
`existingUser` - `Boolean`
`ssoEnabled` - `Boolean`
`manageSsoUsersInSda` - `Boolean`

Example

{
  "tenantId": "abc123",
  "ownerId": "xyz789",
  "users": PaginatedUserResponseType,
  "vendors": [VendorResponseType],
  "additionalTenants": PaginatedTenantResponseType,
  "owner": OwnerUserResponseType,
  "objectVersion": 123,
  "creationUserId": "abc123",
  "updateUserId": "xyz789",
  "deleteUserId": "abc123",
  "creationTimestamp": "2007-12-03T10:15:30Z",
  "updateTimestamp": "2007-12-03T10:15:30Z",
  "companyName": "xyz789",
  "country": "xyz789",
  "industry": "xyz789",
  "isActive": false,
  "enforceMfa": false,
  "enforceMfaForIdeaas": false,
  "importDemoData": false,
  "maxUserRoleExpirationDays": 123,
  "expirationTimestamp": "2007-12-03T10:15:30Z",
  "customLogo": "xyz789",
  "featureFlags": [FeatureFlagType],
  "existingUser": false,
  "ssoEnabled": false,
  "manageSsoUsersInSda": false
}

Types

UiSlotCardInput

Fields

Input Field	Description
`id` - `String!`
`slot` - `String!`

Example

{
  "id": "xyz789",
  "slot": "abc123"
}

Types

UiSlotCardType

Fields

Field Name	Description
`id` - `String!`
`slot` - `String!`

Example

{
  "id": "xyz789",
  "slot": "xyz789"
}

Types

UpdateTenantInput

Fields

Input Field	Description
`ownerId` - `String`
`companyName` - `String`
`country` - `String`
`industry` - `String`
`enforceMfa` - `Boolean`
`enforceMfaForIdeaas` - `Boolean`
`importDemoData` - `Boolean`
`maxUserRoleExpirationDays` - `Int`
`objectVersion` - `Int`

Example

{
  "ownerId": "xyz789",
  "companyName": "abc123",
  "country": "abc123",
  "industry": "abc123",
  "enforceMfa": false,
  "enforceMfaForIdeaas": false,
  "importDemoData": true,
  "maxUserRoleExpirationDays": 987,
  "objectVersion": 123
}

Types

UpdateUserGroupInput

Fields

Input Field	Description
`name` - `String`
`parentGroupId` - `String`
`objectVersion` - `Int`

Example

{
  "name": "abc123",
  "parentGroupId": "xyz789",
  "objectVersion": 987
}

Types

UpdateUserInput

Fields

Input Field	Description
`groupId` - `String`
`firstName` - `String`
`lastName` - `String`
`email` - `String`
`companyName` - `String`
`phoneNumber` - `String`
`privacyAccepted` - `Boolean`
`locale` - `String`
`lastLoginTimestamp` - `DateTime`
`title` - `String`
`agreeToContact` - `Boolean`
`uiSlots` - `[UiSlotCardInput!]`
`objectVersion` - `Int`

Example

{
  "groupId": "xyz789",
  "firstName": "abc123",
  "lastName": "xyz789",
  "email": "xyz789",
  "companyName": "abc123",
  "phoneNumber": "abc123",
  "privacyAccepted": false,
  "locale": "abc123",
  "lastLoginTimestamp": "2007-12-03T10:15:30Z",
  "title": "xyz789",
  "agreeToContact": true,
  "uiSlots": [UiSlotCardInput],
  "objectVersion": 987
}

Types

UpdateUserRoleInput

Fields

Input Field	Description
`name` - `String`
`groupId` - `String`
`description` - `String`
`policies` - `[PolicyInput!]`
`ssoGroupMapping` - `[String!]`
`objectVersion` - `Int`

Example

{
  "name": "abc123",
  "groupId": "abc123",
  "description": "xyz789",
  "policies": [PolicyInput],
  "ssoGroupMapping": ["abc123"],
  "objectVersion": 123
}

Types

UpdateUserRoleUserLinkInput

Fields

Input Field	Description
`expirationTimestamp` - `DateTime`
`objectVersion` - `Int`

Example

{
  "expirationTimestamp": "2007-12-03T10:15:30Z",
  "objectVersion": 987
}

Types

UserFilterInput

Fields

Input Field	Description
`creationTimestamp` - `StringFilterInput`
`updateTimestamp` - `StringFilterInput`
`name` - `StringFilterIgnoreDdbInput`
`source` - `StringFilterInput`

Example

{
  "creationTimestamp": StringFilterInput,
  "updateTimestamp": StringFilterInput,
  "name": StringFilterIgnoreDdbInput,
  "source": StringFilterInput
}

Types

UserGroupFilterInput

Fields

Input Field	Description
`creationTimestamp` - `StringFilterInput`
`updateTimestamp` - `StringFilterInput`
`name` - `StringFilterInput`
`nameLower` - `StringFilterInput`
`parentGroupId` - `StringFilterInput`

Example

{
  "creationTimestamp": StringFilterInput,
  "updateTimestamp": StringFilterInput,
  "name": StringFilterInput,
  "nameLower": StringFilterInput,
  "parentGroupId": StringFilterInput
}

Types

UserGroupResponseInterface

Fields

Field Name	Description
`groupId` - `String!`

Possible Types

UserGroupResponseInterface Types
`UserGroupResponseType`

Example

{"groupId": "abc123"}

Types

UserGroupResponseType

Fields

Field Name	Description
`groupId` - `String!`
`creationUserId` - `String`	Unique identifier of the user who created this object
`updateUserId` - `String`	Unique identifier of the user who last updated this object
`creationUser` - `LightUserResponseType`
`updateUser` - `LightUserResponseType`
`objectVersion` - `Int`	Version number of the object, used for optimistic locking and change tracking
`deleteUserId` - `String`	Unique identifier of the user who deleted this object
`creationTimestamp` - `DateTime`	Date and time when this object was first created (ISO 8601 format)
`updateTimestamp` - `DateTime`	Date and time when this object was last modified (ISO 8601 format)
`users` - `PaginatedUserResponseType!`
Arguments `pagination` - `PaginationInput`
`subGroups` - `PaginatedUserGroupResponseType!`
Arguments `pagination` - `PaginationInput`
`name` - `String!`
`groupType` - `ResourceGroupTypeEnum!`
`parentGroupId` - `String`
`isSystemGroup` - `Boolean!`

Example

{
  "groupId": "abc123",
  "creationUserId": "xyz789",
  "updateUserId": "xyz789",
  "creationUser": LightUserResponseType,
  "updateUser": LightUserResponseType,
  "objectVersion": 123,
  "deleteUserId": "xyz789",
  "creationTimestamp": "2007-12-03T10:15:30Z",
  "updateTimestamp": "2007-12-03T10:15:30Z",
  "users": PaginatedUserResponseType,
  "subGroups": PaginatedUserGroupResponseType,
  "name": "xyz789",
  "groupType": "USER",
  "parentGroupId": "abc123",
  "isSystemGroup": false
}

Types

UserResponseInterface

Fields

Field Name	Description
`userId` - `String!`

Possible Types

UserResponseInterface Types
`UserResponseType`

Example

{"userId": "xyz789"}

Types

UserResponseType

Fields

Field Name	Description
`userId` - `String!`
`creationUserId` - `String`	Unique identifier of the user who created this object
`updateUserId` - `String`	Unique identifier of the user who last updated this object
`creationUser` - `LightUserResponseType`
`updateUser` - `LightUserResponseType`
`objectVersion` - `Int`	Version number of the object, used for optimistic locking and change tracking
`deleteUserId` - `String`	Unique identifier of the user who deleted this object
`creationTimestamp` - `DateTime`	Date and time when this object was first created (ISO 8601 format)
`updateTimestamp` - `DateTime`	Date and time when this object was last modified (ISO 8601 format)
`userRoles` - `PaginatedUserRoleResponseType!`
Arguments `pagination` - `PaginationInput`
`groupId` - `String`
`firstName` - `String!`
`lastName` - `String!`
`email` - `String!`
`companyName` - `String`
`phoneNumber` - `String`
`privacyAccepted` - `Boolean`
`locale` - `String`
`lastLoginTimestamp` - `DateTime`
`title` - `String`
`agreeToContact` - `Boolean`
`uiSlots` - `[UiSlotCardType!]`
`source` - `UserSourceEnum!`

Example

{
  "userId": "xyz789",
  "creationUserId": "xyz789",
  "updateUserId": "xyz789",
  "creationUser": LightUserResponseType,
  "updateUser": LightUserResponseType,
  "objectVersion": 123,
  "deleteUserId": "xyz789",
  "creationTimestamp": "2007-12-03T10:15:30Z",
  "updateTimestamp": "2007-12-03T10:15:30Z",
  "userRoles": PaginatedUserRoleResponseType,
  "groupId": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "email": "xyz789",
  "companyName": "xyz789",
  "phoneNumber": "xyz789",
  "privacyAccepted": true,
  "locale": "xyz789",
  "lastLoginTimestamp": "2007-12-03T10:15:30Z",
  "title": "xyz789",
  "agreeToContact": true,
  "uiSlots": [UiSlotCardType],
  "source": "SDA"
}

Types

UserRoleFilterInput

Fields

Input Field	Description
`creationTimestamp` - `StringFilterInput`
`updateTimestamp` - `StringFilterInput`
`name` - `StringFilterInput`
`nameLower` - `StringFilterInput`

Example

{
  "creationTimestamp": StringFilterInput,
  "updateTimestamp": StringFilterInput,
  "name": StringFilterInput,
  "nameLower": StringFilterInput
}

Types

UserRoleResponseInterface

Fields

Field Name	Description
`userRoleId` - `String!`

Possible Types

UserRoleResponseInterface Types
`UserRoleResponseType`

Example

{"userRoleId": "abc123"}

Types

UserRoleResponseType

Fields

Field Name	Description
`userRoleId` - `String!`
`creationUserId` - `String`	Unique identifier of the user who created this object
`updateUserId` - `String`	Unique identifier of the user who last updated this object
`creationUser` - `LightUserResponseType`
`updateUser` - `LightUserResponseType`
`objectVersion` - `Int`	Version number of the object, used for optimistic locking and change tracking
`deleteUserId` - `String`	Unique identifier of the user who deleted this object
`creationTimestamp` - `DateTime`	Date and time when this object was first created (ISO 8601 format)
`updateTimestamp` - `DateTime`	Date and time when this object was last modified (ISO 8601 format)
`users` - `PaginatedUserResponseType!`
Arguments `pagination` - `PaginationInput`
`name` - `String!`
`groupId` - `String`
`description` - `String`
`policies` - `[PolicyType!]!`
`isSystemRole` - `Boolean!`
`ssoGroupMapping` - `[String!]`

Example

{
  "userRoleId": "xyz789",
  "creationUserId": "xyz789",
  "updateUserId": "abc123",
  "creationUser": LightUserResponseType,
  "updateUser": LightUserResponseType,
  "objectVersion": 123,
  "deleteUserId": "abc123",
  "creationTimestamp": "2007-12-03T10:15:30Z",
  "updateTimestamp": "2007-12-03T10:15:30Z",
  "users": PaginatedUserResponseType,
  "name": "abc123",
  "groupId": "abc123",
  "description": "xyz789",
  "policies": [PolicyType],
  "isSystemRole": true,
  "ssoGroupMapping": ["abc123"]
}

Types

UserRoleUserLinkResponseType

Fields

Field Name	Description
`objectVersion` - `Int`	Version number of the object, used for optimistic locking and change tracking
`creationUserId` - `String`	Unique identifier of the user who created this object
`updateUserId` - `String`	Unique identifier of the user who last updated this object
`deleteUserId` - `String`	Unique identifier of the user who deleted this object
`creationTimestamp` - `DateTime`	Date and time when this object was first created (ISO 8601 format)
`updateTimestamp` - `DateTime`	Date and time when this object was last modified (ISO 8601 format)
`userRoleId` - `String!`
`userId` - `String!`
`expirationTimestamp` - `DateTime`

Example

{
  "objectVersion": 987,
  "creationUserId": "abc123",
  "updateUserId": "xyz789",
  "deleteUserId": "xyz789",
  "creationTimestamp": "2007-12-03T10:15:30Z",
  "updateTimestamp": "2007-12-03T10:15:30Z",
  "userRoleId": "xyz789",
  "userId": "xyz789",
  "expirationTimestamp": "2007-12-03T10:15:30Z"
}

Types

UserSourceEnum

Values

Enum Value	Description
`SDA`
`SAML`

Example

"SDA"

Types

VendorResponseType

Fields

Field Name	Description
`vendorId` - `String!`
`name` - `String!`
`requiredFeatureFlag` - `String`
`ides` - `[IdeConfigResponseType!]`
`licenseConfig` - `LicenseConfigType`

Example

{
  "vendorId": "abc123",
  "name": "xyz789",
  "requiredFeatureFlag": "abc123",
  "ides": [IdeConfigResponseType],
  "licenseConfig": LicenseConfigType
}

Types

Void

Description

Represents NULL values

Documentation by Anvil SpectaQL