Resources
Users
Users are the end users of your integrations
Get users (master token)
Type: Query
Operation: get-users
Request Examples
{
"query": "query {\n users {\n edges {\n node {\n name\n id\n externalUserId\n }\n cursor\n }\n pageInfo {\n hasNextPage\n endCursor\n hasPreviousPage\n startCursor\n }\n }\n}",
"variables": {}
}Response Examples
{
"data": {
"users": {
"edges": [
{
"node": {
"name": "Michael Scott",
"id": "13b3ab9c-XXXX-XXXX-XXXX-XXXX07fbbfa4",
"externalUserId": "668341a0-XXXX-XXXX-XXXX-XXXX5c9ba02b"
},
"cursor": "MTNiM2FiOWMtZTIyMi00NzM5LWE2OWItYzRkZDA3ZmJiZmE0"
},
{
"node": {
"name": "Dwight Schrute",
"id": "1a71daf1-97ba-4036-a5cc-dbb4ab325a55",
"externalUserId": "323442a0-XXXX-XXXX-XXXX-XXXX5c9ba02b"
},
"cursor": "XXXXXXXXZjEtOTdiYS00MDM2LWE1Y2MtZGJiNGFiMzI1YTU1"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "XXXXXXXXZjEtOTdiYS00MDM2LWE1Y2MtZGJiNGFiMzI1YTU1",
"hasPreviousPage": false,
"startCursor": "XXXXXXXXOWMtZTIyMi00NzM5LWE2OWItYzRkZDA3ZmJiZmE0"
}
}
}
}Create new user (master token)
Type: Mutation
Operation: create-user
Request Examples
{
"query": "mutation($name: String!, $externalUserId: String!) {\n createExternalUser(input: { \n name: $name, \n externalUserId: $externalUserId \n }) {\n userId\n }\n}",
"variables": {
"name": "Dwight Schrute",
"externalUserId": "my-apps-user-id-for-dwight"
}
}Response Examples
{
"data": {
"createExternalUser": {
"userId": "d235e0b1-XXXX-XXXX-XXXX-7d165cdf4171"
}
}
}Create user token (master token)
Type: Mutation
Operation: create-user-token
Request Examples
{
"query": "mutation ($userId: ID!) {\n authorize(input: {\n userId: $userId\n }) {\n accessToken\n }\n}",
"variables": {
"userId": "d869ec65-XXXX-XXXX-XXXX-ac5c1a3958b6"
}
}Response Examples
{
"data": {
"authorize": {
"accessToken": "3346c4c957b74ca2a803dacf1485816d3fedde3a54b547b997cd64b72375a9d4"
}
}
}Create Auth/Config dialog Authorization Code (master token)
Type: Mutation
Operation: create-config-wizard-auth-code
Request Examples
{
"query": "mutation ($userId: ID!) {\n generateAuthorizationCode( input: {\n userId: $userId\n }) {\n authorizationCode\n }\n}",
"variables": {
"userId": "d869ec65-XXXX-XXXX-XXXX-ac5c1a3958b6"
}
}Response Examples
{
"data": {
"generateAuthorizationCode": {
"authorizationCode": "a61eb70884f9af554a941876a66560b4bbfe48cc"
}
}
}Update user (master token)
Type: Mutation
Operation: update-user
Request Examples
{
"query": "mutation ($userId: ID!, $isTestUser: Boolean ){\n updateExternalUser(input: {\n userId: $userId,\n isTestUser: $isTestUser\n }) {\n user{\n\t\t\tname\n\t\t\tid\n\t\t\texternalUserId\n\t\t\tisTestUser\n\t\t}\n }\n}",
"variables": {
"userId": "53824943-XXXX-XXXX-XXXX-088aee14038e",
"isTestUser": true
}
}Response Examples
{
"data": {
"updateExternalUser": {
"user": {
"name": "Dwaight Schrute",
"id": "ad15b7ae-4c2d-4574-bf4f-5e8e1097a6e9",
"externalUserId": "test003",
"isTestUser": true
}
}
}
}Delete user (master token)
Type: Mutation
Operation: delete-user
Request Examples
{
"query": "mutation {\n removeExternalUser(input: {userId: $userId}) {\n clientMutationId # REQUIRED - must specify as return field, not required to provide this in mutation function\n }\n}",
"variables": {
"userId": "53824943-XXXX-XXXX-XXXX-088aee14038e"
}
}Response Examples
{
"data": {
"removeExternalUser": {
"clientMutationId": null
}
}
}