This contains the endpoints for Organization Admin Groups, Teams, and Users


Organization Admin Groups

/organizations/{organization_id}/settings/organization_admin_groups

This endpoint allows you to manage organization admin groups.

Request Headers

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

Request Example Format

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_groups" -d '{"group_id":72325086,"can_see_all_nodes":false,"can_see_all_users":false}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
group_id Required integer ID of group
can_see_all_nodes Optional boolean Can see all nodes
can_see_all_users Optional boolean Can see all users

Success Response Codes

Method Code
GET 200 OK
POST 201 Created
PUT 200 OK
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
PUT 422 Unprocessable Entity Submitted a parameter with an invalid or empty value

Response Attributes

Name Type Description
id integer ID for group resource
can_see_all_nodes boolean Can see all nodes
can_see_all_users boolean Can see all users
group JSON object Object containing the group ID


List all organization admin groups

GET /organizations/{organization_id}/settings/organization_admin_groups

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_admin_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/"4baef18f3af95fd62cfe7a49734ab9af"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: b786c43e-93d8-41a5-9c91-02a0e961557c
X-Runtime: 0.024630
Content-Length: 94

Success Response Example

200 OK
[
  {
    "id": 1035344711,
    "can_see_all_nodes": false,
    "can_see_all_users": true,
    "group": {
    "id": 72325086
      }
   }
]


Get a specific organization admin group

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

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_admin_groups/1035344711" -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/"1c39fb644742ccdc79fbcc7da1ed62ae"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: a8b349e3-97cc-48d2-9035-4c0e7907cc7a
X-Runtime: 0.020631
Content-Length: 93

Success Response Example

200 OK
{
  "id": 1035344711,
  "can_see_all_nodes": false,
  "can_see_all_users": false,
  "group": {
    "id": 72325086
  }
}


Authorize a group as an organization admin group

POST /organizations/{organization_id}/settings/organization_admin_groups

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_groups" -d '{"group_id":72325086,"can_see_all_nodes":false,"can_see_all_users":false}' -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/"c479193d65b4165d61dd0b0a0d6d2ed6"
  Cache-Control: max-age=0, private, must-revalidate
  X-Request-Id: aefd183e-3125-4042-9aab-9afbe974b604
  X-Runtime: 0.072307
  Content-Length: 84

Success Response Example

201 Created
{
  "id": 2,
  "can_see_all_nodes": false,
  "can_see_all_users": false,
  "group": {
    "id": 72325086
    }
  }

Error Response Example

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


Update an organization admin group

PUT /organizations/{organization_id}/settings/organization_admin_groups/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_groups/1035344711" -d '{"can_see_all_users":true}' -X PUT

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/"f73a70e5278de2608d35259b161c3b75"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 5286992d-78ed-40d8-bf81-8277b1d25b55
X-Runtime: 0.037204
Content-Length: 92

Success Response Example

200 OK
{
  "id": 1035344711,
  "can_see_all_nodes": false,
  "can_see_all_users": true,
  "group": {
    "id": 72325086
  }
}

Error Response Example

422 Unprocessable Entity
{
      "errors": {
        "can_see_all_users": [
          "is not included in the list"
    ]
  }
}


Remove an organization admin group

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

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_groups/1035344711" -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: 9c8d10cf-2c7e-4d8a-8760-d134a593bdeb
X-Runtime: 0.018903

Success Response Example

204 No Content


Organization Admin Teams

/organizations/{organization_id}/settings/organization_admin_teams

This endpoint allows you to manage organization admin teams.

Request Headers

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

Request Example Format

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_teams" -d '{"team_id":81831458,"can_see_all_nodes":false,"can_see_all_users":false}' -X POST \
    	-H "Content-Type: application/json" \
    	-H "Accept: application/json" \
    	-H "Authorization: Bearer access_token" \
    	-H "Host: example.org" \
    	-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
team_id Required integer ID of team
can_see_all_nodes Optional boolean Can see all nodes
can_see_all_users Optional boolean Can see all users

Success Response Codes

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

Error Response Codes

Description of error is included in response body.

Method Error Reason
POST 422 Unprocessable Entity Team has already been taken
PUT 422 Unprocessable Entity Submitted a parameter with an invalid or empty value

Response Attributes

Name Type Description
id integer ID for the team resource
can_see_all_nodes boolean Can see all nodes
can_see_all_users boolean Can see all users
team JSON object Object containing the team ID


Show a specific organization admin team

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

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_admin_teams/228767248" -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/"d6cf96342680c835cd865146a910c068"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 360f2923-75fe-4e5b-950e-8d05f6829985
X-Runtime: 0.035797
Content-Length: 91

Success Response Example

200 OK
{
"id": 228767248,
"can_see_all_nodes": false,
"can_see_all_users": false,
"team": {
"id": 81831458
  }
}


Authorize a team as an organization admin team

POST /organizations/{organization_id}/settings/organization_admin_teams

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_teams" -d '{"team_id":81831458,"can_see_all_nodes":false,"can_see_all_users":false}' -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/"692fbf9b4b6c000f1d1b85395c030882"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c4f9d4c9-0f78-4c59-bbe5-fab06259f01f
X-Runtime: 0.043686
Content-Length: 91

Success Response Example

201 Created
{
  "id": 228767250,
  "can_see_all_nodes": false,
  "can_see_all_users": false,
  "team": {
    "id": 81831458
  }
}

Error Response Example

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


Update an organization admin team

PUT /organizations/{organization_id}/settings/organization_admin_teams/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_teams/228767248" -d '{"can_see_all_users":true}' -X PUT

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/"6f2ab4975364e88bde20f6e3dca08108"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 6ffec38a-58b4-4e31-b123-314a4dd482fa
X-Runtime: 0.035660
Content-Length: 90

Success Response Example

200 OK
{
  "id": 228767248,
  "can_see_all_nodes": false,
  "can_see_all_users": true,
  "team": {
    "id": 81831458
  }
}

Error Response Example

422 Unprocessable Entity
{
              "errors": {
                "can_see_all_users": [
                  "is not included in the list"
      ]
   }
}


Remove an organization admin team

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

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_teams/228767248" -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: dc3a5f69-5f62-49f0-90a3-b50482a9c745
X-Runtime: 0.021244

Success Response Example

204 No Content


Organization Admin Users

/organizations/{organization_id}/settings/organization_admin_users

This endpoint manages organization admin 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_admin_users" -d '{"user_id":830138774,"can_see_all_nodes":false,"can_see_all_users":false}' -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
user_id Required integer ID of user
can_see_all_nodes Optional boolean Can see all nodes
can_see_all_users Optional boolean Can see all users

Success Response Codes

Method Code
GET 200 OK
POST 201 Created
PUT 200 OK
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
PUT 422 Unprocessable Entity Submitted a parameter with an invalid or empty value

Response Attributes

Name Type Description
id integer ID for user resource
can_see_all_nodes boolean Can see all nodes
can_see_all_users boolean Can see all users
user JSON object Object that contains the user ID

List all organization admin users

GET /organizations/{organization_id}/settings/organization_admin_users

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_admin_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/"4dc7acf713115bdc71b3cef41c00196a"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c79dce51-82d8-4abd-8284-631b334a5e3e
X-Runtime: 0.043342
Content-Length: 92

Success Response Example

200 OK
[
{
  "id": 80856647,
  "can_see_all_nodes": false,
  "can_see_all_users": true,
  "user": {
    "id": 830138774
    }
  }
]


Get a specific organization admin user

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

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/organization_admin_users/80856647" -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/"914cb3dbe44f1fd10943f3c50e991b94"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: be06a92e-3f43-487c-8172-e367be3607f9
X-Runtime: 0.020729
Content-Length: 91

Success Response Example

200 OK
{
"id": 80856647,
"can_see_all_nodes": false,
"can_see_all_users": false,
"user": {
"id": 830138774
  }
}


Authorize a user as an organization admin user

POST /organizations/{organization_id}/settings/organization_admin_users

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_users" -d '{"user_id":830138774,"can_see_all_nodes":false,"can_see_all_users":false}' -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/"7a0810315aeffb89c7fe2682eda65ff7"
        Cache-Control: max-age=0, private, must-revalidate
        X-Request-Id: 851d4f5e-8581-4483-8827-1ffe9525c539
        X-Runtime: 0.045688
        Content-Length: 91

Success Response Example

201 Created
{
        "id": 80856665,
        "can_see_all_nodes": false,
        "can_see_all_users": false,
        "user": {
        "id": 830138774
        }
        }

Error Response Example

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


Update an organization admin user

PUT /organizations/{organization_id}/settings/organization_admin_users/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_users/80856647" -d '{"can_see_all_users":true}' -X PUT

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/"7bcf41eb0b67953abdf6b4aa13acee04"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 3e7be57b-d579-46dc-9b04-1406917f92c1
X-Runtime: 0.041184
Content-Length: 90

Success Response Example

200 OK
{
  "id": 80856647,
  "can_see_all_nodes": false,
  "can_see_all_users": true,
  "user": {
    "id": 830138774
  }
}

Error Response Example

200 OK
{
    "errors": {
      "can_see_all_users": [
        "is not included in the list"
      ]
   }
}


Remove an organization admin user

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

Request Example

curl "http://shares.example.com/organizations/32400255/settings/organization_admin_users/80856647" -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: 0551353e-cf3b-451f-93b9-46935e0d315b
  X-Runtime: 0.029866

Success Response Example

204 No Content

Video player

Video

×