This page contains the following endpoints:

  • Organization Available Groups
  • Organization Available Nodes
  • Organization Available Users

Organization Available Groups

This endpoint allows you to manage organization available 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/settings/organization_available_groups" -d '{"group_id":72325086}' -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 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 organization available groups.

GET /organizations/{organization_id}/settings/organization_available_groups

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_available_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/"1aa0bcdfbd4580e31b22604be978867e"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 8e574bcb-2243-4477-bef5-254adf67719c
X-Runtime: 0.024393
Content-Length: 42

Success Response Example

200 OK
[
  {
    "id": 338943319,
    "group": {
      "id": 72325086
    }
  }
]


Get a specific organization available group

GET /organizations/{organization_id}/settings/organization_available_groups/{id}

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_available_groups/338943319" -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/"c9d45240c3084491ba59fb78a3baa8b3"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 2ebbdf3f-66b7-4aff-9d1c-cb90ee04456a
X-Runtime: 0.031686
Content-Length: 40

Success Response Example

200 OK
{
  "id": 338943319,
  "group": {
    "id": 72325086
  }
}


Add a group as an organization available group

POST /organizations/{organization_id}/settings/organization_available_groups

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_available_groups" -d '{"group_id":72325086}' -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/"520c30db0ffee409ee10b3fc9d50a909"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 5d298328-5111-4ae9-99c7-2b325cf230fd
X-Runtime: 0.026810
Content-Length: 40

Success Response Example

201 Created
{
  "id": 338943320,
  "group": {
    "id": 72325086
  }
}

Error Response Example

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


Remove an organization available group

DELETE /organizations/{organization_id}/settings/organization_available_groups/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_available_groups/338943319" -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: acf19c62-0760-4c0f-bc0d-1ba912c4bd96
X-Runtime: 0.022058

Success Response Example

204 No Content


Organization Available Nodes

This endpoint allows you to manage organization available nodes.

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/settings/organization_available_nodes" -d '{"node_id":92268615}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

Response Attributes

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

List all organization available nodes

GET /organizations/{organization_id}/settings/organization_available_nodes

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_available_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/"7dc1c6800d869056561a446b93a82bf3"
        Cache-Control: max-age=0, private, must-revalidate
        X-Request-Id: d68b5ca7-5719-40bc-a7bb-fe0ba644144b
        X-Runtime: 0.024316
        Content-Length: 41

Success Response Example

200 OK
[
          {
            "id": 710860366,
            "node": {
              "id": 92268615
            }
          }
        ]


Get a specific organization available node

GET /organizations/{organization_id}/settings/organization_available_nodes/{id}

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_available_nodes/710860366" -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/"34e11213970fc42180cb0bdb2103add6"
          Cache-Control: max-age=0, private, must-revalidate
          X-Request-Id: ff2d4408-8e0f-46a0-b977-088a678213a9
          X-Runtime: 0.023309
          Content-Length: 39

Success Response Example

200 OK
{
          "id": 710860366,
          "node": {
            "id": 92268615
          }
          }


Add a node as an organization available node

POST /organizations/{organization_id}/settings/organization_available_nodes

Request Parameters

Name Required/Optional Type Description
node_id Required integer Node ID

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_available_nodes" -d '{"node_id":92268615}' -X POST

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/"cabc92ea516c094d3b03f2ecb7a7691a"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: a48bd76e-8f33-41cc-acc6-fd3f0817b8de
X-Runtime: 0.041178
Content-Length: 31

Success Response Example

201 Created
{
  "id": 1,
  "node": {
    "id": 92268615
  }
}

Error Response Example

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


Remove an organization available node

DELETE /organizations/{organization_id}/settings/organization_available_nodes/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_available_nodes/710860366" -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: 5ef6913f-7810-4385-a77f-4026c18c903e
X-Runtime: 0.018674

Success Response Example

204 No Content


Organization Available Users

This endpoint allows you manage organization available 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/settings/organization_available_users" -d '{"user_id":830138774}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

Response Attributes

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

List all organization available users

GET /organizations/{organization_id}/settings/organization_available_users

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_available_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/"f39109f6b3e6976f1d12b523f54ae4f9"
        Cache-Control: max-age=0, private, must-revalidate
        X-Request-Id: 393675ac-a3a6-4bac-a82e-06d1d94c430b
        X-Runtime: 0.024612
        Content-Length: 42

Success Response Example

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


Get a specific organization available user

GET /organizations/{organization_id}/settings/organization_available_users/{id}

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_available_users/582148162" -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/"b03506e986d29eb2d95340601de3b91a"
          Cache-Control: max-age=0, private, must-revalidate
          X-Request-Id: 352a994b-45b3-4fe2-b823-6c7323abe8a1
          X-Runtime: 0.026786
          Content-Length: 40

Success Response Example

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


Add a user as an organization available user

POST /organizations/{organization_id}/settings/organization_available_users

Request Parameters

Name Required/Optional Type Description
user_id Required integer User ID

Request Example

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

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/"c9dc61bcda368e9b537472fd3e1140fd"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: bffd1e68-7c15-4805-a11c-67628a481cff
X-Runtime: 0.027181
Content-Length: 40

Success Response Example

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

Error Response Example

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


Remove an organization available user

DELETE /organizations/{organization_id}/settings/organization_available_users/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_available_users/582148162" -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: 1002e04e-e0e6-48f1-9192-413c73c4cd74
X-Runtime: 0.030249

Success Response Example

204 No Content

Video player

Video

×