List who a workspace is shared with
curl --request GET \
--url https://api.onecli.sh/v1/workspaces/{workspaceId}/access \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.onecli.sh/v1/workspaces/{workspaceId}/access"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.onecli.sh/v1/workspaces/{workspaceId}/access', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onecli.sh/v1/workspaces/{workspaceId}/access",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.onecli.sh/v1/workspaces/{workspaceId}/access"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.onecli.sh/v1/workspaces/{workspaceId}/access")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onecli.sh/v1/workspaces/{workspaceId}/access")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"users": [
{
"id": "<string>",
"userId": "<string>",
"name": "<string>",
"email": "<string>",
"role": "owner",
"isOwner": true,
"createdAt": "2023-11-07T05:31:56Z"
}
],
"groups": [
{
"id": "<string>",
"groupId": "<string>",
"name": "<string>",
"memberCount": 123,
"createdAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": "<string>"
}Workspace access
List who a workspace is shared with
Shows the human access bindings of a workspace, meaning people with their management role and groups. An Enterprise management action for workspace sharing.
GET
/
workspaces
/
{workspaceId}
/
access
List who a workspace is shared with
curl --request GET \
--url https://api.onecli.sh/v1/workspaces/{workspaceId}/access \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.onecli.sh/v1/workspaces/{workspaceId}/access"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.onecli.sh/v1/workspaces/{workspaceId}/access', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onecli.sh/v1/workspaces/{workspaceId}/access",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.onecli.sh/v1/workspaces/{workspaceId}/access"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.onecli.sh/v1/workspaces/{workspaceId}/access")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onecli.sh/v1/workspaces/{workspaceId}/access")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"users": [
{
"id": "<string>",
"userId": "<string>",
"name": "<string>",
"email": "<string>",
"role": "owner",
"isOwner": true,
"createdAt": "2023-11-07T05:31:56Z"
}
],
"groups": [
{
"id": "<string>",
"groupId": "<string>",
"name": "<string>",
"memberCount": 123,
"createdAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": "<string>"
}Returns the workspace’s human access bindings: people with their role, and groups. This is a management action. See User provisioning for how people and groups get into OneCLI.
The workspace’s human access bindings — people (with their management role) and groups. A management action.
Availability: Cloud · Enterprise (self-hosted). Not available on the Community edition: a self-hosted deployment needs
ENTERPRISE_ENABLED=true, otherwise the endpoint answers 403 with error.type: "enterprise_license_required".Authorizations
A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.