mago3D GraphQL API Userset Reference

This is a sample server for a mago3D GraphQL API Dataset Reference. You can find out more about mago3D at https://www.mago3d.com.

Experience the Future with mago3D.

Objects represent the past of the city, sensor data represents the present of the city, and digital twins represent the future of the city. mago3D provides optimal solutions for customers through 3D visualization, simulation, machine learning (AI), IoT sensors, and big data analysis.

mago3D LIVE DEMO

Contact

API Support

info@gaia3d.com

License

Apache 2.0

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

Terms of Service

https://mago3d.com/terms

API Endpoints

https://map.gaia3d.com/app/api/userset/graphql

Headers

# Your foo from bar
Authorization: Bearer <YOUR_TOKEN_HERE>

Introduction

This is a sample server for a mago3D GraphQL API Userset Reference. You can find out more about mago3D at https://www.mago3d.com.

Queries

`existsUser`

Response

Returns an ExistsUserResponse!

Arguments

Name	Description
`input` - `ExistsUserInput!`

Example

Query

query existsUser($input: ExistsUserInput!) {
  existsUser(input: $input)
}

Variables

{"input": ExistsUserInput}

Response

{"data": {"existsUser": ExistsUserResult}}

Queries

`profile`

Response

Returns a User!

Example

Query

query profile {
  profile {
    id
    username
    firstName
    lastName
    roles {
      id
      name
      description
      attributes
      composite
      composites {
        ...UserRoleFragment
      }
    }
    groups {
      id
      name
      path
      attributes
      users {
        ...UserFragment
      }
      children {
        ...UserGroupFragment
      }
    }
    email
    cellphones
    telephones
    emailVerified
    enabled
    properties
    createdBy
    createdAt
  }
}

Response

{
  "data": {
    "profile": {
      "id": 4,
      "username": "xyz789",
      "firstName": "xyz789",
      "lastName": "abc123",
      "roles": [UserRole],
      "groups": [UserGroup],
      "email": "abc123",
      "cellphones": ["xyz789"],
      "telephones": ["abc123"],
      "emailVerified": false,
      "enabled": false,
      "properties": {},
      "createdBy": 4,
      "createdAt": "xyz789"
    }
  }
}

Queries

`user`

Response

Returns a User

Arguments

Name	Description
`id` - `ID!`

Example

Query

query user($id: ID!) {
  user(id: $id) {
    id
    username
    firstName
    lastName
    roles {
      id
      name
      description
      attributes
      composite
      composites {
        ...UserRoleFragment
      }
    }
    groups {
      id
      name
      path
      attributes
      users {
        ...UserFragment
      }
      children {
        ...UserGroupFragment
      }
    }
    email
    cellphones
    telephones
    emailVerified
    enabled
    properties
    createdBy
    createdAt
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "user": {
      "id": "4",
      "username": "abc123",
      "firstName": "abc123",
      "lastName": "xyz789",
      "roles": [UserRole],
      "groups": [UserGroup],
      "email": "xyz789",
      "cellphones": ["abc123"],
      "telephones": ["xyz789"],
      "emailVerified": true,
      "enabled": false,
      "properties": {},
      "createdBy": "4",
      "createdAt": "abc123"
    }
  }
}

Queries

`userGroup`

Response

Returns a UserGroup!

Arguments

Name	Description
`id` - `ID!`
`filter` - `UserGroupFilter`

Example

Query

query userGroup(
  $id: ID!,
  $filter: UserGroupFilter
) {
  userGroup(
    id: $id,
    filter: $filter
  ) {
    id
    name
    path
    attributes
    users {
      id
      username
      firstName
      lastName
      roles {
        ...UserRoleFragment
      }
      groups {
        ...UserGroupFragment
      }
      email
      cellphones
      telephones
      emailVerified
      enabled
      properties
      createdBy
      createdAt
    }
    children {
      id
      name
      path
      attributes
      users {
        ...UserFragment
      }
      children {
        ...UserGroupFragment
      }
    }
  }
}

Variables

{"id": 4, "filter": UserGroupFilter}

Response

{
  "data": {
    "userGroup": {
      "id": 4,
      "name": "abc123",
      "path": "abc123",
      "attributes": {},
      "users": [User],
      "children": [UserGroup]
    }
  }
}

Queries

`userGroups`

Response

Returns a UserGroupPaged!

Arguments

Name	Description
`filter` - `UserGroupFilter`
`pageable` - `UserGroupPageable`

Example

Query

query userGroups(
  $filter: UserGroupFilter,
  $pageable: UserGroupPageable
) {
  userGroups(
    filter: $filter,
    pageable: $pageable
  ) {
    items {
      id
      name
      path
      attributes
      users {
        ...UserFragment
      }
      children {
        ...UserGroupFragment
      }
    }
    pageInfo {
      totalPages
      totalItems
      page
      size
      hasNextPage
      hasPreviousPage
    }
  }
}

Variables

{
  "filter": UserGroupFilter,
  "pageable": UserGroupPageable
}

Response

{
  "data": {
    "userGroups": {
      "items": [UserGroup],
      "pageInfo": PaginationInfo
    }
  }
}

Queries

`userRole`

Response

Returns a UserRole!

Arguments

Name	Description
`id` - `ID!`

Example

Query

query userRole($id: ID!) {
  userRole(id: $id) {
    id
    name
    description
    attributes
    composite
    composites {
      id
      name
      description
      attributes
      composite
      composites {
        ...UserRoleFragment
      }
    }
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "userRole": {
      "id": "4",
      "name": "abc123",
      "description": "xyz789",
      "attributes": {},
      "composite": false,
      "composites": [UserRole]
    }
  }
}

Queries

`userRoles`

Response

Returns a UserRolePaged!

Arguments

Name	Description
`filter` - `UserRoleFilter`
`pageable` - `UserRolePageable`

Example

Query

query userRoles(
  $filter: UserRoleFilter,
  $pageable: UserRolePageable
) {
  userRoles(
    filter: $filter,
    pageable: $pageable
  ) {
    items {
      id
      name
      description
      attributes
      composite
      composites {
        ...UserRoleFragment
      }
    }
    pageInfo {
      totalPages
      totalItems
      page
      size
      hasNextPage
      hasPreviousPage
    }
  }
}

Variables

{
  "filter": UserRoleFilter,
  "pageable": UserRolePageable
}

Response

{
  "data": {
    "userRoles": {
      "items": [UserRole],
      "pageInfo": PaginationInfo
    }
  }
}

Queries

`users`

Response

Returns a UserPaged!

Arguments

Name	Description
`filter` - `UserFilter`
`pageable` - `UserPageable`

Example

Query

query users(
  $filter: UserFilter,
  $pageable: UserPageable
) {
  users(
    filter: $filter,
    pageable: $pageable
  ) {
    items {
      id
      username
      firstName
      lastName
      roles {
        ...UserRoleFragment
      }
      groups {
        ...UserGroupFragment
      }
      email
      cellphones
      telephones
      emailVerified
      enabled
      properties
      createdBy
      createdAt
    }
    pageInfo {
      totalPages
      totalItems
      page
      size
      hasNextPage
      hasPreviousPage
    }
  }
}

Variables

{
  "filter": UserFilter,
  "pageable": UserPageable
}

Response

{
  "data": {
    "users": {
      "items": [User],
      "pageInfo": PaginationInfo
    }
  }
}

Mutations

`associateUserRole`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `ID!`
`append` - `[ID!]`
`remove` - `[ID!]`

Example

Query

mutation associateUserRole(
  $id: ID!,
  $append: [ID!],
  $remove: [ID!]
) {
  associateUserRole(
    id: $id,
    append: $append,
    remove: $remove
  )
}

Variables

{"id": 4, "append": [4], "remove": [4]}

Response

{"data": {"associateUserRole": false}}

Mutations

`createUser`

Response

Returns a CreateUserResponse!

Arguments

Name	Description
`input` - `CreateUserInput!`

Example

Query

mutation createUser($input: CreateUserInput!) {
  createUser(input: $input) {
    id
    username
    firstName
    lastName
    email
    groups
    roles
    enabled
    properties
  }
}

Variables

{"input": CreateUserInput}

Response

{
  "data": {
    "createUser": {
      "id": 4,
      "username": "abc123",
      "firstName": "xyz789",
      "lastName": "xyz789",
      "email": "xyz789",
      "groups": [4],
      "roles": ["4"],
      "enabled": true,
      "properties": {}
    }
  }
}

Mutations

`createUserGroup`

Response

Returns a CreateUserGroupResponse!

Arguments

Name	Description
`input` - `CreateUserGroupInput!`

Example

Query

mutation createUserGroup($input: CreateUserGroupInput!) {
  createUserGroup(input: $input) {
    id
    name
    path
    attributes
  }
}

Variables

{"input": CreateUserGroupInput}

Response

{
  "data": {
    "createUserGroup": {
      "id": "4",
      "name": "xyz789",
      "path": "xyz789",
      "attributes": {}
    }
  }
}

Mutations

`createUserRole`

Response

Returns a CreateUserRoleResponse!

Arguments

Name	Description
`input` - `CreateUserRoleInput!`

Example

Query

mutation createUserRole($input: CreateUserRoleInput!) {
  createUserRole(input: $input) {
    id
    name
    description
    attributes
  }
}

Variables

{"input": CreateUserRoleInput}

Response

{
  "data": {
    "createUserRole": {
      "id": "4",
      "name": 4,
      "description": "abc123",
      "attributes": {}
    }
  }
}

Mutations

`deleteUser`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation deleteUser($id: ID!) {
  deleteUser(id: $id)
}

Variables

{"id": 4}

Response

{"data": {"deleteUser": true}}

Mutations

`deleteUserGroup`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation deleteUserGroup($id: ID!) {
  deleteUserGroup(id: $id)
}

Variables

{"id": 4}

Response

{"data": {"deleteUserGroup": true}}

Mutations

`deleteUserRole`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation deleteUserRole($id: ID!) {
  deleteUserRole(id: $id)
}

Variables

{"id": "4"}

Response

{"data": {"deleteUserRole": true}}

Mutations

`joinUser`

Response

Returns a JoinUserResponse!

Arguments

Name	Description
`input` - `JoinUserInput!`

Example

Query

mutation joinUser($input: JoinUserInput!) {
  joinUser(input: $input)
}

Variables

{"input": JoinUserInput}

Response

{"data": {"joinUser": User}}

Mutations

`resetUserPassword`

Response

Returns a ResetUserPasswordResponse!

Arguments

Name	Description
`input` - `ResetUserPasswordInput!`

Example

Query

mutation resetUserPassword($input: ResetUserPasswordInput!) {
  resetUserPassword(input: $input)
}

Variables

{"input": ResetUserPasswordInput}

Response

{"data": {"resetUserPassword": User}}

Mutations

`updateUser`

Response

Returns an UpdateUserResponse!

Arguments

Name	Description
`id` - `ID!`
`input` - `UpdateUserInput!`

Example

Query

mutation updateUser(
  $id: ID!,
  $input: UpdateUserInput!
) {
  updateUser(
    id: $id,
    input: $input
  ) {
    id
    username
    firstName
    lastName
    email
    groups
    roles
    properties
  }
}

Variables

{
  "id": "4",
  "input": UpdateUserInput
}

Response

{
  "data": {
    "updateUser": {
      "id": "4",
      "username": "xyz789",
      "firstName": "xyz789",
      "lastName": "abc123",
      "email": "abc123",
      "groups": [4],
      "roles": [4],
      "properties": {}
    }
  }
}

Mutations

`updateUserGroup`

Response

Returns an UpdateUserGroupResponse!

Arguments

Name	Description
`id` - `ID!`
`input` - `UpdateUserGroupInput!`

Example

Query

mutation updateUserGroup(
  $id: ID!,
  $input: UpdateUserGroupInput!
) {
  updateUserGroup(
    id: $id,
    input: $input
  ) {
    id
    name
    path
    attributes
  }
}

Variables

{
  "id": "4",
  "input": UpdateUserGroupInput
}

Response

{
  "data": {
    "updateUserGroup": {
      "id": 4,
      "name": "xyz789",
      "path": "abc123",
      "attributes": {}
    }
  }
}

Mutations

`updateUserPassword`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `ID!`
`oldPassword` - `String!`
`newPassword` - `String!`

Example

Query

mutation updateUserPassword(
  $id: ID!,
  $oldPassword: String!,
  $newPassword: String!
) {
  updateUserPassword(
    id: $id,
    oldPassword: $oldPassword,
    newPassword: $newPassword
  )
}

Variables

{
  "id": "4",
  "oldPassword": "abc123",
  "newPassword": "xyz789"
}

Response

{"data": {"updateUserPassword": false}}

Mutations

`updateUserRole`

Response

Returns an UpdateUserRoleResponse!

Arguments

Name	Description
`id` - `ID!`
`input` - `UpdateUserRoleInput!`

Example

Query

mutation updateUserRole(
  $id: ID!,
  $input: UpdateUserRoleInput!
) {
  updateUserRole(
    id: $id,
    input: $input
  ) {
    id
    name
    description
    attributes
  }
}

Variables

{"id": 4, "input": UpdateUserRoleInput}

Response

{
  "data": {
    "updateUserRole": {
      "id": 4,
      "name": 4,
      "description": "xyz789",
      "attributes": {}
    }
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

BooleanCriteria

Fields

Input Field	Description
`lt` - `Boolean`
`le` - `Boolean`
`eq` - `Boolean`
`ne` - `Boolean`
`ge` - `Boolean`
`gt` - `Boolean`
`isNull` - `Boolean`
`in` - `[Boolean]`
`notIn` - `[Boolean]`
`between` - `[Boolean]`
`notBetween` - `[Boolean]`
`min` - `BooleanCriteria`
`max` - `BooleanCriteria`

Example

{
  "lt": false,
  "le": false,
  "eq": true,
  "ne": false,
  "ge": true,
  "gt": false,
  "isNull": true,
  "in": [true],
  "notIn": [true],
  "between": [false],
  "notBetween": [false],
  "min": BooleanCriteria,
  "max": BooleanCriteria
}

Types

CommonCriteria

Fields

Input Field	Description
`lt` - `ID`
`le` - `ID`
`eq` - `ID`
`ne` - `ID`
`ge` - `ID`
`gt` - `ID`
`isNull` - `Boolean`
`in` - `[ID]`
`notIn` - `[ID]`
`between` - `[ID]`
`notBetween` - `[ID]`
`min` - `CommonCriteria`
`max` - `CommonCriteria`

Example

{
  "lt": "4",
  "le": 4,
  "eq": "4",
  "ne": "4",
  "ge": 4,
  "gt": "4",
  "isNull": false,
  "in": ["4"],
  "notIn": ["4"],
  "between": [4],
  "notBetween": ["4"],
  "min": CommonCriteria,
  "max": CommonCriteria
}

Types

CreateUserGroupInput

Fields

Input Field	Description
`name` - `String!`
`parentId` - `ID`
`properties` - `JSON`

Example

{
  "name": "abc123",
  "parentId": "4",
  "properties": {}
}

Types

CreateUserGroupResponse

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`path` - `String!`
`attributes` - `JSON`

Example

{
  "id": 4,
  "name": "abc123",
  "path": "abc123",
  "attributes": {}
}

Types

CreateUserInput

Fields

Input Field	Description
`username` - `ID!`
`firstName` - `String`
`lastName` - `String`
`email` - `String!`
`password` - `String!`
`enabled` - `Boolean!`
`cellphones` - `[String!]`
`telephones` - `[String!]`
`groups` - `[ID!]`
`roles` - `[ID!]`
`properties` - `JSON`

Example

{
  "username": 4,
  "firstName": "xyz789",
  "lastName": "xyz789",
  "email": "abc123",
  "password": "xyz789",
  "enabled": false,
  "cellphones": ["xyz789"],
  "telephones": ["abc123"],
  "groups": [4],
  "roles": [4],
  "properties": {}
}

Types

CreateUserResponse

Fields

Field Name	Description
`id` - `ID!`
`username` - `String!`
`firstName` - `String`
`lastName` - `String`
`email` - `String!`
`groups` - `[ID]`
`roles` - `[ID]`
`enabled` - `Boolean!`
`properties` - `JSON`

Example

{
  "id": 4,
  "username": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "abc123",
  "groups": [4],
  "roles": ["4"],
  "enabled": true,
  "properties": {}
}

Types

CreateUserRoleInput

Fields

Input Field	Description
`name` - `ID!`
`description` - `String`
`properties` - `JSON`

Example

{
  "name": 4,
  "description": "abc123",
  "properties": {}
}

Types

CreateUserRoleResponse

Fields

Field Name	Description
`id` - `ID!`
`name` - `ID!`
`description` - `String`
`attributes` - `JSON`

Example

{
  "id": "4",
  "name": "4",
  "description": "abc123",
  "attributes": {}
}

Types

DefaultError

Fields

Field Name	Description
`message` - `String!`
`errors` - `[Error!]`

Example

{
  "message": "xyz789",
  "errors": [Error]
}

Types

Error

Fields

Field Name	Description
`message` - `String!`
`errors` - `[Error!]`

Possible Types

Error Types
`DefaultError`
`ResetUserPasswordError`

Example

{
  "message": "xyz789",
  "errors": [Error]
}

Types

ExistsUserInput

Fields

Input Field	Description
`username` - `String`
`email` - `String`
`phone` - `String`

Example

{
  "username": "xyz789",
  "email": "abc123",
  "phone": "abc123"
}

Types

ExistsUserResponse

Types

Union Types
`ExistsUserResult`
`DefaultError`

Example

ExistsUserResult

Types

ExistsUserResult

Fields

Field Name	Description
`username` - `Boolean!`
`email` - `Boolean!`
`phone` - `Boolean!`

Example

{"username": false, "email": false, "phone": false}

Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

"4"

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

Example

{}

Types

JoinUserInput

Fields

Input Field	Description
`username` - `String!`
`firstName` - `String!`
`lastName` - `String`
`password` - `String!`
`cellphones` - `[String!]`
`telephones` - `[String!]`
`email` - `String!`
`groups` - `[ID!]!`
`properties` - `JSON`

Example

{
  "username": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "password": "abc123",
  "cellphones": ["xyz789"],
  "telephones": ["xyz789"],
  "email": "xyz789",
  "groups": [4],
  "properties": {}
}

Types

JoinUserResponse

Types

Union Types
`User`
`DefaultError`

Example

User

Types

JsonPropertyInput

Fields

Input Field	Description
`patch` - `[JsonPropertyPatchInput]`
`merge` - `JSON`

Example

{"patch": [JsonPropertyPatchInput], "merge": {}}

Types

JsonPropertyPatchInput

Fields

Input Field	Description
`op` - `JsonPropertyPatchOperation!`
`path` - `String!`
`from` - `String`
`value` - `JSON`

Example

{
  "op": "add",
  "path": "abc123",
  "from": "abc123",
  "value": {}
}

Types

JsonPropertyPatchOperation

Values

Enum Value	Description
`add`
`remove`
`replace`
`move`
`copy`
`test`

Example

"add"

Types

PaginationInfo

Fields

Field Name	Description
`totalPages` - `Int!`
`totalItems` - `Int!`
`page` - `Int!`
`size` - `Int!`
`hasNextPage` - `Boolean!`
`hasPreviousPage` - `Boolean!`

Example

{
  "totalPages": 123,
  "totalItems": 987,
  "page": 987,
  "size": 987,
  "hasNextPage": false,
  "hasPreviousPage": true
}

Types

ResetUserPasswordError

Fields

Field Name	Description
`message` - `String!`
`errors` - `[Error!]`

Example

{
  "message": "xyz789",
  "errors": [Error]
}

Types

ResetUserPasswordInput

Fields

Input Field	Description
`username` - `String!`
`email` - `String!`
`cellphone` - `String!`
`password` - `String!`

Example

{
  "username": "abc123",
  "email": "xyz789",
  "cellphone": "abc123",
  "password": "xyz789"
}

Types

ResetUserPasswordResponse

Types

Union Types
`User`
`DefaultError`

Example

User

Types

SimpleCriteria

Fields

Input Field	Description
`eq` - `ID`
`ne` - `ID`
`in` - `[ID]`
`notIn` - `[ID]`
`isNull` - `Boolean`

Example

{
  "eq": "4",
  "ne": "4",
  "in": [4],
  "notIn": ["4"],
  "isNull": true
}

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

StringCriteria

Fields

Input Field	Description
`lt` - `String`
`le` - `String`
`eq` - `String`
`ne` - `String`
`ge` - `String`
`gt` - `String`
`isNull` - `Boolean`
`in` - `[String]`
`notIn` - `[String]`
`between` - `[String]`
`notBetween` - `[String]`
`min` - `StringCriteria`
`max` - `StringCriteria`
`eqIgnoreCase` - `String`
`contains` - `String`
`containsIgnoreCase` - `String`
`startsWith` - `String`
`startsWithIgnoreCase` - `String`
`endsWith` - `String`
`endsWithIgnoreCase` - `String`
`isEmpty` - `Boolean`
`matches` - `String`

Example

{
  "lt": "abc123",
  "le": "xyz789",
  "eq": "xyz789",
  "ne": "xyz789",
  "ge": "abc123",
  "gt": "xyz789",
  "isNull": true,
  "in": ["abc123"],
  "notIn": ["abc123"],
  "between": ["abc123"],
  "notBetween": ["abc123"],
  "min": StringCriteria,
  "max": StringCriteria,
  "eqIgnoreCase": "xyz789",
  "contains": "abc123",
  "containsIgnoreCase": "xyz789",
  "startsWith": "xyz789",
  "startsWithIgnoreCase": "xyz789",
  "endsWith": "xyz789",
  "endsWithIgnoreCase": "abc123",
  "isEmpty": false,
  "matches": "abc123"
}

Types

UpdateUserGroupInput

Fields

Input Field	Description
`name` - `String`
`parentId` - `ID`
`properties` - `JSON`

Example

{
  "name": "abc123",
  "parentId": 4,
  "properties": {}
}

Types

UpdateUserGroupResponse

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`path` - `String!`
`attributes` - `JSON`

Example

{
  "id": "4",
  "name": "abc123",
  "path": "abc123",
  "attributes": {}
}

Types

UpdateUserInput

Fields

Input Field	Description
`username` - `String`
`firstName` - `String`
`lastName` - `String`
`email` - `String`
`cellphones` - `[String!]`
`telephones` - `[String!]`
`groupId` - `[ID]`
`roles` - `[ID]`
`enabled` - `Boolean`
`properties` - `JsonPropertyInput`

Example

{
  "username": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "email": "abc123",
  "cellphones": ["abc123"],
  "telephones": ["abc123"],
  "groupId": [4],
  "roles": [4],
  "enabled": true,
  "properties": JsonPropertyInput
}

Types

UpdateUserResponse

Fields

Field Name	Description
`id` - `ID!`
`username` - `String!`
`firstName` - `String`
`lastName` - `String`
`email` - `String`
`groups` - `[ID]`
`roles` - `[ID]`
`properties` - `JSON`

Example

{
  "id": "4",
  "username": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "xyz789",
  "groups": [4],
  "roles": ["4"],
  "properties": {}
}

Types

UpdateUserRoleInput

Fields

Input Field	Description
`name` - `ID!`
`description` - `String`
`properties` - `JSON`

Example

{
  "name": 4,
  "description": "abc123",
  "properties": {}
}

Types

UpdateUserRoleResponse

Fields

Field Name	Description
`id` - `ID!`
`name` - `ID!`
`description` - `String`
`attributes` - `JSON`

Example

{
  "id": "4",
  "name": "4",
  "description": "abc123",
  "attributes": {}
}

Types

User

Fields

Field Name	Description
`id` - `ID!`
`username` - `String!`
`firstName` - `String`
`lastName` - `String`
`roles` - `[UserRole]`
`groups` - `[UserGroup]`
`email` - `String`
`cellphones` - `[String!]`
`telephones` - `[String!]`
`emailVerified` - `Boolean!`
`enabled` - `Boolean!`
`properties` - `JSON`
`createdBy` - `ID`
`createdAt` - `String`

Example

{
  "id": "4",
  "username": "xyz789",
  "firstName": "abc123",
  "lastName": "abc123",
  "roles": [UserRole],
  "groups": [UserGroup],
  "email": "abc123",
  "cellphones": ["xyz789"],
  "telephones": ["xyz789"],
  "emailVerified": true,
  "enabled": true,
  "properties": {},
  "createdBy": 4,
  "createdAt": "abc123"
}

Types

UserFilter

Fields

Input Field	Description
`id` - `SimpleCriteria`
`name` - `StringCriteria`
`username` - `StringCriteria`
`email` - `StringCriteria`
`firstName` - `StringCriteria`
`lastName` - `StringCriteria`
`enabled` - `BooleanCriteria`
`division` - `StringCriteria`
`unit` - `StringCriteria`
`and` - `[UserFilter!]`
`or` - `[UserFilter!]`
`not` - `UserFilter`

Example

{
  "id": SimpleCriteria,
  "name": StringCriteria,
  "username": StringCriteria,
  "email": StringCriteria,
  "firstName": StringCriteria,
  "lastName": StringCriteria,
  "enabled": BooleanCriteria,
  "division": StringCriteria,
  "unit": StringCriteria,
  "and": [UserFilter],
  "or": [UserFilter],
  "not": UserFilter
}

Types

UserGroup

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`path` - `String!`
`attributes` - `JSON`
`users` - `[User]`
`children` - `[UserGroup!]!`

Example

{
  "id": 4,
  "name": "xyz789",
  "path": "xyz789",
  "attributes": {},
  "users": [User],
  "children": [UserGroup]
}

Types

UserGroupChildQueryResponse

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`path` - `String!`
`attributes` - `JSON`
`children` - `[UserGroupChildQueryResponse]!`

Example

{
  "id": "4",
  "name": "abc123",
  "path": "xyz789",
  "attributes": {},
  "children": [UserGroupChildQueryResponse]
}

Types

UserGroupFilter

Fields

Input Field	Description
`id` - `SimpleCriteria`
`name` - `SimpleCriteria`
`enabled` - `BooleanCriteria`
`and` - `[UserGroupFilter!]`
`or` - `[UserGroupFilter!]`
`not` - `UserGroupFilter`

Example

{
  "id": SimpleCriteria,
  "name": SimpleCriteria,
  "enabled": BooleanCriteria,
  "and": [UserGroupFilter],
  "or": [UserGroupFilter],
  "not": UserGroupFilter
}

Types

UserGroupPageable

Fields

Input Field	Description
`page` - `Int!`
`size` - `Int!`
`sort` - `[UserGroupSort!]`

Example

{"page": 123, "size": 987, "sort": ["NameAsc"]}

Types

UserGroupPaged

Fields

Field Name	Description
`items` - `[UserGroup!]!`
`pageInfo` - `PaginationInfo!`

Example

{
  "items": [UserGroup],
  "pageInfo": PaginationInfo
}

Types

UserGroupParentQueryResponse

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`path` - `String!`
`attributes` - `JSON`
`parent` - `UserGroupParentQueryResponse`
`ancestors` - `[UserGroupParentQueryResponse]!`

Example

{
  "id": 4,
  "name": "xyz789",
  "path": "xyz789",
  "attributes": {},
  "parent": UserGroupParentQueryResponse,
  "ancestors": [UserGroupParentQueryResponse]
}

Types

UserGroupSort

Values

Enum Value	Description
`NameAsc`
`NameDesc`
`CreatedAtAsc`
`CreatedAtDesc`

Example

"NameAsc"

Types

UserPageable

Fields

Input Field	Description
`page` - `Int!`
`size` - `Int!`
`sort` - `[UserSort!]`

Example

{"page": 123, "size": 987, "sort": ["UsernameAsc"]}

Types

UserPaged

Fields

Field Name	Description
`items` - `[User!]!`
`pageInfo` - `PaginationInfo!`

Example

{
  "items": [User],
  "pageInfo": PaginationInfo
}

Types

UserRole

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`description` - `String`
`attributes` - `JSON`
`composite` - `Boolean!`
`composites` - `[UserRole]!`

Example

{
  "id": "4",
  "name": "abc123",
  "description": "xyz789",
  "attributes": {},
  "composite": true,
  "composites": [UserRole]
}

Types

UserRoleFilter

Fields

Input Field	Description
`id` - `SimpleCriteria`
`name` - `SimpleCriteria`
`enabled` - `BooleanCriteria`
`and` - `[UserRoleFilter!]`
`or` - `[UserRoleFilter!]`
`not` - `UserRoleFilter`

Example

{
  "id": SimpleCriteria,
  "name": SimpleCriteria,
  "enabled": BooleanCriteria,
  "and": [UserRoleFilter],
  "or": [UserRoleFilter],
  "not": UserRoleFilter
}

Types

UserRolePageable

Fields

Input Field	Description
`page` - `Int!`
`size` - `Int!`
`sort` - `[UserRoleSort!]`

Example

{"page": 123, "size": 987, "sort": ["NameAsc"]}

Types

UserRolePaged

Fields

Field Name	Description
`items` - `[UserRole!]!`
`pageInfo` - `PaginationInfo!`

Example

{
  "items": [UserRole],
  "pageInfo": PaginationInfo
}

Types

UserRoleSort

Values

Enum Value	Description
`NameAsc`
`NameDesc`

Example

"NameAsc"

Types

UserSort

Values

Enum Value	Description
`UsernameAsc`
`UsernameDesc`
`EmailAsc`
`EmailDesc`
`FirstNameAsc`
`FirstNameDesc`
`LastNameAsc`
`LastNameDesc`
`CreatedAtAsc`
`CreatedAtDesc`

Example

"UsernameAsc"

Documentation by Anvil SpectaQL