This page includes the following endpoints:

  • Project Admin Groups
  • Project Admin Teams
  • Project Admin Users

Project Admin Groups

This endpoint allows you to manage admin 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/projects/800313582/settings/project_admin_groups" -d '{"group_id":72325086,"can_see_organization_nodes":true,"can_see_organization_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_organization_nodes Optional boolean Can see organization nodes
can_see_organization_users Optional boolean Can see organization 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 can_see_organization_users or other parameter is missing in request

Response Attributes

Name Type Description
id integer ID for group resource
can_see_organization_nodes boolean Can access organization nodes
can_see_organization_users boolean Can access organization users
group JSON object Object that contains the group ID

List all project admin groups

GET /organizations/{organization_id}/projects/{project_id}/settings/project_admin_groups

Request Example

curl -g "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_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/"f56a185232bf7461e5e08ac4cda0d35f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 064a45e4-7a7a-475f-984b-d5e555a8072a
X-Runtime: 0.030962
Content-Length: 111

Success Response Example

200 OK
[
{
"id": 86329540,
"can_see_organization_nodes": false,
"can_see_organization_users": false,
"group": {
  "id": 72325086
}
}
]


Get a specific project admin group

GET /organizations/{organization_id}/projects/{project_id}/settings/project_admin_groups/{id}

Request Example

curl -g "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_groups/86329540" -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/"1ae6a7bd349a21329ec89b1726768037"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 0559a4b2-c3ab-4174-b50c-59a84cfdecde
X-Runtime: 0.028991
Content-Length: 109

Success Response Example

200 OK
{
"id": 86329540,
"can_see_organization_nodes": false,
"can_see_organization_users": false,
"group": {
"id": 72325086
}
}


Authorize a group as a project admin group

POST /organizations/{organization_id}/projects/{project_id}/settings/project_admin_groups

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_groups" -d '{"group_id":72325086,"can_see_organization_nodes":true,"can_see_organization_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/"014d4c2108847911eed330cf0e5433d4"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 35e9a7ea-5d76-4899-852c-a2c769611ab1
X-Runtime: 0.076492
Content-Length: 108

Success Response Example

201 Created
{
  "id": 86329542,
  "can_see_organization_nodes": true,
  "can_see_organization_users": false,
  "group": {
    "id": 72325086
  }
}

Error Response Example

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


Update a project admin group

PUT /organizations/{organization_id}/projects/{project_id}/settings/project_admin_groups/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_groups/86329540" -d '{"can_see_organization_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/"3a3e479f4d8a090e5d70ab2e56bc121b"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 09b00682-4f12-49ac-bdf3-3941357cf787
X-Runtime: 0.080357
Content-Length: 108

Success Response Example

200 OK
{
  "id": 86329540,
  "can_see_organization_nodes": false,
  "can_see_organization_users": true,
  "group": {
    "id": 72325086
  }
}

Error Response Example

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


Remove a project admin group

DELETE /organizations/{organization_id}/projects/{project_id}/settings/project_admin_groups/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_groups/86329540" -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: acd69945-ef3c-49b3-b6c7-aedc675d6ea6
  X-Runtime: 0.036619

Success Response Example

204 No Content


Project Admin Teams

/organizations/{organization_id}/projects/{project_id}/settings/project_admin_teams

This endpoint allows you to manage admin teams in relation to projects.

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/projects/800313582/settings/project_admin_teams" -d '{"team_id":72325086,"can_see_organization_nodes":true,"can_see_organization_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_organization_nodes Optional boolean Can see organization nodes
can_see_organization_users Optional boolean Can see organization 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 can_see_organization_users or other parameter is missing in request"

Response Attributes

Name Type Description
id integer ID for team resource
can_see_organization_nodes boolean Can access organization nodes
can_see_organization_users boolean Can access organization users
team JSON object Object that contains the team ID

List all admin teams in a project

GET /organizations/{organization_id}/projects/{project_id}/settings/project_admin_teams

Request Example

curl -g "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_teams" -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/"602b9ac74404e3f5d01cbc5b08d228b1"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 307f78b6-ac72-4918-a94f-1821706981b4
X-Runtime: 0.043625
Content-Length: 112

Success Response Example

200 OK
[
{
"id": 1012883408,
"can_see_organization_nodes": false,
"can_see_organization_users": false,
"team": {
  "id": 72325086
}
}
]


Get a specific admin team in a project

GET /organizations/{organization_id}/projects/{project_id}/settings/project_admin_teams/{id}

Request Example

curl -g "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_teams/1012883408" -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/"896f48c8532d82960481c193919505d3"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 8e315df8-484c-48dc-8031-d48a6abcc0ca
X-Runtime: 0.028677
Content-Length: 110

Success Response Example

200 OK
{
"id": 1012883408,
"can_see_organization_nodes": false,
"can_see_organization_users": false,
"team": {
  "id": 72325086
}
}


Authorize an admin team to a project

POST /organizations/{organization_id}/projects/{project_id}/settings/project_admin_teams

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_teams" -d '{"team_id":72325086,"can_see_organization_nodes":true,"can_see_organization_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/"e4fc435f93b026a941e5930e40e66a29"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 00d4ad32-fcbf-478a-8fb2-8209cc4d73f0
X-Runtime: 0.073562
Content-Length: 109

Success Response Example

201 Created
{
  "id": 1012883409,
  "can_see_organization_nodes": true,
  "can_see_organization_users": false,
  "team": {
    "id": 72325086
  }
}

Error Response Example

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


Update a team's super admin status in a project

PUT /organizations/{organization_id}/projects/{project_id}/settings/project_admin_teams/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_teams/1012883408" -d '{"can_see_organization_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/"966e79079a168ce9427eafbce17a733c"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: cf84c397-c190-4ef8-a68b-6acc9f9040cf
X-Runtime: 0.055680
Content-Length: 109

Success Response Example

201 Created
{
  "id": 1012883408,
  "can_see_organization_nodes": false,
  "can_see_organization_users": true,
  "team": {
    "id": 72325086
  }
}

Error Response Example

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


Remove a team from a project

DELETE /organizations/{organization_id}/projects/{project_id}/settings/project_admin_teams/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_teams/1012883408" -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: 9636308b-b435-4a0f-b489-aeef0b71d378
  X-Runtime: 0.027822

Success Response Example

204 No Content


Project Admin Users

/organizations/{organization_id}/projects/{project_id}/settings/project_admin_users

This endpoint allows you to manage project admin users.

Request Headers

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

Request Example (POST and PUT)

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_users" -d '{"user_id":830138774,"can_see_organization_nodes":false,"can_see_organization_users":false}' -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer access_tokens" \
  -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_organization_nodes Optional boolean Can see organization nodes
can_see_organization_users Optional boolean Can see organization 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 User has already been taken
PUT 422 Unprocessable Entity can_see_organization_users or other parameter is missing in request"

Response Attributes

Name Type Description
id integer ID for team resource
can_see_organization_nodes boolean Can access organization nodes
can_see_organization_users boolean Can access organization users
team JSON object Object that contains the team ID

List all project admin users

GET /organizations/{organization_id}/projects/{project_id}/settings/project_admin_users

Request Example

curl -g "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_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/"a8cfdb66c1184d0a2b59ebd2239500b7"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 7c80eda8-569e-460c-8eb7-aa3222a12085
X-Runtime: 0.038405
Content-Length: 112

Success Response Example

200 OK
[
  {
    "id": 892088221,
    "can_see_organization_nodes": false,
    "can_see_organization_users": false,
    "user": {
      "id": 830138774
    }
  }
]


Get a specific project admin user

GET /organizations/{organization_id}/projects/{project_id}/settings/project_admin_users/{id}

Request Example

curl -g "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_users/892088221" -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/"c865a71490dbd988c74fadb0a3f24458"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1fc88654-16bf-4d6e-89a5-b395b9cd6b1a
X-Runtime: 0.031304
Content-Length: 110

Success Response Example

200 OK
{
  "id": 892088221,
  "can_see_organization_nodes": false,
  "can_see_organization_users": false,
  "user": {
    "id": 830138774
  }
}


Authorize a user a project admin user

POST /organizations/{organization_id}/projects/{project_id}/settings/project_admin_users

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_users" -d '{"user_id":830138774,"can_see_organization_nodes":false,"can_see_organization_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/"c042a2dcab8bdaf287830a424661182a"
    Cache-Control: max-age=0, private, must-revalidate
    X-Request-Id: 48805060-786f-4f67-92f1-e02a407a341b
    X-Runtime: 0.081814
    Content-Length: 110

Success Response Example

201 Created
{
      "id": 892088222,
      "can_see_organization_nodes": false,
      "can_see_organization_users": false,
      "user": {
        "id": 830138774
      }
    }

Error Response Example

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


Update a project admin user

PUT /organizations/{organization_id}/projects/{project_id}/settings/project_admin_users/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_users/892088221" -d '{"can_see_organization_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/"d0a7d39301c3b8efd50714bb992976f7"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1177f89d-c234-42d0-868a-62a1d4be0be0
X-Runtime: 0.056334
Content-Length: 109

Success Response Example

200 OK
{
  "id": 892088221,
  "can_see_organization_nodes": false,
  "can_see_organization_users": true,
  "user": {
    "id": 830138774
  }
}

Error Response Example

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


Remove a project admin user

DELETE /organizations/{organization_id}/projects/{project_id}/settings/project_admin_users/{id}

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project_admin_users/892088221" -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: efef8c46-b76b-45ed-befa-b62fd0bbeed3
X-Runtime: 0.028339

Success Response Example

204 No Content

Video player

Video

×