This page contains the following endpoints:

  • Share Eligible Authorized Groups
  • Share Eligible Authorized Teams
  • Share Eligible Authorized Users
  • Share Eligible Projects

Share Eligible Authorized Groups

List all groups eliglble to be a share authorized group

GET /organizations/{organization_id}/projects/{project_id}/shares/{share_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/shares/788962653/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: b823b34b-4724-4fa4-831d-c0623756a207
X-Runtime: 0.068721
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

Share Eligible Authorized Teams

List all teams eligible to be a share authorized team

GET /organizations/{organization_id}/projects/{project_id}/shares/{share_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/shares/788962653/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/"9d04ad7202b6e76e4f0fd0cad7d3d631"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 96c67436-b1a9-4186-84a2-7bdb9e0f9bba
X-Runtime: 0.088640
Content-Length: 58

Success Response Example

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

Response Attributes

Name Type Description
id integer Team ID
organization_id integer Organization ID
name string Team name

Share Eligible Authorized Users

List all users eliglble to be a share authorized user

GET /organizations/{organization_id}/projects/{project_id}/shares/{share_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/shares/788962653/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/"30c687d1b20654407d81994e99846927"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 0a0a3cb4-5c4b-43ad-9a4b-25d13a45fbfd
X-Runtime: 0.071309
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_311 Last_name_311",
    "first_name": "First_name_311",
    "last_name": "Last_name_311",
    "email": "email_298@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 User is active
expires_at dateTime When user set to expire (optional)

Share Eligible Projects

/organizations/{organization_id}/projects/{project_id}/shares/{share_id}/settings/eligible/projects

This endpoint allows you to manage share eligible projects.

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/shares/788962653/settings/eligible/projects" -X GET \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

List eligible projects to which the share can be moved

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

Request Example

curl -g "http://shares.example.com/organizations/32400255/projects/800313582/shares/788962653/settings/eligible/projects" -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/"3dd9f6a66fc96c54b0d173c83de7be73"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: f260a6e8-5453-4870-aa61-d41fa4ddc0b1
X-Runtime: 0.038612
Content-Length: 46

Success Response Example

200 OK
[
  {
    "id": 25882519,
    "name": "Destination Project"
  }
]

Response Attributes

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

Move a share to a different project

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

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/shares/788962653/settings/eligible/projects/25882519" -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: f90e77af-6db5-4cb8-a545-59e7ac8cb48d
X-Runtime: 0.118091

Success Response Example

204 No Content

Error Response Example

422 Unprocessable Entity

Example Response Body

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

Video player

Video

×