This page contains the following endpoints:

  • Project Eligible Admin Groups
  • Project Eligible Admin Teams
  • Project Eligible Admin Users
  • Project Eligible Authorized Teams
  • Project Eligible Authorized Group
  • Project Eligible Authorized Users
  • Project Eligible Available Groups
  • Project Eligible Available Nodes
  • Project Eligible Available Teams
  • Project Eligible Available Users
  • Project Eligible Organizations

Project Eligible Admin Groups

List all groups eliglble to be a project admin group

GET /organizations/{organization_id}/projects/{project_id}/settings/eligible_admin/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/projects/800313582/settings/eligible_admin/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":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: a53ba1c6-03f8-4fbc-9f4d-0b146d46fd99
X-Runtime: 0.061899
Content-Length: 33

Success Response Example

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

Response Attributes

Name Type Description
id integer Group ID
name string Group name

Project Eligible Admin Teams

List all teams eligible to be an admin of the project

GET /organizations/{organization_id}/projects/{project_id}/settings/eligible_admin/teams

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/projects/800313582/settings/eligible_admin/teams" -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/"09b2375c38a5783e41c90ef29e2353ca"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c55d90f8-2971-4660-b3e4-abf7f2e62c39
X-Runtime: 0.064778
Content-Length: 31

Success Response Example

200 OK
[
  {
    "id": 81831458,
    "name": "Team"
  }
]

Response Attributes

Name Type Description
id integer Team ID
name string Team name

Project Eligible Admin Users

List all users eliglble to be a project admin user

GET /organizations/{organization_id}/projects/{project_id}/settings/eligible_admin/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/projects/800313582/settings/eligible_admin/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/"04b012af57b1ebe2e7468090668a5559"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fec28014-42d1-4203-bce9-0ad6530a03ab
X-Runtime: 0.060806
Content-Length: 283

Success Response Example

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

Response Attributes

Name Type Description
id integer ID of user
name string Username of user
first_name string First name of user
last_name string Last name of user
email string Email address of user
active boolean Active user
expires_at datetime Account expires at

Project Eligible Authorized Groups

List all groups eliglble to be a project authorized group

GET /organizations/{organization_id}/projects/{project_id}/settings/eligible_authorized/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/projects/800313582/settings/eligible_authorized/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":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: 7b45e096-73b0-4768-86fb-702283938c5b
X-Runtime: 0.065324
Content-Length: 33

Success Response Example

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

Response Attributes

Name Type Description
id integer Group ID
name string Group name

Project Eligible Authorized Teams

List all teams eliglble to be authorized to the project

GET /organizations/{organization_id}/projects/{project_id}/settings/eligible_authorized/teams

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/projects/800313582/settings/eligible_authorized/teams" -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/"09b2375c38a5783e41c90ef29e2353ca"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fe7443e2-1eb3-4d51-bbca-52420dbe26e5
X-Runtime: 0.064045
Content-Length: 31

Success Response Example

200 OK
[
  {
    "id": 81831458,
    "name": "Team"
  }
]

Response Attributes

Name Type Description
id integer Team ID
name string Team name

Project Eligible Authorized Users

List all users eliglble to be a project admin user

GET /organizations/{organization_id}/projects/{project_id}/settings/eligible_authorized/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/projects/800313582/settings/eligible_authorized/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/"4c12f412b9c1b9441280dcea085329f8"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 444a9b56-1212-47b3-8f01-a3faba5a6a12
X-Runtime: 0.070307
Content-Length: 283

Success Response Example

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

Response Attributes

Name Type Description
id integer ID of user
name string Username of user
first_name string First name of user
last_name string Last name of user
email string Email address of user
active boolean Active user
expires_at datetime Account expires at

Project Eligible Available Groups

List all groups eliglble to be a project available user

GET /organizations/{organization_id}/projects/{project_id}/settings/eligible_available/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/projects/800313582/settings/eligible_available/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":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: 675c1111-45ce-4ee8-a136-4d9551154c21
X-Runtime: 0.087503
Content-Length: 33

Success Response Example

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

Response Attributes

Name Type Description
id integer Group ID
name string Group name

Project Eligible Available Nodes

List all nodes eliglble to be a project available node

GET /organizations/{organization_id}/projects/{project_id}/settings/eligible_available/nodes

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/projects/800313582/settings/eligible_available/nodes" -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/"fcdda515aa78346afc73f32eb54fe888"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: abe9c9ad-23a0-4cdb-848a-56f611bc0576
X-Runtime: 0.061621
Content-Length: 271

Success Response Example

200 OK
[
  {
    "id": 92268651,
    "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
  }
]

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

Project Eligible Available Teams

List all teams eligible to be available to the project

GET /organizations/{organization_id}/projects/{project_id}/settings/eligible_available/teams

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/projects/800313582/settings/eligible_available/teams" -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/"09b2375c38a5783e41c90ef29e2353ca"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 13debad3-1553-48ed-bf4f-925ef5df1699
X-Runtime: 0.062094
Content-Length: 31

Success Response Example

200 OK
[
  {
    "id": 81831458,
    "name": "Team"
  }
]

Response Attributes

Name Type Description
id integer ID of team
name string Name of team

Project Eligible Available Users

List all users eliglble to be a project available user

GET /organizations/{organization_id}/projects/{project_id}/settings/eligible_available/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/projects/800313582/settings/eligible_available/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/"e4ce4675d37896742609c2af0e0611a0"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 325c05d3-9f6b-4f7e-b3ca-ca9fe1765462
X-Runtime: 0.090172
Content-Length: 278

Success Response Example

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

Response Attributes

Name Type Description
id integer ID of user
name string Username of user
first_name string First name of user
last_name string Last name of user
email string Email address of user
active boolean Active user
expires_at datetime Account expires at

Project Eligible Organizations

This endpoint allows you to manage project eligible organizations.

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/386187204/projects/800313582/settings/eligible/organizations/817936564" -d '' -X PUT \
-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
PUT 204 No Content

Error Response Codes

Description of error is included in response body.

Method Error Reason
PUT 422 Unprocessable Entity Name has already been taken

List eligible projects to which the share can be moved

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

Request Example

curl -g "http://shares.example.com/organizations/386187204/projects/800313582/settings/eligible/organizations" -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/"7c0ae1016f969682466fc20030e8246f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 5ab91acd-e459-49ed-939b-674e7c229f63
X-Runtime: 0.033975
Content-Length: 52

Success Response Example

200 OK
[
  {
    "id": 817936564,
    "name": "Destination Organization"
  }
]

Response Attributes

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

Move a project to a different organization

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

Caution: Moving a project to another organization will remove all team authorizations on the project.

Request Example

curl "http://shares.example.com/organizations/386187204/projects/800313582/settings/eligible/organizations/817936564" -d '' -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
Cache-Control: no-cache
X-Request-Id: 4afa2c4f-f7dc-49ec-935e-e32e1607f3a4
X-Runtime: 0.113553

Success Response Example

204 No Content

Error Response Example

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

Video player

Video

×