This page contains the following endpoints:

  • Organization All Groups
  • Organization All Teams
  • Organization All Users

Organization All Groups

This endpoint allows you to manage all groups in an organization.

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/settings/all_through_projects/groups" -X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: BBearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Success Response Codes

Method Code
GET 200 OK
DELETE 204 No Content

Response Attributes

Name Type Description
id integer Group ID
name string Group name

List all groups in an organization

GET /organizations/{organization_id}/settings/all/groups

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/all/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/"550778a99887921ab93a27a7b8ec1ae1"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: a9931fae-ac18-4b50-8816-05ea81091642
X-Runtime: 0.050582
Content-Length: 33

Response Example

200 OK

Example Response Body

[
  {
    "id": 767575238,
    "name": "Group"
  }
]


List all groups through projects in an organization

GET /organizations/{organization_id}/settings/all_through_projects/groups

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/all_through_projects/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/"550778a99887921ab93a27a7b8ec1ae1"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 46ed4e4f-b1fd-449b-8dc1-a3192b759166
X-Runtime: 0.067512
Content-Length: 33

Response Example

200 OK

Example Response Body

[
  {
    "id": 767575238,
    "name": "Group"
  }
]


List all groups through shares in an organization

GET /organizations/{organization_id}/settings/all_through_shares/groups

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/all_through_shares/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/"550778a99887921ab93a27a7b8ec1ae1"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: d9b47dc6-4644-4011-a08e-8aadfe1ee234
X-Runtime: 0.063044
Content-Length: 33

Response Example

200 OK

Example Response Body

[
  {
    "id": 767575238,
    "name": "Group"
  }
]


Completely remove a group from an organization

DELETE /organizations/{organization_id}/settings/all/groups/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/settings/all/groups/767575238" -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: 81397a50-9340-462d-bf9d-53e58036e13d
X-Runtime: 0.033410

Response Example

204 No Content


Organization All Nodes

This endpoint allows you to manage all nodes in an organization.

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/settings/all/nodes" -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
PUT 200 OK
DELETE 204 No Content

Response Attributes

Name Type Description
id integer Node ID
name string Node name
port integer Port number
host string Hostname or IP Address
username String Username
http_fallback_port integer HTTP fallback port
ssl_enabled boolean Enable SSL
ssl_peer_certificate_verification_enabled boolean Enable SSL peer certificate verification
read_timeout integer Read timeout
open_timeout integer Open timeout
status string Status
status_at datetime Status at
status_message string Status message

List all nodes in an organization

GET /organizations/{organization_id}/settings/all/nodes

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/all/nodes" -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/"1a4da7fa086f42e5dfd3638a2bedf7ca"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ab017042-7649-41c1-8553-bdd82e08343e
X-Runtime: 0.043535
Content-Length: 271

Response Example

200 OK

Example Response Body

[
  {
    "id": 92268615,
    "name": "test node",
    "port": 9092,
    "host": "example.com",
    "username": "user",
    "http_fallback_port": null,
    "ssl_enabled": true,
    "ssl_peer_certificate_verification_enabled": false,
    "read_timeout": 30,
    "open_timeout": 10,
    "status": null,
    "status_at": null,
    "status_message": null
  }
]


List all nodes through projects in an organization

GET /organizations/{organization_id}/settings/all_through_projects/nodes

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/all_through_projects/nodes" -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/"1a4da7fa086f42e5dfd3638a2bedf7ca"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 347737f7-7dd1-4c83-9d6e-ce1e1eb2a182
X-Runtime: 0.035600
Content-Length: 271

Response Example

200 OK

Example Response Body

[
  {
    "id": 92268615,
    "name": "test node",
    "port": 9092,
    "host": "example.com",
    "username": "user",
    "http_fallback_port": null,
    "ssl_enabled": true,
    "ssl_peer_certificate_verification_enabled": false,
    "read_timeout": 30,
    "open_timeout": 10,
    "status": null,
    "status_at": null,
    "status_message": null
  }
]


Organization All Users Through Groups

This endpoint allows you to list (GET) all users through groups in an organization.


List all users through groups in an organization

GET /organizations/{organization_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/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

-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/"a2bf2effd007ab26bc6714b7fa06d1cd"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 952b1a62-fa80-4ede-ba99-cd19e7c8bbff
X-Runtime: 0.034415
Content-Length: 124

Success Response Example

200 OK

Example Response Body

[
  {
    "id": 227792459,
    "name": "Mad Hatter",
    "first_name": "Mad",
    "last_name": "Hatter",
    "email": "madhatter@example.com",
    "active": true
  }
]

Response Attributes

Name Type Description
id integer User ID
name string User name
first_name string First name
last_name string Last name
email string Email address
active boolean Active
expires_at dateTime Account expires at (optional)

Organization All Users API

This endpoint allows you to manage all users in an organization.

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/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: "

Success Response Codes

Method Code
GET 200 OK
DELETE 204 No Content

Response Attributes

Name Type Description
id integer User ID
active boolean User is active
name string User name
first_name string First name
last_name string Last name
email string Email address
expires_at datetime Account expires at

List all users in an organization

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

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/all/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/"a2bf2effd007ab26bc6714b7fa06d1cd"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c5d6b676-6609-4dff-b383-fb7a6d8b0941
X-Runtime: 0.084496
Content-Length: 124

Success Response Example

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


List all users through projects in an organization

GET /organizations/{organization_id}/settings/all_through_projects/users

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/all_through_projects/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/"a2bf2effd007ab26bc6714b7fa06d1cd"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 32e5f4ec-05ef-457f-80b9-ef4b7e35d3ae
X-Runtime: 0.067555
Content-Length: 124

Success Response Example

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


List all users through shares in an organization

GET /organizations/{organization_id}/settings/all_through_shares/users

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/all_through_shares/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/"a2bf2effd007ab26bc6714b7fa06d1cd"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 49ff25d5-1174-4d0f-989c-31670d30d12f
X-Runtime: 0.040530
Content-Length: 124

Success Response Example

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

Completely remove a user from an organization

DELETE /organizations/{organization_id}/settings/all/users/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/settings/all/users/830138774" -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: 196cb95f-5cd0-4b2d-aac4-43c701f8c199
          X-Runtime: 0.048811

Success Response Example

204 No Content

Video player

Video

×