Associate clients with an organization

Associate one or more clients with an organization.

POST https://{tenantDomain}/api/v2/organizations/{id}/clients

Associate clients with an organization

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/organizations/{id}/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clients": [
    {
      "client_id": "<string>",
      "use_for_member_access": true
    }
  ]
}
'

import requests

url = "https://{tenantDomain}/api/v2/organizations/{id}/clients"

payload = { "clients": [
        {
            "client_id": "<string>",
            "use_for_member_access": 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({clients: [{client_id: '<string>', use_for_member_access: true}]})
};

fetch('https://{tenantDomain}/api/v2/organizations/{id}/clients', 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://{tenantDomain}/api/v2/organizations/{id}/clients",
  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([
    'clients' => [
        [
                'client_id' => '<string>',
                'use_for_member_access' => 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://{tenantDomain}/api/v2/organizations/{id}/clients"

	payload := strings.NewReader("{\n  \"clients\": [\n    {\n      \"client_id\": \"<string>\",\n      \"use_for_member_access\": true\n    }\n  ]\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://{tenantDomain}/api/v2/organizations/{id}/clients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clients\": [\n    {\n      \"client_id\": \"<string>\",\n      \"use_for_member_access\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organizations/{id}/clients")

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  \"clients\": [\n    {\n      \"client_id\": \"<string>\",\n      \"use_for_member_access\": true\n    }\n  ]\n}"

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

201

[
  {
    "client_id": "<string>",
    "use_for_member_access": true,
    "client": {
      "name": "<string>",
      "app_type": "<string>",
      "logo_uri": "<string>"
    }
  }
]

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": "<unknown>",
  "error": "<unknown>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<organization-id> · required

ID of the organization.

Body

application/jsonapplication/x-www-form-urlencoded

clients · object[] · required

List of clients to associate with the organization.

Required array length: 1 - 100 elements

Show child attributes

Response

201

application/json

Organization clients successfully associated.

client_id · string<client-id> · required

The identifier of the client associated with the organization.

use_for_member_access · boolean · required

Whether this client is used for member access to the organization.

client · object

Metadata about the associated client.

Show child attributes