This page contains the following endpoints:

  • Team All Users
  • Team All Users Through Groups
  • Team Eligible Groups
  • Team Eligible Users
  • Team Groups
  • Team Users

Team All Users

This endpoint allows you to manage Team All Users.

List all users in the team

GET /organizations/{organization_id}/teams/{team_id}/settings/all/users

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl -g "http://shares.example.com/organizations/32400255/teams/81831458/settings/all/users" -X GET \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
Link: 
X-Pagination: {"total_count":2,"total_pages":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null}
ETag: W/"a53d0f26de8a7d88515288250dfd722e"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ff71c10e-a6d4-4693-af34-b2ea20c69868
X-Runtime: 0.042748
Content-Length: 245

Success Response Example

200 OK
[
  {
    "id": 227792459,
    "name": "Mad Hatter",
    "first_name": "Mad",
    "last_name": "Hatter",
    "email": "madhatter@example.com",
    "active": true
  },
  {
    "id": 358143215,
    "name": "Cheshire Cat",
    "first_name": "Cheshire",
    "last_name": "Cat",
    "email": "cat@example.com",
    "active": true
  }
]

Response Attributes

Name Type Description
id integer ID for user resource
user JSON object Object that contains the user ID

Team All Users Through Groups

This endpoint allows you to manage Team All Users Through Groups.

List all users through groups in the team

GET /organizations/{organization_id}/teams/{team_id}/settings/all_through_groups/users

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl -g "http://shares.example.com/organizations/32400255/teams/81831458/settings/all_through_groups/users" -X GET \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
Link: 
X-Pagination: {"total_count":1,"total_pages":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null}
ETag: W/"c564ac873b9a544f460f38f96dccec8d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 3f2900c8-9710-4564-9d0c-7f2c995424f1
X-Runtime: 0.079007
Content-Length: 122

Success Response Example

200 OK
[
  {
    "id": 358143215,
    "name": "Cheshire Cat",
    "first_name": "Cheshire",
    "last_name": "Cat",
    "email": "cat@example.com",
    "active": true
  }
]

Response Attributes

Name Type Description
id integer User ID
name string Username of user
first_name string First name of user
last_name string Last name of user
email string Email of user
active boolean Active user
expires_at dateTime When user expires

Team Eligible Groups

This endpoint allows you to manage Team Eligible Groups.

List eligible groups for the team

GET /organizations/{organization_id}/teams/{team_id}/settings/eligible/groups

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl -g "http://shares.example.com/organizations/32400255/teams/81831458/settings/eligible/groups" -X GET \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
Link: 
X-Pagination: {"total_count":2,"total_pages":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null}
ETag: W/"0b2e6a65fae42ee8108f9ffcd68494b9"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 841d93ec-e142-4cba-a356-8d951d5e1a4d
X-Runtime: 0.049553
Content-Length: 66

Success Response Example

200 OK
[
  {
    "id": 767575238,
    "name": "Group"
  },
  {
    "id": 834029689,
    "name": "Group2"
  }
]

Response Attributes

Name Type Description
id integer ID of eligible group
name string Name of eligible group

Team Eligible Users

This endpoint allows you to manage team eligible users.

List eligible users for the team

GET /organizations/{organization_id}/teams/{team_id}/settings/eligible/users

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl -g "http://shares.example.com/organizations/32400255/teams/81831458/settings/eligible/users" -X GET \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
Link: 
X-Pagination: {"total_count":3,"total_pages":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null}
ETag: W/"bcd4aa77fc8f343cf492484bb7c9d040"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 06521b36-2f0f-4d76-b6aa-ce6e40b2d34d
X-Runtime: 0.045313
Content-Length: 404

Success Response Example

200 OK
[
  {
    "id": 227792459,
    "name": "Mad Hatter",
    "first_name": "Mad",
    "last_name": "Hatter",
    "email": "madhatter@example.com",
    "active": true
  },
  {
    "id": 358143215,
    "name": "Cheshire Cat",
    "first_name": "Cheshire",
    "last_name": "Cat",
    "email": "cat@example.com",
    "active": true
  },
  {
    "id": 891963376,
    "name": "First_name_390 Last_name_390",
    "first_name": "First_name_390",
    "last_name": "Last_name_390",
    "email": "email_360@example.com",
    "active": true
  }
]

Response Attributes

Name Type Description
id integer User ID
name string Username of user
first_name string First name of user
last_name string Last name of user
email string Email of user
active boolean Active user
expires_at boolean When user expires (optional)

Team Groups

This endpoint allows you to manage Team Groups.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/organizations/32400255/teams/81831458/settings/team_groups" -d '{"group_id":767575238}' -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Success Response Codes

Method Code
GET 200 OK
POST 201 Created
DELETE 204 No Content

Error Response Codes

Description of error is included in response body.

Method Error Reason
POST 422 Unprocessable Entity Group or user has already been taken

Response Attributes

Name Type Description
id integer ID for group resource
group JSON object Object that contains the group ID

List all groups in a team

GET /organizations/{organization_id}/teams/{team_id}/settings/team_groups

Request Example

curl -g "http://shares.example.com/organizations/32400255/teams/81831458/settings/team_groups" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
Link: 
X-Pagination: {"total_count":1,"total_pages":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null}
ETag: W/"6f3ea7c9cbd22152bde9fdf614690d37"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 71ac3270-ea8a-478b-b5fa-f4a8f46b886f
X-Runtime: 0.025635
Content-Length: 43

Success Response Example

200 OK
[
   {
      "id": 717622663,
      "group": {
         "id": 767575238
      }
   }  
]


Get a specific group in a team

GET /organizations/{organization_id}/teams/{team_id}/settings/team_groups/{id}

Request Example

curl -g "http://shares.example.com/organizations/32400255/teams/81831458/settings/team_groups/717622663" -X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer JxiXJGZrCCNcNANJDzx1rTp25ch5ciYwraP5J809ti0" \
-H "Host: example.org" \
-H "Cookie: "

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"22c5f68afab6e34e1fc631c00c0fee76"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 4a1912b4-b558-4299-9661-f3d8e3f070fd
X-Runtime: 0.020438
Content-Length: 41

Success Response Example

200 OK
{
   "id": 717622663,
   "group": {
      "id": 767575238
   }
}

Authorize a group to a team

POST /organizations/{organization_id}/teams/{team_id}/settings/team_groups

Request Example

curl "http://shares.example.com/organizations/32400255/teams/81831458/settings/team_groups" -d '{"group_id":767575238}' -X POST

Request Parameters

Name Required/Optional Type Description
group_id Required integer ID of group

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"0725eaf92f12d58e3e2355c162f48453"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 12a168fe-25c1-4484-b3ae-105724f8d901
X-Runtime: 0.045753
Content-Length: 33

Success Response Example

201 Created
{
   "id": 1,
   "group": {
      "id": 767575238
   }
}


Remove a group from a team

DELETE /organizations/{organization_id}/teams/{team_id}/settings/team_groups/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/teams/81831458/settings/team_groups/717622663" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Cache-Control: no-cache
X-Request-Id: 2cbedd1b-985a-4078-a2c3-48f4bc3e0189
X-Runtime: 0.021573

Success Response Example

204 No Content


Team Users

This endpoint allows you to manage Team Users.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/organizations/32400255/teams/81831458/settings/team_users/477241907" -X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Success Response Codes

Method Code
GET 200 OK
POST 201 Created
DELETE 204 No Content

Error Response Codes

Description of error is included in response body.

Method Error Reason
POST 422 Unprocessable Entity Group or user has already been taken

Response Attributes

Name Type Description
id integer ID for group resource
user JSON object Object that contains the user ID

List all users in a team

GET /organizations/{organization_id}/teams/{team_id}/settings/team_users

Request Example

curl -g "http://shares.example.com/organizations/32400255/teams/81831458/settings/team_users" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
Link: 
X-Pagination: {"total_count":1,"total_pages":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null}
ETag: W/"c352f7c6ee8a96edd74d0bad47154350"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: b80cf8e7-4a61-4482-97d6-e9ab16848f28
X-Runtime: 0.024359
Content-Length: 42

Success Response Example

200 OK
[
   {
      "id": 477241907,
      "user": {
         "id": 830138774
      }  
   }
]


Get a specific user in a team

GET /organizations/{organization_id}/teams/{team_id}/settings/team_users/{id}

Request Example

curl -g "http://shares.example.com/organizations/32400255/teams/81831458/settings/team_users/477241907" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"4ca78ca55fddd1898fefae325d84d462"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 20c1954e-6c2e-469c-a02b-ec2c6a87be26
X-Runtime: 0.020715
Content-Length: 40

Success Response Example

200 OK
{
   "id": 477241907,
   "user": {
      "id": 830138774
   }
}


Authorize a user to a team

POST /organizations/{organization_id}/teams/{team_id}/settings/team_users

Request Example

curl "http://shares.example.com/organizations/32400255/teams/81831458/settings/team_users" -d '{"user_id":830138774}' -X POST

Request Parameters

Name Required/Optional Type Description
user_id Required integer ID of user

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"f2fdf2290e566d468e304cde7025aefb"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: a26a6212-d5d0-46ea-a1e8-37c0d49b42d2
X-Runtime: 0.028613
Content-Length: 40

Success Response Example

201 Created
{
   "id": 477241908,
   "user": {
      "id": 830138774
   }
}

Error Response Example

422 Unprocessable Entity
{
   "errors": {
      "user": [
         "has already been taken"
    ]
  }
}


Remove a user from a team

DELETE /organizations/{organization_id}/teams/{team_id}/settings/team_users/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/teams/81831458/settings/team_users/477241907" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Cache-Control: no-cache
X-Request-Id: db2dff8e-3a6f-4b96-b85a-5952f95e268a
X-Runtime: 0.020541

Success Response Example

204 No Content

Video player

Video

×