Link a Slack identity to an org member

Link a provider identity to a member

curl --request POST \
  --url https://api.onecli.sh/v1/org/channels/{provider}/user-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalUserId": "<string>",
  "userId": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/org/channels/{provider}/user-links"

payload = {
    "externalUserId": "<string>",
    "userId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({externalUserId: '<string>', userId: '<string>'})
};

fetch('https://api.onecli.sh/v1/org/channels/{provider}/user-links', 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/org/channels/{provider}/user-links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'externalUserId' => '<string>',
    'userId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onecli.sh/v1/org/channels/{provider}/user-links"

	payload := strings.NewReader("{\n  \"externalUserId\": \"<string>\",\n  \"userId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.onecli.sh/v1/org/channels/{provider}/user-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalUserId\": \"<string>\",\n  \"userId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/org/channels/{provider}/user-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalUserId\": \"<string>\",\n  \"userId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "externalUserId": "<string>",
  "linkedVia": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "user": {
    "id": "<string>",
    "email": "<string>",
    "name": "<string>"
  },
  "integration": {
    "provider": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

org

channels

{provider}

user-links

Link a provider identity to a member

curl --request POST \
  --url https://api.onecli.sh/v1/org/channels/{provider}/user-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalUserId": "<string>",
  "userId": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/org/channels/{provider}/user-links"

payload = {
    "externalUserId": "<string>",
    "userId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({externalUserId: '<string>', userId: '<string>'})
};

fetch('https://api.onecli.sh/v1/org/channels/{provider}/user-links', 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/org/channels/{provider}/user-links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'externalUserId' => '<string>',
    'userId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onecli.sh/v1/org/channels/{provider}/user-links"

	payload := strings.NewReader("{\n  \"externalUserId\": \"<string>\",\n  \"userId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.onecli.sh/v1/org/channels/{provider}/user-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalUserId\": \"<string>\",\n  \"userId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/org/channels/{provider}/user-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalUserId\": \"<string>\",\n  \"userId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "externalUserId": "<string>",
  "linkedVia": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "user": {
    "id": "<string>",
    "email": "<string>",
    "name": "<string>"
  },
  "integration": {
    "provider": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Tells OneCLI which member a Slack user is. Agents then act with that member’s permissions when they reply. See Agent access. Tells OneCLI which member a Slack user is, so their messages run under that member’s access. The member must be active.

Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

provider

enum<string>

required

Channel provider. Slack is the only provider today.

Available options:

slack

Body

application/json

externalUserId

string

required

The Slack user id.

Maximum string length: 200

userId

string

required

The OneCLI member's user id.

Maximum string length: 200

Response

The link

An explicit link between a provider identity (a Slack user) and a OneCLI member.

string

externalUserId

string

linkedVia

string

How the link was made (manual for admin-made links).

createdAt

string<date-time>

user

object

Show child attributes

integration

object

List reads only.

Show child attributes

Workspace

Organization

Enterprise

Platform

Link a Slack identity to an org member

Authorizations

Path Parameters

Body

Response