Groups

List the groups the user belongs to

get

List the groups the user belongs to

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userIdstringRequired

The ID of the user

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/users/{userId}/groups

HTTPcURLJavaScriptPython

GET /users/{userId}/groups HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "groups": {
    "id": "text",
    "description": "text"
  }
}

Add the user to a group

put

Add the user to a group

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userIdstringRequired

The ID of the user

groupIdstringRequired

The ID of the group

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

put

/users/{userId}/groups/{groupId}

HTTPcURLJavaScriptPython

PUT /users/{userId}/groups/{groupId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{}

Remove the user from the group

delete

Remove the user from the group

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userIdstringRequired

The ID of the user

groupIdstringRequired

The ID of the group

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

delete

/users/{userId}/groups/{groupId}

HTTPcURLJavaScriptPython

DELETE /users/{userId}/groups/{groupId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{}