Use these APIs to complete administrative tasks in aiWARE that relate to your organization, users, and version information.
Get organization info for current session
Retrieves organization information for the current session.
Example
query getOrgInfo {
me {
organization {
name
id
}
}
}
Get all roles in an organization
Retrieves all the roles in an organization.
[note] This method requires elevated rights in the system.
Example
query getAllRoles {
organization(id: 17532) {
roles {
name
id
permissions {
records {
id
name
description
}
}
}
}
}
Get an organization's users
Retrieves an organizations's users. Supply one or more organizationId values inside an array.
Example
query {
users(organizationIds:[17532]) {
records {
id
name
}
}
}
Create a new user
Creates a new user. The required fields are name and organizationId.
Example
mutation {
createUser(input: {
name: "Arby Arbiti",
requestorId: "960b3fa8-1812-4303-b58d-4f0d227f2afc",
password: "",
organizationId: 17532,
sendNewUserEmail: false,
email: "something@something.com",
firstName: "Arby",
lastName: "Arbiti"
})
{
id
}
}
Get aiWARE version info
Retrieves information about the aiWARE version.
Example
query {
graphqlServiceInfo {
buildInfo
}
}
Response
json
{
"data": {
"graphqlServiceInfo": {
"buildInfo": {
"commitHash": "c7b6ed7c554d3e445022e2f3d38fbb2a904a576b",
"commitDate": "2022-10-26T08:54:57-07:00",
"buildNumber": "20221026173131-c7b6ed7c5",
"buildDate": "2022-10-26T17:31:31-00:00",
"branch": "HEAD",
}
}
}
}
More API examples
