Provision a user before their first sign-in

Provision a user

curl --request POST \
  --url https://api.onecli.sh/v1/team/provisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "member",
  "skipOnboarding": true
}
'

import requests

url = "https://api.onecli.sh/v1/team/provisions"

payload = {
    "role": "member",
    "skipOnboarding": True
}
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({role: 'member', skipOnboarding: true})
};

fetch('https://api.onecli.sh/v1/team/provisions', 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/team/provisions",
  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([
    'role' => 'member',
    'skipOnboarding' => true
  ]),
  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/team/provisions"

	payload := strings.NewReader("{\n  \"role\": \"member\",\n  \"skipOnboarding\": true\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/team/provisions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"member\",\n  \"skipOnboarding\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/team/provisions")

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  \"role\": \"member\",\n  \"skipOnboarding\": true\n}"

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

{
  "id": "<string>",
  "userId": "<string>",
  "projectId": "<string>",
  "apiKey": "<string>",
  "claimUrl": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

team

provisions

Provision a user

curl --request POST \
  --url https://api.onecli.sh/v1/team/provisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "member",
  "skipOnboarding": true
}
'

import requests

url = "https://api.onecli.sh/v1/team/provisions"

payload = {
    "role": "member",
    "skipOnboarding": True
}
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({role: 'member', skipOnboarding: true})
};

fetch('https://api.onecli.sh/v1/team/provisions', 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/team/provisions",
  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([
    'role' => 'member',
    'skipOnboarding' => true
  ]),
  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/team/provisions"

	payload := strings.NewReader("{\n  \"role\": \"member\",\n  \"skipOnboarding\": true\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/team/provisions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"member\",\n  \"skipOnboarding\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/team/provisions")

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  \"role\": \"member\",\n  \"skipOnboarding\": true\n}"

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

{
  "id": "<string>",
  "userId": "<string>",
  "projectId": "<string>",
  "apiKey": "<string>",
  "claimUrl": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Pre-creates a member, a workspace, and an API key. Hand the key to an agent immediately. The person claims the account later by opening the returned link. See User provisioning. Pre-creates a member with a ready workspace and API key before they ever sign in. The key works immediately; the person claims the account by opening claimUrl and signing in, which transfers everything to their real identity. Unclaimed provisions expire after 7 days. Admin or owner. The response’s projectId field keeps its historical name on the wire; it is the workspace id.

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

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.

Body

application/json

role

enum<string>

default:member

Available options:

admin,

member

skipOnboarding

boolean

default:true

Response

The provision

Returned once when a user is provisioned. The API key is shown only here.

string

Provision record ID.

userId

string

Placeholder user ID (becomes the real user after the claim).

projectId

string

The pre-created workspace ID. The field keeps its historical name on the wire.

apiKey

string

Workspace API key (oc_…), usable immediately.

claimUrl

string

Link the user opens to claim the account.

expiresAt

string<date-time>

When the unclaimed provision expires (7 days from creation).

Workspace

Organization

Enterprise

Platform

Provision a user before their first sign-in

Authorizations

Body

Response