Group

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.

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGroupConnection
400Bad RequestBad requestNone

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

Parameters

NameInTypeRequiredDescription
groupIdquerystringtrueThe id of the group

Responses

StatusMeaningDescriptionSchema
200OKsuccesfully retrieve informations of the groupInline
400Bad RequestBad requestNone

Response Schema

Status Code 200
NameTypeRequiredRestrictionsDescription
anonymous[Group]falsenonenone

POST /group
Create a Group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ]
}

Parameters

NameInTypeRequiredDescription
parentIdquerystringfalsenone
bodybodyGroupInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGroup
400Bad RequestBad requestNone

PUT /group
Update a group information
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "groupId": "string",
  "ownerId": "string",
  "name": "string",
  "roleId": "string",
  "description": "string",
  "parent": "string",
  "tags": [
    "string"
  ]
}

Parameters

NameInTypeRequiredDescription
bodybodyUpdateGroupInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGroup
400Bad RequestBad requestNone

POST /group/apiKey
Associate a external api key (ex. SIGFOX api key) to a group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "groupId": "string",
  "type": "string",
  "token": "string",
  "name": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyExternalApiKeyInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseExternalApiKey
400Bad RequestBad requestNone

PUT /group/apiKey
Update an external api key associated to a group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "groupId": "string",
  "type": "string",
  "token": "string",
  "name": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyUpdateExternalApiKeyInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseExternalApiKey
400Bad RequestBad requestNone

DELETE /group/apiKey
Delete an external api key associated to a group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
groupIdquerystringtrueThe id of the group
typequerystringtrueThe API key type (e.g. sigfox)

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGroupUserRelation
400Bad RequestBad requestNone

PUT /group/invite
Invite user to a group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "email": "string",
  "groupId": "string",
  "roleId": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyInviteUserInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGenericReturn
400Bad RequestBad requestNone

PUT /group/user
Update user to a group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "userId": "string",
  "groupId": "string",
  "roleId": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyUpdateUserRoleGroupInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGenericReturn
400Bad RequestBad requestNone

DELETE /group/user
Remove user from a group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
groupIdquerystringtrueThe ID of a Group
userIdquerystringfalseThe ID of a User, if nothing provided, it will take the current user

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGroupUserRelation
400Bad RequestBad requestNone

GET /group/devices
Get the list of Devices of a group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
groupIdquerystringtrueThe id of the group
limitqueryintegerfalsenone
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.

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDeviceConnection
400Bad RequestBad requestNone

GET /group/roles
Get the list of role of a group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalsenone
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.

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseRoleConnection
400Bad RequestBad requestNone

GET /group/users
Get the list of users of a group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
groupIdquerystringtrueThe id of the group
limitqueryintegerfalsenone
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.

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseUserConnection
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

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

GroupUserRelation

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

NameTypeRequiredRestrictionsDescription
idstringtruenonenone
userIdstringtruenonenone

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

GroupUserInput

{
  "groupId": "string",
  "userId": "string",
  "roleId": "string"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
userIdstringtruenonenone
roleIdstringtruenonenone

GroupInput

{
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ]
}

NameTypeRequiredRestrictionsDescription
namestringfalsenonenone
descriptionstringfalsenonenone
tags[string]falsenonenone

UpdateGroupInput

{
  "groupId": "string",
  "ownerId": "string",
  "name": "string",
  "roleId": "string",
  "description": "string",
  "parent": "string",
  "tags": [
    "string"
  ]
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
ownerIdstringfalsenonenone
namestringfalsenonenone
roleIdstringfalsenonenone
descriptionstringfalsenonenone
parentstringfalsenonenone
tags[string]falsenonenone

DeleteGroupUserInput

{
  "groupId": "string",
  "userId": "string"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
userIdstringfalsenonenone

DeleteGroupInput

{
  "groupId": "string",
  "userId": "string"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
userIdstringtruenonenone

DeleteGroupUserRelationInput

{
  "groupId": "string",
  "userId": "string"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
userIdstringtruenonenone

ExternalApiKey

{
  "groupId": "string",
  "name": "string",
  "type": "string",
  "token": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
namestringtruenonenone
typestringtruenonenone
tokenstringfalsenonenone
createdBystringfalsenonenone
updatedBystringfalsenonenone
createdAtstring(date)falsenonenone
updatedAtstring(date)falsenonenone

ExternalApiKeyInput

{
  "groupId": "string",
  "type": "string",
  "token": "string",
  "name": "string"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
typestringtruenonenone
tokenstringtruenonenone
namestringtruenonenone

UpdateExternalApiKeyInput

{
  "groupId": "string",
  "type": "string",
  "token": "string",
  "name": "string"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
typestringtruenonenone
tokenstringfalsenonenone
namestringfalsenonenone

DeleteExternalApiKeyInput

{
  "groupId": "string",
  "type": "string"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
typestringtruenonenone

Role

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

NameTypeRequiredRestrictionsDescription
idstringtruenonenone
namestringtruenonenone
descriptionstringtruenonenone
permissions[string]truenonenone
removablebooleanfalsenonenone

RoleConnection

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

NameTypeRequiredRestrictionsDescription
items[Role]falsenonenone

InviteUserInput

{
  "email": "string",
  "groupId": "string",
  "roleId": "string"
}

NameTypeRequiredRestrictionsDescription
emailstringtruenonenone
groupIdstringtruenonenone
roleIdstringtruenonenone

UpdateUserRoleGroupInput

{
  "userId": "string",
  "groupId": "string",
  "roleId": "string"
}

NameTypeRequiredRestrictionsDescription
userIdstringtruenonenone
groupIdstringtruenonenone
roleIdstringtruenonenone

RequestGroupByDeviceIdInput

{
  "email": "string",
  "network": "string",
  "username": "string",
  "deviceId": "string"
}

NameTypeRequiredRestrictionsDescription
emailstringtruenonenone
networkstringtruenonenone
usernamestringtruenonenone
deviceIdstringtruenonenone

DeviceConnection

{
  "items": [
    {
      "deviceId": "string",
      "groupId": "string",
      "name": "string",
      "type": "string",
      "network": "string",
      "originalId": "string",
      "battery": "string",
      "seenAt": 0,
      "createdAt": "2019-08-24",
      "updatedAt": "2019-08-24",
      "createdBy": "string",
      "updatedBy": "string",
      "information": "string",
      "configuration": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "nextToken": "string"
}

NameTypeRequiredRestrictionsDescription
items[Device]falsenonenone

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

Device

{
  "deviceId": "string",
  "groupId": "string",
  "name": "string",
  "type": "string",
  "network": "string",
  "originalId": "string",
  "battery": "string",
  "seenAt": 0,
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "createdBy": "string",
  "updatedBy": "string",
  "information": "string",
  "configuration": "string",
  "tags": [
    "string"
  ]
}

NameTypeRequiredRestrictionsDescription
deviceIdstringtruenonenone
groupIdstringtruenonenone
namestringtruenonenone
typestringtruenonenone
networkstringtruenonenone
originalIdstringtruenonenone
batterystringfalsenonenone
seenAtintegerfalsenonenone
createdAtstring(date)truenonenone
updatedAtstring(date)truenonenone
createdBystringtruenonenone
updatedBystringtruenonenone
informationstringfalsenonenone
configurationstringfalsenonenone
tags[string]falsenonenone

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