User

GET /user
Get the information of the user
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
userIdquerystringtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseUser
400Bad RequestBad requestNone

PUT /user
Update a User information
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "gender": "string",
  "name": "string",
  "firstName": "string",
  "lastName": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyUpdateUserInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseUser
400Bad RequestBad requestNone

POST /user
Create a User account
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "email": "string",
  "firstname": "string",
  "lastName": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyNewUserInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseUser
400Bad RequestBad requestNone

PUT /user/expoToken
Link a Expo Token to a User
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "token": "string",
  "deviceName": "string"
}
NameInTypeRequiredDescription
bodybodyAddExpoTokenInputtruenone
StatusMeaningDescriptionSchema
200OKSuccess responseGenericReturn
400Bad RequestBad requestNone

DELETE /user/expoToken
Remove a Expo Token to a User
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
tokenquerystringtrueThe Expo token to remove

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGenericReturn
400Bad RequestBad requestNone

GET /user/me
Get user using authorization token in header
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
authorizationheaderstring(uuid)truenone

Responses

StatusMeaningDescriptionSchema
200OKreturns successfully User objectUser

GET /user/groups
Get the list of all the groups of the user
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalseThe maximum number of items to retrieve
nextTokenquerystringfalseThe key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
userIdquerystringfalseOPTIONAL: The id of the user to retrieve from, by default, the current user
groupIdquerystringfalseOPTIONAL: The id of the group to retrieve from, by default, the current user

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGroupConnection
400Bad RequestBad requestNone

Schemas

GenericReturn

{
  "message": "string"
}

NameTypeRequiredRestrictionsDescription
messagestringfalsenonenone

GenericReturnBoolean

{
  "message": "string",
  "value": true
}

NameTypeRequiredRestrictionsDescription
messagestringfalsenonenone
valuebooleanfalsenonenone

RetryPolicy

{
  "retryDelay": 0,
  "maxRetry": 0
}

NameTypeRequiredRestrictionsDescription
retryDelayintegerfalsenonenone
maxRetryintegerfalsenonenone

DataFailurePolicy

{
  "strongDuration": 0,
  "hasData": true,
  "startTime": "2019-08-24",
  "resending": true
}

NameTypeRequiredRestrictionsDescription
strongDurationintegerfalsenonenone
hasDatabooleanfalsenonenone
startTimestring(date)falsenonenone
resendingbooleanfalsenonenone

User

{
  "id": "string",
  "email": "string",
  "name": "string",
  "seenAt": "2019-08-24",
  "firstName": "string",
  "lastName": "string",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "gender": "string",
  "devices": {
    "token": "string",
    "type": "string",
    "createdAt": "2019-08-24",
    "createdBy": "string",
    "deviceName": "string",
    "enabled": true
  }
}

NameTypeRequiredRestrictionsDescription
idstringfalsenonenone
emailstringfalsenonenone
namestringfalsenonenone
seenAtstring(date)falsenonenone
firstNamestringfalsenonenone
lastNamestringfalsenonenone
createdAtstring(date)falsenonenone
updatedAtstring(date)falsenonenone
genderstringfalsenonenone

PublicUser

{
  "id": "string",
  "email": "string",
  "name": "string",
  "seenAt": "2019-08-24",
  "firstName": "string",
  "lastName": "string",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "role": {
    "id": "string",
    "name": "string",
    "description": "string",
    "permissions": [
      "string"
    ],
    "removable": true
  }
}

NameTypeRequiredRestrictionsDescription
idstringfalsenonenone
emailstringfalsenonenone
namestringfalsenonenone
seenAtstring(date)falsenonenone
firstNamestringfalsenonenone
lastNamestringfalsenonenone
createdAtstring(date)falsenonenone
updatedAtstring(date)falsenonenone

ExpoToken

{
  "token": "string",
  "type": "string",
  "createdAt": "2019-08-24",
  "createdBy": "string",
  "deviceName": "string",
  "enabled": true
}

NameTypeRequiredRestrictionsDescription
tokenstringfalsenonenone
typestringfalsenonenone
createdAtstring(date)falsenonenone
createdBystringfalsenonenone
deviceNamestringfalsenonenone
enabledbooleanfalsenonenone

UserConnection

{
  "items": [
    {
      "id": "string",
      "email": "string",
      "name": "string",
      "seenAt": "2019-08-24",
      "firstName": "string",
      "lastName": "string",
      "createdAt": "2019-08-24",
      "updatedAt": "2019-08-24",
      "role": {
        "id": "string",
        "name": "string",
        "description": "string",
        "permissions": [
          "string"
        ],
        "removable": true
      }
    }
  ],
  "nextToken": "string"
}

NameTypeRequiredRestrictionsDescription
items[PublicUser]falsenonenone

UpdateUserInput

{
  "gender": "string",
  "name": "string",
  "firstName": "string",
  "lastName": "string"
}

NameTypeRequiredRestrictionsDescription
genderstringfalsenonenone
namestringfalsenonenone
firstNamestringfalsenonenone
lastNamestringfalsenonenone

NewUserInput

{
  "email": "string",
  "firstname": "string",
  "lastName": "string"
}

NameTypeRequiredRestrictionsDescription
emailstringtruenonenone
firstnamestringfalsenonenone
lastNamestringtruenonenone

Role

{
  "id": "string",
  "name": "string",
  "description": "string",
  "permissions": [
    "string"
  ],
  "removable": true
}

NameTypeRequiredRestrictionsDescription
idstringtruenonenone
namestringtruenonenone
descriptionstringtruenonenone
permissions[string]truenonenone
removablebooleanfalsenonenone

AddExpoTokenInput

{
  "token": "string",
  "deviceName": "string"
}

NameTypeRequiredRestrictionsDescription
tokenstringtruenonenone
deviceNamestringfalsenonenone

RemoveExpoTokenInput

{
  "token": "string"
}

NameTypeRequiredRestrictionsDescription
tokenstringtruenonenone

Group

{
  "id": "string",
  "userId": "string",
  "name": "string",
  "description": "string",
  "token": "string",
  "administratorRole": "string",
  "defaultRole": "string",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "createdBy": "string",
  "updatedBy": "string",
  "parent": "string",
  "role": {
    "id": "string",
    "name": "string",
    "description": "string",
    "permissions": [
      "string"
    ],
    "removable": true
  },
  "ownerId": "string",
  "numberOfDevices": 0,
  "numberOfNotifications": 0,
  "numberOfConnectors": 0
}

NameTypeRequiredRestrictionsDescription
idstringtruenonenone
userIdstringtruenonenone
namestringfalsenonenone
descriptionstringfalsenonenone
tokenstringfalsenonenone
administratorRolestringfalsenonenone
defaultRolestringfalsenonenone
createdAtstring(date)falsenonenone
updatedAtstring(date)falsenonenone
createdBystringfalsenonenone
updatedBystringfalsenonenone
parentstringfalsenonenone

GroupConnection

{
  "items": [
    {
      "id": "string",
      "userId": "string",
      "name": "string",
      "description": "string",
      "token": "string",
      "administratorRole": "string",
      "defaultRole": "string",
      "createdAt": "2019-08-24",
      "updatedAt": "2019-08-24",
      "createdBy": "string",
      "updatedBy": "string",
      "parent": "string",
      "role": {
        "id": "string",
        "name": "string",
        "description": "string",
        "permissions": [
          "string"
        ],
        "removable": true
      },
      "ownerId": "string",
      "numberOfDevices": 0,
      "numberOfNotifications": 0,
      "numberOfConnectors": 0
    }
  ],
  "nextToken": "string"
}

NameTypeRequiredRestrictionsDescription
items[Group]falsenonenone