Get the information of the 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.
Name In Type Required Description userId query string true none
Update a User information
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"
}
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
Responses Link a Expo Token to a User
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"
}
Parameters
Responses Remove a Expo Token to a User
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 Name In Type Required Description token query string true The Expo token to remove
Responses 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.
Name In Type Required Description authorization header string(uuid) true none
Status Meaning Description Schema 200 OK returns successfully User object User
Get the list of groups belonging to 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. userId query string false OPTIONAL: The id of the user to retrieve from, by default, the current user groupId query string false OPTIONAL: The id of the group to retrieve from, by default, the current user
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
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
}
}
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 gender 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
ExpoToken {
"token" : "string" ,
"type" : "string" ,
"createdAt" : "2019-08-24" ,
"createdBy" : "string" ,
"deviceName" : "string" ,
"enabled" : true
}
Name Type Required Restrictions Description token string false none none type string false none none createdAt string(date) false none none createdBy string false none none deviceName string false none none enabled boolean 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
{
"gender" : "string" ,
"name" : "string" ,
"firstName" : "string" ,
"lastName" : "string"
}
Name Type Required Restrictions Description gender string false none none name string false none none firstName string false none none lastName string false none none
{
"email" : "string" ,
"firstname" : "string" ,
"lastName" : "string"
}
Name Type Required Restrictions Description email string true none none firstname string false none none lastName 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
{
"token" : "string" ,
"deviceName" : "string"
}
Name Type Required Restrictions Description token string true none none deviceName string false none none
{
"token" : "string"
}
Name Type Required Restrictions Description token string true 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
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
