This page contains the following endpoints:

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

Organization Eligible Available Groups

This endpoint allows you to list (GET) all groups eligible to be an organization available group.

List all groups eligible to be an organization available group

GET /organizations/{organization_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/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: 675dcf0d-cc7f-40cb-8f26-9d13ee3d117f
X-Runtime: 0.044899
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

Organization Eligible Available Nodes API

This endpoint allows you to list (GET) all nodes eligible to be an organization available node.

List all nodes eligible to be an organization available node

GET /organizations/{organization_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/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/"f607d48d7003f5ff9641fe69205d6480"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e5ef32e5-4eff-4b92-bc62-43539b45db77
X-Runtime: 0.046299
Content-Length: 271

Success Response Example

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

Organization Eligible Available Users

This endpoint allows you to list (GET) all users eligible to be an organization available user.

List all users eligible to be an organization available user

GET /organizations/{organization_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/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/"aeae519730871002478beea25885ab99"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 5d70c965-c521-4adf-ab7d-c34a6effe601
X-Runtime: 0.068831
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_278 Last_name_278",
    "first_name": "First_name_278",
    "last_name": "Last_name_278",
    "email": "email_265@example.com",
    "active": true
  }
]

Response Attributes

Name Type Description
id integer User ID
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 (optional)
Video player

Video

×