Get the list of all the groups of the user
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 Name In Type Required Description limit query integer false The maximum number of items to retrieve nextToken query string false The 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 Get general information of a group
GET /group
Get general information of a group
You must authenticate using an access token with the Authorization:accessToken
header to use this endpoint.
Name In Type Required Description groupId query string true The id of the group
Status Meaning Description Schema 200 OK succesfully retrieve informations of the group Inline 400 Bad Request Bad request None
Status Code 200
Name Type Required Restrictions Description anonymous [Group ] false none none
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 Name In Type Required Description parentId query string false none body body GroupInput true none
Responses Update a group information
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"
]
}
Associate a external api key to a group
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
Responses Update an external api key associated to a group
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
Responses Delete an external api key associated to a group
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 Name In Type Required Description groupId query string true The id of the group type query string true The API key type (e.g. sigfox)
Responses 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
Responses 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
Responses 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 Name In Type Required Description groupId query string true The ID of a Group userId query string false The ID of a User, if nothing provided, it will take the current user
Responses Get the list of Devices of a group
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 Name In Type Required Description groupId query string true The id of the group limit query integer false none nextToken query string false The 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 Get the list of role of a group
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 Name In Type Required Description limit query integer false none nextToken query string false The 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 Get the list of users of a group
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 Name In Type Required Description groupId query string true The id of the group limit query integer false none nextToken query string false The 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 Schemas
GenericReturn {
"message" : "string"
}
Name Type Required Restrictions Description message string false none none
GenericReturnBoolean {
"message" : "string" ,
"value" : true
}
Name Type Required Restrictions Description message string false none none value boolean false none none
RetryPolicy {
"retryDelay" : 0 ,
"maxRetry" : 0
}
Name Type Required Restrictions Description retryDelay integer false none none maxRetry integer false none none
DataFailurePolicy {
"strongDuration" : 0 ,
"hasData" : true ,
"startTime" : "2019-08-24" ,
"resending" : true
}
Name Type Required Restrictions Description strongDuration integer false none none hasData boolean false none none startTime string(date) false none none resending boolean false none none
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
}
Name Type Required Restrictions Description id string true none none userId string true none none name string false none none description string false none none token string false none none administratorRole string false none none defaultRole string false none none createdAt string(date) false none none updatedAt string(date) false none none createdBy string false none none updatedBy string false none none parent string false none none
GroupUserRelation {
"id" : "string" ,
"userId" : "string" ,
"role" : {
"id" : "string" ,
"name" : "string" ,
"description" : "string" ,
"permissions" : [
"string"
] ,
"removable" : true
} ,
"token" : "string" ,
"description" : "string" ,
"name" : "string"
}
Name Type Required Restrictions Description id string true none none userId string true none none
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"
}
Name Type Required Restrictions Description items [Group ] false none none
{
"groupId" : "string" ,
"userId" : "string" ,
"roleId" : "string"
}
Name Type Required Restrictions Description groupId string true none none userId string true none none roleId string true none none
{
"name" : "string" ,
"description" : "string" ,
"tags" : [
"string"
]
}
Name Type Required Restrictions Description name string false none none description string false none none tags [string] false none none
{
"groupId" : "string" ,
"ownerId" : "string" ,
"name" : "string" ,
"roleId" : "string" ,
"description" : "string" ,
"parent" : "string" ,
"tags" : [
"string"
]
}
Name Type Required Restrictions Description groupId string true none none ownerId string false none none name string false none none roleId string false none none description string false none none parent string false none none tags [string] false none none
{
"groupId" : "string" ,
"userId" : "string"
}
Name Type Required Restrictions Description groupId string true none none userId string false none none
{
"groupId" : "string" ,
"userId" : "string"
}
Name Type Required Restrictions Description groupId string true none none userId string true none none
{
"groupId" : "string" ,
"userId" : "string"
}
Name Type Required Restrictions Description groupId string true none none userId string true none none
ExternalApiKey {
"groupId" : "string" ,
"name" : "string" ,
"type" : "string" ,
"token" : "string" ,
"createdBy" : "string" ,
"updatedBy" : "string" ,
"createdAt" : "2019-08-24" ,
"updatedAt" : "2019-08-24"
}
Name Type Required Restrictions Description groupId string true none none name string true none none type string true none none token string false none none createdBy string false none none updatedBy string false none none createdAt string(date) false none none updatedAt string(date) false none none
{
"groupId" : "string" ,
"type" : "string" ,
"token" : "string" ,
"name" : "string"
}
Name Type Required Restrictions Description groupId string true none none type string true none none token string true none none name string true none none
{
"groupId" : "string" ,
"type" : "string" ,
"token" : "string" ,
"name" : "string"
}
Name Type Required Restrictions Description groupId string true none none type string true none none token string false none none name string false none none
{
"groupId" : "string" ,
"type" : "string"
}
Name Type Required Restrictions Description groupId string true none none type string true none none
Role {
"id" : "string" ,
"name" : "string" ,
"description" : "string" ,
"permissions" : [
"string"
] ,
"removable" : true
}
Name Type Required Restrictions Description id string true none none name string true none none description string true none none permissions [string] true none none removable boolean false none none
RoleConnection {
"items" : [
{
"id" : "string" ,
"name" : "string" ,
"description" : "string" ,
"permissions" : [
"string"
] ,
"removable" : true
}
] ,
"nextToken" : "string"
}
Name Type Required Restrictions Description items [Role ] false none none
{
"email" : "string" ,
"groupId" : "string" ,
"roleId" : "string"
}
Name Type Required Restrictions Description email string true none none groupId string true none none roleId string true none none
{
"userId" : "string" ,
"groupId" : "string" ,
"roleId" : "string"
}
Name Type Required Restrictions Description userId string true none none groupId string true none none roleId string true none none
{
"email" : "string" ,
"network" : "string" ,
"username" : "string" ,
"deviceId" : "string"
}
Name Type Required Restrictions Description email string true none none network string true none none username string true none none deviceId string true none none
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"
}
Name Type Required Restrictions Description items [Device ] false none none
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"
}
Name Type Required Restrictions Description items [PublicUser ] false none none
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"
]
}
Name Type Required Restrictions Description deviceId string true none none groupId string true none none name string true none none type string true none none network string true none none originalId string true none none battery string false none none seenAt integer false none none createdAt string(date) true none none updatedAt string(date) true none none createdBy string true none none updatedBy string true none none information string false none none configuration string false none none tags [string] false none none
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
}
}
Name Type Required Restrictions Description id string false none none email string false none none name string false none none seenAt string(date) false none none firstName string false none none lastName string false none none createdAt string(date) false none none updatedAt string(date) false none none